Skip to content

Commit

Permalink
[MLRun] Finalizing docs for 1.6.1 (mlrun#5217)
Browse files Browse the repository at this point in the history
  • Loading branch information
liranbg authored Feb 29, 2024
1 parent 9526318 commit 548b5a1
Show file tree
Hide file tree
Showing 11 changed files with 22 additions and 22 deletions.
6 changes: 3 additions & 3 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,7 @@ spec:
image: .mlrun/func-default-remote-demo-ps-latest
image_pull_policy: Always
build:
base_image: mlrun/mlrun:1.6.0
base_image: mlrun/mlrun:1.6.1
source: git://github.com/mlrun/mlrun
```
Expand Down Expand Up @@ -310,7 +310,7 @@ spec:
image_pull_policy: Always
build:
commands: []
base_image: mlrun/mlrun:1.6.0
base_image: mlrun/mlrun:1.6.1
source: git://github.com/mlrun/ci-demo.git
```
Expand Down Expand Up @@ -338,7 +338,7 @@ spec:
image_pull_policy: Always
build:
commands: []
base_image: mlrun/mlrun:1.6.0
base_image: mlrun/mlrun:1.6.1
```

Next, run the following MLRun CLI command to build the function; replace the `<...>` placeholders to match your configuration:
Expand Down
4 changes: 2 additions & 2 deletions docs/install/compose.with-jupyter.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ services:
- nuclio-platform-config:/etc/nuclio/config

jupyter:
image: "mlrun/jupyter:${TAG:-1.6.0}"
image: "mlrun/jupyter:${TAG:-1.6.1}"
ports:
- "8080:8080"
- "8888:8888"
Expand All @@ -61,7 +61,7 @@ services:
- mlrun

mlrun-ui:
image: "mlrun/mlrun-ui:${TAG:-1.6.0}"
image: "mlrun/mlrun-ui:${TAG:-1.6.1}"
ports:
- "8060:8090"
environment:
Expand Down
4 changes: 2 additions & 2 deletions docs/install/compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ services:
- nuclio-platform-config:/etc/nuclio/config

mlrun-api:
image: "mlrun/mlrun-api:${TAG:-1.6.0}"
image: "mlrun/mlrun-api:${TAG:-1.6.1}"
ports:
- "8080:8080"
environment:
Expand All @@ -61,7 +61,7 @@ services:
- mlrun

mlrun-ui:
image: "mlrun/mlrun-ui:${TAG:-1.6.0}"
image: "mlrun/mlrun-ui:${TAG:-1.6.1}"
ports:
- "8060:8090"
environment:
Expand Down
2 changes: 1 addition & 1 deletion docs/projects/ci-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ pipeline {
}
agent {
docker {
image 'mlrun/mlrun:1.6.0'
image 'mlrun/mlrun:1.6.1'
}
}
steps {
Expand Down
6 changes: 3 additions & 3 deletions docs/runtimes/images.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,8 @@ This flow describes how to build the image externally, put it your private repo,
## MLRun images and external docker images

There is no difference in the usage between the MLRun images and external docker images. However:
- MLRun images resolve auto tags: If you specify ```image="mlrun/mlrun"``` the API fills in the tag by the client version, e.g. changes it to `mlrun/mlrun:1.6.0`. So, if the client gets upgraded you'll automatically get a new image tag.
- Where the data node registry exists, MLRun Appends the registry prefix, so the image loads from the datanode registry. This pulls the image more quickly, and also supports air-gapped sites. When you specify an MLRun image, for example `mlrun/mlrun:1.6.0`, the actual image used is similar to `datanode-registry.iguazio-platform.app.vm/mlrun/mlrun:1.6.0`.
- MLRun images resolve auto tags: If you specify ```image="mlrun/mlrun"``` the API fills in the tag by the client version, e.g. changes it to `mlrun/mlrun:1.6.1`. So, if the client gets upgraded you'll automatically get a new image tag.
- Where the data node registry exists, MLRun Appends the registry prefix, so the image loads from the datanode registry. This pulls the image more quickly, and also supports air-gapped sites. When you specify an MLRun image, for example `mlrun/mlrun:1.6.1`, the actual image used is similar to `datanode-registry.iguazio-platform.app.vm/mlrun/mlrun:1.6.1`.

These characteristics are great when you’re working in a POC or development environment. But MLRun typically upgrades packages as part of the image, and therefore the default MLRun images can break your product flow.

Expand All @@ -110,5 +110,5 @@ These characteristics are great when you’re working in a POC or development en
For production, **create your own images** to ensure that the image is fixed.
```

- Pin the image tag, e.g. `image="mlrun/mlrun:1.6.0"`. This maintains the image tag at the version you specified, even when the client is upgraded. Otherwise, an upgrade of the client would also upgrade the image. (If you specify an external (not MLRun images) docker image, like python, the result is the docker/k8s default behavior, which defaults to `latest` when the tag is not provided.)
- Pin the image tag, e.g. `image="mlrun/mlrun:1.6.1"`. This maintains the image tag at the version you specified, even when the client is upgraded. Otherwise, an upgrade of the client would also upgrade the image. (If you specify an external (not MLRun images) docker image, like python, the result is the docker/k8s default behavior, which defaults to `latest` when the tag is not provided.)
- Pin the versions of requirements, again to avoid breakages, e.g. `pandas==1.4.0`. (If you only specify the package name, e.g. pandas, then pip/conda (python's package managers) just pick up the latest version.)
8 changes: 4 additions & 4 deletions hack/local/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ To use MLRun with your local Docker registry, run the MLRun API service, dashboa
```
SHARED_DIR=~/mlrun-data
docker pull mlrun/jupyter:1.6.0
docker pull mlrun/mlrun-ui:1.6.0
docker pull mlrun/jupyter:1.6.1
docker pull mlrun/mlrun-ui:1.6.1
docker network create mlrun-network
docker run -it -p 8080:8080 -p 8888:8888 --rm -d --network mlrun-network --name jupyter -v ${SHARED_DIR}:/home/jovyan/data mlrun/jupyter:1.6.0
docker run -it -p 4000:80 --rm -d --network mlrun-network --name mlrun-ui -e MLRUN_API_PROXY_URL=http://jupyter:8080 mlrun/mlrun-ui:1.6.0
docker run -it -p 8080:8080 -p 8888:8888 --rm -d --network mlrun-network --name jupyter -v ${SHARED_DIR}:/home/jovyan/data mlrun/jupyter:1.6.1
docker run -it -p 4000:80 --rm -d --network mlrun-network --name mlrun-ui -e MLRUN_API_PROXY_URL=http://jupyter:8080 mlrun/mlrun-ui:1.6.1
```

When the execution completes &mdash;
Expand Down
2 changes: 1 addition & 1 deletion hack/local/mljupy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ spec:
spec:
containers:
- name: jupyter-notebook
image: mlrun/jupyter:1.6.0
image: mlrun/jupyter:1.6.1
env:
- name: MLRUN_NAMESPACE
valueFrom:
Expand Down
4 changes: 2 additions & 2 deletions hack/local/mlrun-local.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ spec:
spec:
containers:
- name: mlrun-api
image: mlrun/mlrun-api:1.6.0
image: mlrun/mlrun-api:1.6.1
env:
- name: MLRUN_NAMESPACE
valueFrom:
Expand Down Expand Up @@ -86,7 +86,7 @@ spec:
spec:
containers:
- name: mlrun-ui
image: mlrun/mlrun-ui:1.6.0
image: mlrun/mlrun-ui:1.6.1
env:
- name: MLRUN_API_PROXY_URL
value: http://mlrun-api:8080
Expand Down
4 changes: 2 additions & 2 deletions hack/mlrun-all.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ spec:
spec:
containers:
- name: mlrun-api
image: mlrun/mlrun-api:1.6.0
image: mlrun/mlrun-api:1.6.1
env:
- name: MLRUN_NAMESPACE
valueFrom:
Expand Down Expand Up @@ -91,7 +91,7 @@ spec:
spec:
containers:
- name: mlrun-ui
image: mlrun/mlrun-ui:1.6.0
image: mlrun/mlrun-ui:1.6.1
env:
- name: MLRUN_API_PROXY_URL
value: http://mlrun-api:8080
Expand Down
2 changes: 1 addition & 1 deletion hack/mlrunapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ spec:
spec:
containers:
- name: mlrun-api
image: mlrun/mlrun-api:1.6.0
image: mlrun/mlrun-api:1.6.1
env:
- name: MLRUN_HTTPDB__BUILDER__DOCKER_REGISTRY
value: "default registry url e.g. index.docker.io/<username>, if repository is not set it will default to mlrun"
Expand Down
2 changes: 1 addition & 1 deletion hack/mlrunui.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ spec:
spec:
containers:
- name: mlrun-ui
image: mlrun/mlrun-ui:1.6.0
image: mlrun/mlrun-ui:1.6.1
env:
- name: MLRUN_API_PROXY_URL
value: http://mlrun-api:8080
Expand Down

0 comments on commit 548b5a1

Please sign in to comment.