Skip to content

Commit

Permalink
[Docs] Improve K8s installation guide (#1865)
Browse files Browse the repository at this point in the history
  • Loading branch information
george0st committed Apr 5, 2022
1 parent 241db77 commit cda95ab
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions docs/install-kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,20 +90,26 @@ Where:
- `<your-password>` is your Docker password.
- `<your-email>` is your Docker email.

```{admonition} Note
First-time MLRun users will experience a relatively longer installation time because all required images
are being pulled locally for the first time (it will take an average of 10-15 minutes mostly depends on
your internet speed).
```

To install the chart with the release name `mlrun-kit` use the following command.
Note the reference to the pre-created `registry-credentials` secret in `global.registry.secretName`:

```bash
helm --namespace mlrun \
install mlrun-kit \
--wait \
--timeout 960 \
--set global.registry.url=<registry-url> \
--set global.registry.secretName=registry-credentials \
v3io-stable/mlrun-kit
```

Where `<registry-url` is the registry URL which can be authenticated by the `registry-credentials` secret (e.g., `index.docker.io/<your-username>` for Docker Hub>).

Where `<registry-url>` is the registry URL which can be authenticated by the `registry-credentials` secret (e.g., `index.docker.io/<your-username>` for Docker Hub).

```{admonition} Installing on Minikube/VM**
The Open source MLRun kit uses node ports for simplicity. If your Kubernetes cluster is running inside a VM,
Expand All @@ -117,6 +123,7 @@ command as follows:
helm --namespace mlrun \
install my-mlrun \
--wait \
--timeout 960 \
--set global.registry.url=<registry URL e.g. index.docker.io/iguazio > \
--set global.registry.secretName=registry-credentials \
--set global.externalHostAddress=$(minikube ip) \
Expand All @@ -137,8 +144,13 @@ Your applications are now available in your local browser:
- Jupyter-notebook - http://localhost:30040
- Nuclio - http://localhost:30050
- MLRun UI - http://localhost:30060
- MLRun API (external) - http://localhost:30070
- MLRun API (external) - http://localhost:30070 (health check via http://localhost:30070/api/healthz)

```{admonition} Check state
You can check current state of installation via command `kubectl -n mlrun get pods`, where the main information
is in columns `Ready` and `State`. If all images have already been pulled locally, typically it will take
a minute for all services to start.
```

```{admonition} Note
The above links assume your Kubernetes cluster is exposed on localhost.
Expand All @@ -149,7 +161,7 @@ If that's not the case, the different components are available on the provided `

## Start working

Open Jupyter Lab on [**jupyter-lab UI**](http://localhost:30040) and run the code in [**docs/quick-start.ipynb**](https://github.com/mlrun/mlrun/blob/master/docs/quick-start.ipynb) notebook.
Open Jupyter Lab on [**jupyter-lab UI**](http://localhost:30040) and run the code in [**quick-start.ipynb**](https://github.com/mlrun/mlrun/blob/master/docs/quick-start.ipynb) notebook.

```{admonition} Important
Make sure to save your changes in the `data` folder within the Jupyter Lab. The root folder and any other folder do not retain the changes when you restart the Jupyter Lab.
Expand Down

0 comments on commit cda95ab

Please sign in to comment.