Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 4.26 KB

README.md

File metadata and controls

71 lines (49 loc) · 4.26 KB
Raw

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

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!

Module Overview

Find out how to install it to your cluster on our landing page and give it a go! (~10 minute tutorial)

⚙️ Install

⚠️ Before installing Cyclops, make sure you have all the prerequisites ⚠️

Cyclops can either be installed manually by applying the latest manifest or with the Glasskube Kubernetes Package Manager.

To install Cyclops using kubectl into your cluster, run commands below:

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:

kubectl port-forward svc/cyclops-ui 3000:3000 -n cyclops

You can now access Cyclops in your browser on http://localhost:3000.

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

📈 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!