Skip to content

Commit

Permalink
update README with installation
Browse files Browse the repository at this point in the history
  • Loading branch information
Petar Cvitanović committed Aug 22, 2023
1 parent 4ddd2fb commit e6eed21
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 1 deletion.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,33 @@ the window for deployment mistakes. [Find out more!](https://cyclops-ui.com)
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)

# Install

⚠️ Before installing Cyclops, make sure you have all the [prerequisites](./prerequisites) ⚠️

To install Cyclops in your cluster, run commands below:

```bash
kubectl apply -f https://raw.githubusercontent.com/cyclops-ui/cyclops/v0.0.1-alpha.3/install/cyclops-install.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. You will still need to expose both backend and
frontend with the commands below. Expose frontend through:

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

and backend through:

```bash
kubectl port-forward svc/cyclops-ctrl 8080:8080 -n cyclops
```

You can now access Cyclops in your browser on [http://localhost:3000](http://localhost:3000).

# Future work

* Better error handling
Expand Down
2 changes: 1 addition & 1 deletion web/docs/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ and backend through:
kubectl port-forward svc/cyclops-ctrl 8080:8080 -n cyclops
```

You can now try to access Cyclops in your browser on [http://localhost:3000](http://localhost:3000).
You can now access Cyclops in your browser on [http://localhost:3000](http://localhost:3000).

0 comments on commit e6eed21

Please sign in to comment.