Skip to content

Commit

Permalink
♻️ Update readme (cyclops-ui#438)
Browse files Browse the repository at this point in the history
* initial commit

* 🔄 gif

* center gif

* grammar

* 👾 add discord shield

* 👮 grammar

* ♻️ small rephrasing
  • Loading branch information
KaradzaJuraj authored Jul 17, 2024
1 parent fdc0892 commit 62e487c
Showing 1 changed file with 69 additions and 31 deletions.
100 changes: 69 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
[![GitHub Actions CI](https://img.shields.io/github/actions/workflow/status/cyclops-ui/cyclops/ci.yml?style=flat-square&logo=github&logoColor=white&label=cyclops%20build)](https://github.com/cyclops-ui/cyclops/actions/workflows/ci.yml)
[![GitHub Actions web](https://img.shields.io/github/actions/workflow/status/cyclops-ui/cyclops/web.yaml?style=flat-square&logo=github&logoColor=white&label=GitHub%20pages%20build)](https://github.com/cyclops-ui/cyclops/actions/workflows/web.yaml)
[![GitHub License](https://img.shields.io/github/license/cyclops-ui/cyclops?style=flat-square&link=https%3A%2F%2Fgithub.com%2Fcyclops-ui%2Fcyclops%2Fblob%2Fmain%2FLICENSE)](https://github.com/cyclops-ui/cyclops/blob/main/LICENSE)
[![Discord](https://img.shields.io/discord/1103010228884209824?style=flat-square&logo=Discord&logoColor=white&label=Discord&color=%237289da)](https://discord.com/invite/8ErnK3qDb3)

<p align="center">
<a href="https://www.producthunt.com/products/cyclops?utm_source=badge-follow&utm_medium=badge&utm_souce=badge-cyclops" target="_blank">
Expand All @@ -14,64 +15,101 @@
<hr>

<p align="center" width="100%">
<img width="75%" src="./web/static/img/cyclops-simplistic.png">
<img width="75%" src="./web/static/img/cyclops-simplistic.png">
<p/>
<p align="center">Customizable UI for Kubernetes Workloads 👁️</p>
<h3 align="center">Developer Friendly Kubernetes</h3>
<p align="center">
<a href="https://cyclops-ui.com">Webpage</a>
-
<a href="https://discord.com/invite/8ErnK3qDb3">Discord</a>
-
<a href="https://x.com/CyclopsUI">X</a>
-
<a href="https://www.linkedin.com/company/cyclops-ui">LinkedIn</a>
</p>

## 🟠 What is Cyclops?

![which-would-you-prefer.png](web%2Fstatic%2Fimg%2Fwhich-would-you-prefer.png)
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.

<p align= "center">
<img src="https://github.com/user-attachments/assets/4c1e3fff-7106-4afb-9c29-e0aef7d7dd86"/>
</p>

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)
## 💡 How it works?

![Module Overview](./web/static/img/readme-demo.png)
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.

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)
**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!**

[//]: # "## :star2: Supporters"
[//]: # "<p>"
[//]: # ' <a href="https://github.com/cyclops-ui/cyclops/stargazers">'
[//]: # ' <img width="100%" src="https://reporoster.com/stars/cyclops-ui/cyclops" alt="Stargazers repo roster for @cyclops-ui/cyclops">'
[//]: # " </a>"
[//]: # "</p>"
[//]: # "[![Forkers repo roster for @cyclops-ui/cyclops](https://reporoster.com/forks/cyclops-ui/cyclops)]"
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!

## :gear: Install
Read more about it [here](#-templates)

⚠️ Before installing Cyclops, make sure you have all the [prerequisites](https://cyclops-ui.com/docs/installation/prerequisites) ⚠️
## ⚙️ 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:
To install Cyclops using `kubectl` into your cluster, run the commands below:

```bash
kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.8.2/install/cyclops-install.yaml && kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.8.2/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:
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).

## :floppy_disk: Templates
## 💾 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):

Every Cyclops instance comes with a couple of predefined templates, feel free to use and abuse them!
```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

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

<p align="center">
<a href="https://github.com/cyclops-ui/cyclops/graphs/contributors">
<img src="https://contrib.rocks/image?repo=cyclops-ui/cyclops&columns=10" />
</a>
</p>

## :chart_with_upwards_trend: Future work
## 🧭 Roadmap

- RBAC
- support for accessing charts stored on private GitHub repositories
- Git as manifest destination
- Customizable Module details page
> _⚠️ This is not set in stone and may change in the future ⚠️_
Feel free to suggest features you would like to see!
- ~~**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

0 comments on commit 62e487c

Please sign in to comment.