Skip to content

Latest commit

 

History

History
129 lines (78 loc) · 3.41 KB

README.md

File metadata and controls

129 lines (78 loc) · 3.41 KB
Raw

Pagetron

Status page generator, based on Prometheus, designed to be deployed to Kubernetes clusters.

Demo Page

screenshot

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, 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.

(back to top)

Local Development

Recommended way is to use following tools:

  1. minikube to provide local kubernetes cluster

    minikube start
minikube addons enable ingress

  2. skaffold to run local code in cluster with efficient feedback loop

    ${EDITOR} charts/pagetron/values.dev.yaml
skaffold dev

  3. Simply visit publicUrl.

(back to top)

Roadmap

See the open 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 License. See LICENSE.md for more information.

(back to top)

Contacts

Project Link: https://github.com/agrrh/pagetron

(back to top)

Acknowledgments

Some inspiration from great services:

(back to top)