Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agrrh/pagetron
Status page generator based on prometheus metrics
https://github.com/agrrh/pagetron
Last synced: 3 months ago
JSON representation
Status page generator based on prometheus metrics
- Host: GitHub
- URL: https://github.com/agrrh/pagetron
- Owner: agrrh
- Created: 2023-11-26T13:04:10.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-15T08:04:33.000Z (5 months ago)
- Last Synced: 2024-09-16T00:32:49.371Z (5 months ago)
- Language: Svelte
- Size: 554 KB
- Stars: 10
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-status-pages - Pagetron - Status page generator, based on Prometheus, designed to be deployed to Kubernetes clusters (Opensource)
README
# Pagetron
Status page generator, based on Prometheus, designed to be deployed to Kubernetes clusters.
[Demo Page](https://pagetron-demo.agrrh.com/)
## About The Project
Uses well-known technologies
- Kubernetes-ready
- Prometheus under the hood
Built with modularity in mind
- 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
## Getting Started
### Prerequisites
You must have Kubernetes cluster to be up and running to deploy this application in native way.
### Installation
At the moment, installation is as simple as:
```
helm repo add pagetron https://agrrh.github.io/pagetron/
helm install my-status-page pagetron/pagetron \
--upgrade \
--namespace pagetron \
--values values.yaml
```
This will create some resources in your cluster:
- Namespace `"pagetron"`
- Configmaps
- Deployments
- PVC with default StorageClass
- Services
- ...
## Usage
Refer to wiki for [Quickstart](https://github.com/agrrh/pagetron/wiki#quickstart).
## Local Development
Recommended way is to use following tools:
1. [minikube](https://minikube.sigs.k8s.io/docs/) to provide local kubernetes cluster
```shell
minikube start
minikube addons enable ingress
```
2. [skaffold](https://skaffold.dev) to run local code in cluster with efficient feedback loop
```shell
${EDITOR} charts/pagetron/values.dev.yaml
skaffold dev
```
3. Simply visit `publicUrl`.
## Roadmap
- [x] [Prototype Stage](https://github.com/agrrh/pagetron/milestone/1)
- [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).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feat/some-useful-stuff`)
3. Commit your Changes (`git commit -m 'Add some useful stuff'`)
4. Push to the Branch (`git push origin feat/some-useful-stuff`)
5. Open a Pull Request
## License
Distributed under the [WTFPL](https://wikipedia.org/wiki/WTFPL) License. See [LICENSE.md](LICENSE.md) for more information.
## Contacts
Project Link: [https://github.com/agrrh/pagetron](https://github.com/agrrh/pagetron)
## Acknowledgments
Some inspiration from great services:
- [Better Stack](https://betterstack.com)
- [OneUptime](https://oneuptime.com)