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 (7 months ago)
Default Branch: master
Last Pushed: 2023-12-15T10:26:43.000Z (7 months ago)
Last Synced: 2024-01-08T08:17:48.904Z (6 months ago)
Language: Svelte
Size: 474 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md

Lists

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/)

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

## 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

(back to top)


## 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

- ...

(back to top)


## Usage

Refer to wiki for [Quickstart](wiki#quickstart).

## 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).

(back to top)


## 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

(back to top)


## License

Distributed under the [WTFPL](https://wikipedia.org/wiki/WTFPL) License. See [LICENSE.md](LICENSE.md) for more information.

(back to top)


## Contacts

Project Link: [https://github.com/agrrh/pagetron](https://github.com/agrrh/pagetron)

(back to top)


## Acknowledgments

Some inspiration from great services:

- [Better Stack](https://betterstack.com)

- [OneUptime](https://oneuptime.com)

(back to top)