Skip to content

Commit 2cf424d

Browse files
committed
misc(docs): Removing Helm/minikube related content from the README
1 parent 43afead commit 2cf424d

File tree

2 files changed

+4
-22
lines changed

2 files changed

+4
-22
lines changed

README.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,6 @@ And it allows you to <b>make fast, safe development changes</b>.
5454
| [Python](https://www.python.org/downloads/) <br/>- Most Linux and macOS systems have Python pre-installed. <br/>- On Windows machines, you will need to download and install it. | 3.9, 3.10, 3.11, 3.12 | `python3 --version` |
5555
| [Docker](https://docs.docker.com/get-docker/) <br/>[Docker Compose](https://docs.docker.com/compose/install/) | 26.1, 27.5, 28.1 <br/> 2.34, 2.35, 2.36 | `docker -v` <br/> `docker compose version` |
5656

57-
#### Additional Requirements for Observability only
58-
59-
| Software | Tested Versions | Command to check version |
60-
|-------------------------|-------------------------|-------------------------------|
61-
| [Minikube](https://minikube.sigs.k8s.io/docs/start/) | 1.33, 1.34, 1.35 | `minikube version` |
62-
| [Helm](https://helm.sh/docs/intro/install/) | 3.15, 3.16, 3.17 | `helm version` |
6357

6458
### Download the installer
6559

@@ -96,17 +90,11 @@ Once the installation completes, verify that you can login to the UI with the UR
9690

9791
### Install the Observability application
9892

99-
The installation downloads the latest Helm charts and Docker images for Observability and deploys the application on a new minikube cluster. The process may take 5~30 minutes depending on your machine and network connection.
93+
The installation downloads the latest Docker images for Observability and deploys the application using Docker. The process may take 5~15 minutes depending on your machine and network connection.
10094
```shell
10195
python3 dk-installer.py obs install
10296
```
103-
#### Bind HTTP ports to host machine
10497

105-
This step is required to access the application when using Docker driver on Mac or Windows. It may also be useful for installations on remote machines to access the UI from a local browser.
106-
107-
```shell
108-
python3 dk-installer.py obs expose
109-
```
11098
The `--port` option may be used to set a custom localhost port for the application (default: 8082).
11199

112100
Verify that you can login to the UI with the URL and credentials provided in the output. Leave this process running, and continue the next steps on another terminal window.
@@ -162,15 +150,9 @@ Upgrade the app to latest version: `python3 dk-installer.py tg upgrade`
162150

163151
### DataOps Observability
164152

165-
The [minikube](https://minikube.sigs.k8s.io/docs/commands/) and [kubectl](https://kubernetes.io/docs/reference/kubectl/) command line tools can be used to operate the Observability application.
166-
167-
Inspect the pods: `kubectl get pods`
168-
169-
Get pod logs: `kubectl logs <POD ID>`
170-
171-
Stop the app: `minikube stop`
153+
Stop the app: `docker compose -f obs-docker-compose.yml obs down`
172154

173-
Restart the app: `minikube start`
155+
Restart the app: `docker compose -f obs-docker-compose.yml up`
174156

175157
## Remove Demo Data
176158

dk-installer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1555,7 +1555,7 @@ class ObsInstallAction(AnalyticsMultiStepAction, ComposeActionMixin):
15551555

15561556
label = "Installation"
15571557
title = "Install Observability"
1558-
intro_text = ["This process may take 5~30 minutes depending on your system resources and network speed."]
1558+
intro_text = ["This process may take 5~15 minutes depending on your system resources and network speed."]
15591559

15601560
args_cmd = "install"
15611561
requirements = [REQ_DOCKER, REQ_DOCKER_DAEMON]

0 commit comments

Comments
 (0)