Skip to content

Commit df443df

Browse files
authored
🔥 Helm chart install docs (#792)
* add commands to install Cyclops chart * fix new line * fix message * add helm chart to docs (#791)
1 parent ddf3537 commit df443df

File tree

4 files changed

+88
-1
lines changed

4 files changed

+88
-1
lines changed

install/chart/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v2
22
name: cyclops
33
description: Cyclops Helm chart
44
type: application
5-
version: "0.14.4"
5+
version: "0.14.5"
66
appVersion: "v0.18.1"
77
home: https://cyclops-ui.com/
88
keywords:

install/chart/README.md

+29
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,33 @@ Cyclops is an open-source tool that allows you to create custom Kubernetes UIs.
66

77
You can check [Cyclops landing page](https://cyclops-ui.com) or our [GitHub repo](https://github.com/cyclops-ui/cyclops) for documentation and more details.
88

9+
---
10+
11+
You can install the Cyclops Helm chart in your Kubernetes cluster using our OCI chart:
12+
```bash
13+
helm install cyclops \
14+
--namespace cyclops \
15+
--create-namespace \
16+
oci://registry-1.docker.io/cyclopsui/cyclops
17+
```
18+
19+
Or add our Helm chart:
20+
21+
```
22+
helm repo add cyclops-ui https://cyclops-ui.com/helm
23+
helm repo update
24+
```
25+
26+
And install Cyclops:
27+
28+
```
29+
helm install cyclops \
30+
--namespace cyclops \
31+
--create-namespace \
32+
cyclops-ui/cyclops
33+
```
34+
---
35+
936
You can confirm Cyclops is healthy by checking if Cyclops pods are up and running. You can do it with the command below
1037

1138
```
@@ -20,6 +47,8 @@ cyclops-ctrl-8b9cff4db-p74x6 1/1 Running 0 38s
2047
cyclops-ui-6cb54c69bf-g78d5 1/1 Running 0 38s
2148
```
2249

50+
---
51+
2352
Cyclops UI is exposed via a Kubernetes service. You can port forward the service and use it from localhost with the command below:
2453

2554
```

web/docs/installation/install/helm.md

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
slug: helm
3+
sidebar_label: Using Helm chart
4+
title: Install Cyclops via Helm chart
5+
description: "Cyclops Helm chart"
6+
---
7+
8+
You can install the Cyclops Helm chart in your Kubernetes cluster using our OCI chart:
9+
```bash
10+
helm install cyclops \
11+
--namespace cyclops \
12+
--create-namespace \
13+
oci://registry-1.docker.io/cyclopsui/cyclops
14+
```
15+
16+
Or add our Helm chart:
17+
18+
```
19+
helm repo add cyclops-ui https://cyclops-ui.com/helm
20+
helm repo update
21+
```
22+
23+
And install Cyclops:
24+
25+
```
26+
helm install cyclops \
27+
--namespace cyclops \
28+
--create-namespace \
29+
cyclops-ui/cyclops
30+
```
31+
---
32+
33+
You can confirm Cyclops is healthy by checking if Cyclops pods are up and running. You can do it with the command below
34+
35+
```
36+
kubectl get pods -n cyclops
37+
```
38+
39+
and if Cyclops is healthy, you will get an output similar to the one below:
40+
41+
```
42+
NAME READY STATUS RESTARTS AGE
43+
cyclops-ctrl-8b9cff4db-p74x6 1/1 Running 0 38s
44+
cyclops-ui-6cb54c69bf-g78d5 1/1 Running 0 38s
45+
```
46+
47+
---
48+
49+
Cyclops UI is exposed via a Kubernetes service. You can port forward the service and use it from localhost with the command below:
50+
51+
```
52+
kubectl port-forward svc/cyclops-ui -n cyclops 3000:3000
53+
```
54+
55+
You can now access Cyclops in your browser on [http://localhost:3000](http://localhost:3000).
56+
57+
Alternatively, you can expose Cyclops service via ingress.

web/sidebars.js

+1
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,7 @@ const sidebars = {
5151
},
5252
items: [
5353
"installation/install/manifest",
54+
"installation/install/helm",
5455
"installation/install/glasskube",
5556
"installation/install/cyctl",
5657
],

0 commit comments

Comments
 (0)