Skip to content

Commit

Permalink
docs: update (#39)
Browse files Browse the repository at this point in the history
* chore: remove old manifests

* docs: update
  • Loading branch information
agrrh authored Dec 14, 2023
1 parent 7fb78b3 commit 8588b5c
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 331 deletions.
94 changes: 18 additions & 76 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,47 @@
# Pagetron

Free status page generator you always wanted!
Status page generator, based on Prometheus, designed to be deployed to Kubernetes clusters.

[Demo Page](https://pagetron-demo.agrrh.com/)

![screenshot](./docs/images/screenshot.png)

## About The Project

Uses well-known technologies

- Prometheus under the hood
- Kubernetes-ready
- Prometheus under the hood

Built with modular architecture in mind
Built with modularity in mind

- Easy to build e.g. your own UI
- Use external metrics sources
- Build your own UI

Free to use and extend

- Released under [WTFPL](https://ru.wikipedia.org/wiki/WTFPL), one of most permissive licenses

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Built With

Platform

- [Docker](https://www.docker.com/)
- [Kubernetes](https://kubernetes.io/)

Frontend

- [Svelte](https://svelte.dev)

Backend

- [FastAPI](https://fastapi.tiangolo.com/)

Storage

- [Prometheus](https://prometheus.io)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

## Getting Started

### Prerequisites

You must have Kubernetes cluster to be up and running to deploy this application in native way.

You also may run it with Docker and possibly Docker Compose, after translating k8s manifests to docker or docker-compose scenario.

See [./deploy](./deploy) folder.

### Installation

⚠️ Development stage.

At the moment, installation is as simple as:

```
kubectl apply -R -f ./deploy
git clone https://github.com/agrrh/pagetron.git
helm install pagetron \
pagetron/deploy/helm/pagetron \
--upgrade \
--namespace pagetron \
--values values.yaml
```

This will create some resources in your cluster:
Expand All @@ -73,54 +57,12 @@ This will create some resources in your cluster:

## Usage

⚠️ Development stage.

### Setting up monitoring

To monitor your stuff, you must target metrics collector (currently, `blackbox` exporter) to desired resources in `deploy/prometheus/prometheus.configmap.yaml`:

```
- targets:
- https://example.org
- https://api.example.org
```

### Backend

First, expose metrics on your local environment:

```
kubectl port-forward -n pagetron svc/prometheus 9090:9090
```

Then run backend API:

```
cd backend
docker build . -t local/pagetron:backend
docker run --rm -ti --network host local/pagetron:backend
```

### Frontend

Just run frontend:

```
npm i
npm run dev
```

Then you may visit UI:

http://localhost:5173/

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Refer to wiki for [Quickstart](wiki#quickstart).

## Roadmap

- [x] [Prototype Stage](https://github.com/agrrh/pagetron/milestone/1)
- [ ] [Core Features](https://github.com/agrrh/pagetron/milestone/2)
- [x] [Core Features](https://github.com/agrrh/pagetron/milestone/2)
- [ ] [Nice To Have](https://github.com/agrrh/pagetron/milestone/3)

See the [open issues](https://github.com/agrrh/pagetron/issues) for a full list of proposed features (and known issues).
Expand Down
7 changes: 0 additions & 7 deletions deploy/yaml/namespace.yaml

This file was deleted.

32 changes: 0 additions & 32 deletions deploy/yaml/prometheus/blackbox.deployment.yaml

This file was deleted.

20 changes: 0 additions & 20 deletions deploy/yaml/prometheus/blackbox.service.yaml

This file was deleted.

28 changes: 0 additions & 28 deletions deploy/yaml/prometheus/housekeeper.cronjob.yaml

This file was deleted.

79 changes: 0 additions & 79 deletions deploy/yaml/prometheus/prometheus.configmap.yaml

This file was deleted.

53 changes: 0 additions & 53 deletions deploy/yaml/prometheus/prometheus.deployment.yaml

This file was deleted.

16 changes: 0 additions & 16 deletions deploy/yaml/prometheus/prometheus.pvc.yaml

This file was deleted.

20 changes: 0 additions & 20 deletions deploy/yaml/prometheus/prometheus.service.yaml

This file was deleted.

Binary file added docs/images/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8588b5c

Please sign in to comment.