Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
rchakode committed Sep 10, 2023
1 parent 055006d commit 77b0614
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,31 @@ Key features:

![](./images/banners/screenshots.png)

# Getting Started

# Quick start on Kubernetes
The following sequence installs RealOpInsight in the namespace `monitoring`. The namespace is created if not yet the case.


```bash
git clone --depth 1 https://github.com/rchakode/realopinsight.git && \
kubectl -n monitoring apply -k ./realopinsight/manifests/kustomize
```

Check the web interface

```shell
kubectl port-forward --namespace monitoring service/realopinsight-ui 4583:80

# Then open http://localhost:4583 in your browser.
```

Available _in-cluster_ service endpoints (can be exposed to the external world via an Ingress Controller):

* Web UI: http://realopinsight.monitoring/ui.
* Prometheus metrics: http://realopinsight.monitoring:4583/metrics.


# Documentation
* [Deployment on Kubernetes](./docs/deployment-on-kubernetes.md)
* [Deployment on Docker](./docs/deployment-on-docker.md)
* [Integration with Kubernetes](https://realopinsight.com/docs/quickstart-kubernetes-dashboard/)
Expand Down

0 comments on commit 77b0614

Please sign in to comment.