Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyclops-ui/cyclops
Developer Friendly Kubernetes 👁️
https://github.com/cyclops-ui/cyclops
aks cloud crd-controller deployment devops eks gke go golang hacktoberfest helm json-schema kubernetes kubernetes-cluster kubernetes-controller kubernetes-operator platform-engineering react typescript typescript-react
Last synced: 4 days ago
JSON representation
Developer Friendly Kubernetes 👁️
- Host: GitHub
- URL: https://github.com/cyclops-ui/cyclops
- Owner: cyclops-ui
- License: apache-2.0
- Created: 2023-04-02T00:09:04.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T17:23:52.000Z (11 days ago)
- Last Synced: 2025-01-14T18:56:09.861Z (11 days ago)
- Topics: aks, cloud, crd-controller, deployment, devops, eks, gke, go, golang, hacktoberfest, helm, json-schema, kubernetes, kubernetes-cluster, kubernetes-controller, kubernetes-operator, platform-engineering, react, typescript, typescript-react
- Language: Go
- Homepage: https://cyclops-ui.com
- Size: 113 MB
- Stars: 2,712
- Watchers: 14
- Forks: 776
- Open Issues: 48
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-k8s-resources - Cyclops - Customizable UI for Kubernetes deployments (Tools and Libraries / Development Tools)
README
[](https://landscape.cncf.io/?item=app-definition-and-development--application-definition-image-build--cyclops)
[](https://hub.docker.com/repository/docker/cyclopsui/cyclops-ctrl/general)
[](https://goreportcard.com/report/github.com/cyclops-ui/cyclops/cyclops-ctrl)
[](https://github.com/cyclops-ui/cyclops/actions/workflows/ci.yml)
[](https://github.com/cyclops-ui/cyclops/actions/workflows/web.yaml)
[](https://github.com/cyclops-ui/cyclops/blob/main/LICENSE)
[](https://discord.com/invite/8ErnK3qDb3)
Developer Friendly Kubernetes
Webpage
-
Discord
-
X
-
LinkedIn
## 🟠 What is Cyclops?
Cyclops is an open-source dev tool that simplifies Kubernetes with an easy-to-use UI, making it less intimidating. Instead of creating and configuring your Kubernetes manifests with YAML, use Cyclops to painlessly configure and deploy your applications - validations included!
Thanks to the templates system, Cyclops's UI is highly customizable when defining configurations. Our templates turn hours and days of configuring applications into a few clicks.
## 💡 How it works?
Cyclops is a platform that allows DevOps teams to quickly and without coding create custom UIs for developers, QA teams, product managers, and other team members who do not necessarily have experience working with Kubernetes.
**But don’t worry! If you do not have a DevOps team with you, Cyclops comes with a bunch of predefined templates to get you started!**
Under the hood, Cyclops uses Helm charts to create your desired UIs. This means you can try Cyclops with any of your existing Helm charts or any public Helm charts you can find!
Read more about it [here](#-templates)
## ⚙️ 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, by using [cyctl](#cyctl), or with the [Glasskube Kubernetes Package Manager](https://github.com/glasskube/glasskube/).
To install Cyclops using `kubectl` into your cluster, run the commands below:
```bash
kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.15.4/install/cyclops-install.yaml && kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.15.4/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 the 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).
## 💾 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 to create your own templates. More information on making your own can be found on our [web](https://cyclops-ui.com/docs/templates/).
## 🚧 `cyctl`
The Cyclops command line interface! You can install it with [Homebrew](https://formulae.brew.sh/formula/cyctl#default):
```bash
brew install cyctl
```
**What are you able to do with `cyctl`?**
Besides the basic commands like getting all modules or templates, you can integrate it with GitHub actions to automate some of the Cyclops processes.
For example, once you create a template and publish it on GitHub, GitHub actions could automatically connect the template to your Cyclops instance using our CLI. This would **allow your developers instant access to each new template or any update the template receives**.
## 💪 Contributing
Cyclops is **open-source** and open to external contributors. There are plenty of ways you can contribute to the Cyclops project - with code, feedback, content and GitHub stars⭐
Start your contributing journey at our [CONTRIBUTING.md](./CONTRIBUTING.md) and join our wall of fame 👐
## 🧭 Roadmap
> _⚠️ This is not set in stone and may change in the future ⚠️_
- ~~**Support for private GitHub repos** -> access templates saved on your private repositories~~ ✅
- **Authentification** -> secure login
- **Role-based access control** -> limit the resources your devs have access to
- **GitOps** -> integrate with GitOps tools
- **Support for Kustomize** -> currently, only Helm is supported for creating templates
- **`cyctl` for Windows** -> Chocolatey
- **Customizable Module details page** -> create custom views of resources that your module uses
## 👁️ Share your feedback
**Are you using Cyclops at your company?** We'd love to hear directly from you about how you're using (or planning to use) Cyclops! Chat with us for **30 minutes** about your use case and we'll send you a **50$ Amazon Gift Card** as a thank-you for your time. Please fill in this [form](https://forms.gle/Phu3R1i2gTBM1iAm8), and we will get in touch with you!
Your input will directly influence the direction of Cyclops, and we appreciate every bit of feedback. Thank you for helping us build something great! 🧡