cyclops-ui / cyclops

customizable UI for Kubernetes workloads 👁️
https://cyclops-ui.com
Apache License 2.0
582 stars 60 forks source link
aks cloud crd-controller deployment devops eks gke helm json-schema kubernetes kubernetes-cluster kubernetes-controller kubernetes-operator platform-engineering

CNCF Badge Docker Pulls Go Report Card GitHub Actions CI GitHub Actions web GitHub License


Customizable UI for Kubernetes Workloads 👁️

![which-would-you-prefer.png](web%2Fstatic%2Fimg%2Fwhich-would-you-prefer.png) Welcome to Cyclops, a powerful user interface for managing and interacting with Kubernetes clusters. Cyclops is designed to simplify the management of containerized applications on Kubernetes, providing an intuitive and user-friendly experience for developers, system administrators, and DevOps professionals. Divide the responsibility between your infrastructure and your developer teams so everyone can play to their strengths. Automate your processes and shrink the window for deployment mistakes. [Find out more!](https://cyclops-ui.com) ![Module Overview](./web/static/img/readme-demo.png) Find out how to [install](https://cyclops-ui.com/docs/installation/prerequisites) it to your cluster on our landing page and give it a go! (~10 minute tutorial) [//]: # "## :star2: Supporters" [//]: # "

" [//]: # ' ' [//]: # ' Stargazers repo roster for @cyclops-ui/cyclops' [//]: # " " [//]: # "

" [//]: # "[![Forkers repo roster for @cyclops-ui/cyclops](https://reporoster.com/forks/cyclops-ui/cyclops)]" ## :gear: Install ⚠️ Before installing Cyclops, make sure you have all the [prerequisites](https://cyclops-ui.com/docs/installation/prerequisites) ⚠️ Cyclops can either be installed manually by applying the latest manifest or with the [Glasskube Kubernetes Package Manager](https://github.com/glasskube/glasskube/). To install Cyclops using `kubectl` into your cluster, run commands below: ```bash kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.7.1/install/cyclops-install.yaml && kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.7.1/install/demo-templates.yaml ``` It will create a new namespace called `cyclops` and deploy everything you need for your Cyclops instance to run. Now all that is left is to expose Cyclops server outside the cluster: ```bash kubectl port-forward svc/cyclops-ui 3000:3000 -n cyclops ``` You can now access Cyclops in your browser on [http://localhost:3000](http://localhost:3000). ## :floppy_disk: Templates Every Cyclops instance comes with a couple of predefined templates, feel free to use and abuse them! Helm charts used for these templates can be found [here](https://github.com/cyclops-ui/templates). You can use this repo as a guide if you want to create your own templates. More information on creating your own can be found on our [web](https://cyclops-ui.com/docs/templates/). ## :chart_with_upwards_trend: Future work - RBAC - support for accessing charts stored on private GitHub repositories - Git as manifest destination - Customizable Module details page Feel free to suggest features you would like to see!