# cyclops

Generated on 21 Mar 2025 from [the cyclops catalog page](https://marketplace.digitalocean.com/apps/cyclops)

Cyclops is an open-source tool that allows you to create **custom Kubernetes UIs**. With Cyclops, you can specify the right level of abstraction you need while deploying applications. You can **specify** all the **Kubernetes objects** that your system needs, as well as all of the **fields your developers need** to get their apps deployed - validations included!

![](https://github.com/user-attachments/assets/4c1e3fff-7106-4afb-9c29-e0aef7d7dd86)

## Software Included

*This Marketplace listing does not include a detailed software list.*

## Creating an App using the Control Panel

Click the **Deploy to DigitalOcean** button to install a Kubernetes 1-Click Application. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.

[![Deploy to DO](https://www.deploytodo.com/do-btn-blue.svg)](https://cloud.digitalocean.com/kubernetes/clusters/new?addonslug=cyclops&nodePools=s-1vcpu-2gb%3A3)

## Creating an App using the API

In addition to creating cyclops using the control panel, you can also use the [DigitalOcean API](https://docs.digitalocean.com/reference/api). As an example, to create a 3 node DigitalOcean Kubernetes cluster made up of Basic Droplets in the SFO2 region, you can use the following `doctl` command. You need to authenticate with `doctl` with your [API access token](https://docs.digitalocean.com/reference/api/create-personal-access-token/index.html.md) and replace the `$CLUSTER_NAME` variable with the chosen name for your cluster in the command below.

```shell
doctl kubernetes clusters create --size s-4vcpu-8gb $CLUSTER_NAME --1-clicks cyclops
```

## Getting Started After Deploying cyclops

First, check if the Helm installation was successful by running the command below:

```
helm ls -n cyclops
```

The output looks similar to the following:

```
NAME       NAMESPACE   REVISION    UPDATED                                 STATUS      CHART            APP VERSION
cyclops    cyclops     1           2025-01-11 19:51:16.548418 +0100 CET    deployed    cyclops-0.13.0   v0.15.4
```

You can confirm Cyclops is healthy by checking if Cyclops pods are up and running. You can do it with the command below

```
kubectl get pods -n cyclops
```

and if Cyclops is healthy, you will get an output similar to the one below:

```
NAME                           READY   STATUS    RESTARTS   AGE
cyclops-ctrl-8b9cff4db-p74x6   1/1     Running   0          38s
cyclops-ui-6cb54c69bf-g78d5    1/1     Running   0          38s
```

Cyclops UI is exposed via a Kubernetes service. You can port forward the service and use it from localhost with the command below:

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

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

Alternatively, you can expose Cyclops service via ingress.