Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for v0.3.0 #204

Merged
merged 26 commits into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
ad03845
update new-module page
KaradzaJuraj Apr 8, 2024
50933ee
update demo/module page
KaradzaJuraj Apr 8, 2024
4dcf526
update demo/edit-module page
KaradzaJuraj Apr 8, 2024
2499040
update demo/feedback page
KaradzaJuraj Apr 8, 2024
7c0d0bf
delete unused images in /demo
KaradzaJuraj Apr 8, 2024
a4cb164
update email formatter on metrics page
KaradzaJuraj Apr 8, 2024
24c0240
update templates/validations
KaradzaJuraj Apr 8, 2024
985409b
remove demo/logs
KaradzaJuraj Apr 8, 2024
62a8c31
update templats/overview
KaradzaJuraj Apr 8, 2024
93729d5
update templats/overview
KaradzaJuraj Apr 8, 2024
a8f05d5
add templates/adding_templates
KaradzaJuraj Apr 8, 2024
fee056d
README update install cmd
KaradzaJuraj Apr 8, 2024
f53bf78
README update future work
KaradzaJuraj Apr 8, 2024
d9fdf08
update CONTRIBUTING.md
KaradzaJuraj Apr 8, 2024
c20d8b2
README add ref to templates repo
KaradzaJuraj Apr 8, 2024
ba0f7a0
update README cyclops showcase
KaradzaJuraj Apr 8, 2024
e96848b
update logo in README
KaradzaJuraj Apr 8, 2024
71f7acb
shrink logo
KaradzaJuraj Apr 8, 2024
b7da2c7
remove unused code
KaradzaJuraj Apr 8, 2024
3836d38
rename logo png
KaradzaJuraj Apr 9, 2024
9c9cfe8
Update logo in README
KaradzaJuraj Apr 9, 2024
cc46a19
update templates/dependencies page
KaradzaJuraj Apr 9, 2024
137158a
add templates/add-templates page
KaradzaJuraj Apr 9, 2024
377b9ac
update templates/templated_storage page
KaradzaJuraj Apr 9, 2024
6be0616
fix sidebar
KaradzaJuraj Apr 10, 2024
fc16096
✂️ crop images and add new CRD to install
KaradzaJuraj Apr 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,13 +84,13 @@ UI depends on the controller API. Again, you can run inside the cluster as well
in `cyclops-ui`. After that, you will need to install all the dependencies using

```zsh
npm i -f
yarn install
```

Once dependencies are installed, you can run the UI

```zsh
npm start
yarn start
```

> 📌 **_NOTE_** 📌
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<p align="center" width="100%">
<img width="40%" src="https://github.com/cyclops-ui/cyclops/assets/72022639/53009fdd-ff0a-45c8-a04e-cda495e8b34e">
<img width="60%" src="./web/static/img/cyclops-simplistic.png">
<p/>
<h1 align="center">Cyclops</h1>
<p align="center">customizable UI for Kubernetes workloads 👁️</p>
<h1></h1>
<p align="center">Customizable UI for Kubernetes Workloads 👁️</p>

<div align="center">
<a href="https://github.com/cyclops-ui/cyclops/blob/main/LICENSE"><img height="20" src="https://img.shields.io/github/license/cyclops-ui/cyclops"></a>
Expand All @@ -19,7 +19,7 @@ experience for developers, system administrators, and DevOps professionals. Divi
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)

![Screenshot 2022-04-06 at 20 26 17](https://user-images.githubusercontent.com/72022639/162033638-845b5f2c-f1df-4e17-b2fc-ba4ab318f887.png)
![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)
Expand All @@ -41,7 +41,7 @@ Cyclops can either be installed manually by applying the latest manifest or with
To install Cyclops using `kubectl` into your cluster, run commands below:

```bash
kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.2.0/install/cyclops-install.yaml
kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.3.0/install/cyclops-install.yaml
```

It will create a new namespace called `cyclops` and deploy everything you need for your Cyclops instance to run.
Expand All @@ -54,10 +54,16 @@ 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
- Cluster nodes overview
- support for accessing charts stored on private GitHub repositories
- Git as manifest destination
- Customizable Module details page

Expand Down
22 changes: 11 additions & 11 deletions web/docs/installation/demo/edit_module.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,25 @@ Let's edit the values of our module and see what happens! The first step is to c
## Replicas || Version

Try changing the number of replicas or the version of the image (`1.14.2` -> `1.14.1`) to see how the pods are changing.
![Pods Version Change](../../../static/img/demo/pods_version_change.png?raw=true "Pods Version Change")

We can see in the image above that we have some pods that are running on the version `1.14.2` that are waiting to be
replaced by the pods that are of version `1.14.1`. In the end there will be only the `1.14.1` pods up and running.
![Pods Version Change](../../../static/img/demo/edit-module/deployment-version-change.png)

## Service toggled off
In the image above, we can see that we have some pods running on version `1.14.2` that are waiting to be replaced by pods of version `1.14.1`. In the end, only the `1.14.1` pods will be up and running.

When toggling off the service of a module, the service won't be automatically deleted. Instead, there will be a warning
sign that indicates that the template no longer supports the service and you can delete it manually if necessary.
![Service Toggled Off](../../../static/img/demo/service_toggled_off.png?raw=true "Service Toggled Off")
## Service Toggled Off

Now you can delete the service by clicking the _Delete_ button.
When toggling off a module's service, the service won't be automatically deleted. Instead, there will be a warning sign that indicates that the template no longer supports the service, and you can delete it manually if necessary.

## Potential problems
![Service Toggled Off](../../../static/img/demo/edit-module/service-off.png)

Now, you can delete the service by clicking the _Delete_ button.

## Potential Problems

### Naming

If Cyclops seemingly freezes when trying to save the module, it probably means you didn't follow [the Kubernetes naming
convention](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/).
If an error pops up referencing [the Kubernetes naming
convention](https://kubernetes.io/docs/concepts/overview/working-with-objects/names/), try conforming to the following rules:

1. [x] contain no more than 63 characters
2. [x] contain only **lowercase** alphanumeric characters or '-'
Expand Down
10 changes: 3 additions & 7 deletions web/docs/installation/demo/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,14 @@ Please take a few minutes to fill out the [Feedback Form](https://forms.gle/jrwc

## Installation Tutorial

If you encountered any issues during the installation process, please let us know. Your feedback will help us address any potential challenges that users may face.

[Installation Tutorial](../install)
If you encountered any issues during the [installation process](../install)), please let us know. Your feedback will help us address any potential challenges that users may face.

## Demo Tutorial

We hope the demo tutorial provided a clear understanding of how to use our product. If you have any suggestions for improvement or if there's anything you'd like to see in future tutorials, please share your thoughts.

[Demo Tutorial](./new_module)
We hope the [demo tutorial](./new_module) clearly explains how to use our product. If you have any suggestions for improvement or anything you'd like to see in future tutorials, please share your thoughts.

### Thank you for your feedback!

We appreciate your time and effort in providing feedback. If you have any additional comments or questions, feel free to reach out to us directly at [info@cyclops-ui.com](mailto:info@cyclops-ui.com).
We appreciate your time and effort in providing feedback. If you have any additional comments or questions, don't hesitate to contact us directly at [info@cyclops-ui.com](mailto:info@cyclops-ui.com).

Happy deploying!
65 changes: 0 additions & 65 deletions web/docs/installation/demo/logs.md

This file was deleted.

53 changes: 26 additions & 27 deletions web/docs/installation/demo/module.md
Original file line number Diff line number Diff line change
@@ -1,59 +1,58 @@
# The Module Screen

After you have created your first module, now it is the time to take a look at the Cyclops dashboard. The first thing we
can see in our top left corner is the name of our module (`demo`), the namespace (`cyclops`) where the module inhabits in the
cluster and the link that points towards the GitHub repository where the template is located.
After you have created your first module, it is time to take a look at the Cyclops dashboard. The first thing we can see in the top left corner is the name of our module (`demo`), the namespace (`cyclops`) where the module inhabits in the cluster and the link that points towards the GitHub repository where the template is located.

![Module Overview](../../../static/img/demo/module/module-details.png)

## Actions

Here we have listed the actions that are available to us for the current module.
Here, we have listed the actions available for the current module.

### Edit

The _Edit_ button takes you to a new screen where you can edit the data we provided when creating the module. Let's
leave it at that for now, we will go more in depth in the next [chapter](edit_module).
The _Edit_ button takes you to a new screen where you can edit the data we provided when creating the module. Let's leave it at that for now, and we will go more in-depth in the next [chapter](edit_module).

### Rollback

The _Rollback_ button lets you see the history of changes that you made to your module. Since we haven't made any changes, this screen should be empty.

However, every time you edit your module, you can find the trail of changes here. _Manifest_ will show you how the previous version looked, and _Rollback_ will show the difference between the current version and the version you want to roll back to. By clicking _OK_, your module will be reverted to the previous state.

![Rollback feature](../../../static/img/demo/module/rollback.png)

### Delete

The _Delete_ button lets you delete the current module. When clicked a popup window will appear that requires you to
write the module name in it. If correctly written the _delete_ button will turn red and can be clicked.
![Delete Module](../../../static/img/demo/delete_module.png?raw=true "Delete Module")
The _Delete_ button lets you delete the current module. When clicked, a popup window will appear, showing all the resources you are about to delete. If you wish to proceed with deleting your module, you are required to write the module name in the box. If correctly written, the _delete_ button will turn red and can be clicked.

![Delete Module](../../../static/img/demo/module/delete.png)

This action deletes the module and all its associated resources from the cluster!

## Resources

The modules resources are displayed here. These resources include _Deployments_ and/or _Services_ (other resources are
still in development!). The _Services_ tab is only visible when it is toggled in the configuration.
The module's resources are displayed here. These resources include _Deployments_ and/or _Services_ (other resources are still in development!). The _Services_ tab is only visible when toggled in the configuration.

![Service Toggle On](../../../static/img/demo/service_toggle.png?raw=true "Service Toggle On")
![Service Toggle](../../../static/img/demo/module/service-toggle.png)

### Deployment

Here are your deployments. Depending on the number of replicas you wanted, there should be an equal amount of pods.
![Deployments](../../../static/img/demo/deployments.png?raw=true "Deployments")

![Deployment](../../../static/img/demo/module/deployment-resource.png)

[//]: # 'TO-DO: remove "...in the current version of Cyclops..."'

The top most element we can see is the name of the deployment, which in our case is `demo-1`. Right under we can see
the namespace in which our deployment is located. In the current version of Cyclops, all of your deployments and
services are put in the `default` namespace. Right under the namespace stands a button _View Manifest_. This button
creates a popup that allows you to see the configuration file that Cyclops created after you filled in the values for
the template.
The topmost element we can see is the deployment's name, which in our case is `demo-1`. Right under, we can see the namespace where our deployment is located. In the current version of Cyclops, all of your deployments and services are put in the `default` namespace. Right under the namespace stands a button _View Manifest_. This button creates a popup that allows you to see the configuration file Cyclops created after you filled in the values for the template.

The Pods are displayed one under another. You can see their name, node, phase, lifetime, image and logs. _View Logs_ is
another popup window that displays the last 100 logs of the pod. If you are still interested in the logs feature, learn more about it in the
[Logs tutorial](logs). For now let's provide a short explanation for of the columns in the Deployment section:
The Pods are displayed one under another. You can see their name, node, phase, lifetime, image and logs. _View Logs_ is another popup window that displays the last 100 logs of the pod. If you are still interested in the logs feature, learn more about it in the [Logs tutorial](logs). For now, let's provide a short explanation for of the columns in the Deployment section:

1. `Name` shows the full name of the pod
2. `Node` shows the node in which the pod is running
3. `Phase` shows the phase in which the pod currently is. This can be _Running_, if it's up, or _Pending_, if it's trying to start up
3. `Phase` shows the pod's current phase. This can be _Running_, if it's up or _Pending_, if it's trying to start up
4. `Started` shows how long is the pod already running for
5. `Images` shows which Docker images is the pod using
6. `Logs` shows the last 100 logs for each of the pods containers
5. `Images` shows which Docker images the pod is using
6. `Logs` shows the last 100 logs for each of the pod's containers

### Service

Here is your service. In Kubernetes, a Service is a method for exposing a network application that is running as one or
more Pods in your cluster. Here we can also see the name of our service `demo-1`, the namespace it inhabits `default` and
the manifest. Underneath it shows the port of the service and where it is pointing (port of the pods).
Here is your service. In Kubernetes, a Service exposes a network application running as one or more Pods in your cluster. Here, we can also see the name of our service, `demo-1`, the namespace it inhabits, `default`, and the manifest. Underneath it, it shows the service's port and where it is pointing (the port of the pods).
Loading