Skip to content

Commit

Permalink
docs: Update version tags after v0.11.2 release (#476)
Browse files Browse the repository at this point in the history
- docs/install/install-script.md
- docs/component-versions.md
- docs/quickstart.md
- scripts/setup_user_namespaces.sh

---------

Signed-off-by: Christian Kadner <ckadner@us.ibm.com>
  • Loading branch information
ckadner authored Jan 11, 2024
1 parent a920d24 commit b3c8f08
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 18 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,3 @@ devbuild
.develop_image_name
.dev/
.pre-commit.log

13 changes: 7 additions & 6 deletions docs/component-versions.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Component versions

The following table shows the component versions for the latest modelmesh-serving release (v0.11.0).
| Component | Description | Upstream Revision |
| - | - | - |
| ModelMesh | Serves as a general-purpose model serving management/routing layer | [v0.11.0](https://github.com/kserve/modelmesh/tree/v0.11.0) |
| ModelMesh Runtime Adapter | Contains the unified puller/runtime-adapter image | [v0.11.0](https://github.com/kserve/modelmesh-runtime-adapter/tree/v0.11.0) |
| REST Proxy | Supports inference requests using KServe V2 REST Predict Protocol | [v0.11.0](https://github.com/kserve/rest-proxy/tree/v0.11.0) |
The following table shows the component versions for the latest ModelMesh Serving release (v0.11.2).

| Component | Description | Upstream Revision |
| ------------------------- | ------------------------------------------------------------------ | --------------------------------------------------------------------------- |
| ModelMesh | Serves as a general-purpose model serving management/routing layer | [v0.11.2](https://github.com/kserve/modelmesh/tree/v0.11.2) |
| ModelMesh Runtime Adapter | Contains the unified puller/runtime-adapter image | [v0.11.2](https://github.com/kserve/modelmesh-runtime-adapter/tree/v0.11.2) |
| REST Proxy | Supports inference requests using KServe V2 REST Predict Protocol | [v0.11.2](https://github.com/kserve/rest-proxy/tree/v0.11.2) |
4 changes: 2 additions & 2 deletions docs/install/install-script.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,11 @@ A secret named `model-serving-etcd` will be created and passed to the controller
<!-- Remove the following note on the `release-*` branch -->

To install the most recent _stable release_ of [modelmesh-serving](https://github.com/kserve/modelmesh-serving/releases/latest)
follow the [Installation instructions](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/install/install-script.md) for version `v0.11.0`.
follow the [Installation instructions](https://github.com/kserve/modelmesh-serving/blob/release-0.11.2/docs/install/install-script.md) for version `v0.11.2`.

Start by cloning the [modelmesh-serving](https://github.com/kserve/modelmesh-serving.git) repository:

<!-- Replace with RELEASE="release-0.11" on the `release-*` branch -->
<!-- Replace with RELEASE="release-0.12" on the `release-0.12` branch -->

```shell
RELEASE="main"
Expand Down
13 changes: 9 additions & 4 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,24 @@ To quickly get started using ModelMesh Serving, here is a brief guide.

<!-- Remove the following note on the `release-*` branch -->

> **Note**: This document describes how to install the _latest unreleased_ version of ModelMesh for developers and early adopters. To install the most recent _stable release_, please follow the [Quick Start Guide for version 0.11](https://github.com/kserve/modelmesh-serving/blob/release-0.11/docs/quickstart.md).
> **Note**: This document describes how to install the _latest unreleased_
> version of ModelMesh for developers and early adopters. To install the
> most recent _stable release_, please follow the
> [Quick Start Guide for version 0.11.2](https://github.com/kserve/modelmesh-serving/blob/release-0.11.2/docs/quickstart.md).
## Prerequisites

- A Kubernetes cluster v1.23+ with cluster administrative privileges
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and [kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) (v4.0+)
- At least 4 vCPU and 8 GB memory. For more details, please see [here](install/README.md#deployed-components).
- [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) and
[kustomize](https://kubectl.docs.kubernetes.io/installation/kustomize/) (v4.0+)
- At least 4 vCPU and 8 GB memory. For more details, please see
[here](install/README.md#deployed-components).

## 1. Install ModelMesh Serving

### Clone the ModelMesh repository

<!-- Replace with RELEASE="release-0.11" on the `release-*` branch -->
<!-- Replace with RELEASE="release-0.12" on the `release-0.12` branch -->

```shell
RELEASE="main"
Expand Down
10 changes: 6 additions & 4 deletions docs/release-process.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ with KServe.

- [ ] [kserve/modelmesh](https://hub.docker.com/r/kserve/modelmesh/tags)
- [ ] [kserve/modelmesh-minio-examples](https://hub.docker.com/r/kserve/modelmesh-minio-examples/tags)
- [ ] [kserve/modelmesh-minio-dev-examples](https://hub.docker.com/r/kserve/modelmesh-minio-dev-examples/tags)
- [ ] [kserve/modelmesh-runtime-adapter](https://hub.docker.com/r/kserve/modelmesh-runtime-adapter/tags)
- [ ] [kserve/rest-proxy](https://hub.docker.com/r/kserve/rest-proxy/tags)

Expand All @@ -122,24 +123,25 @@ with KServe.
- `kserve/modelmesh`
- `kserve/modelmesh-controller`
- `kserve/modelmesh-minio-examples`
- `kserve/modelmesh-minio-dev-examples`
- `kserve/modelmesh-runtime-adapter`
- `kserve/rest-proxy`

The version tags should be updated in the following files:

- [ ] `.github/workflows/fvt-base.yml`:
- [ ] `docker pull kserve/modelmesh:v...`
- [ ] `docker pull kserve/modelmesh-minio-examples:v...`
- [ ] `docker pull kserve/modelmesh-minio-dev-examples:v...`
- [ ] `docker pull kserve/modelmesh-minio-examples:v...`
- [ ] `docker pull kserve/modelmesh-runtime-adapter:v...`
- [ ] `docker pull kserve/rest-proxy:v...`
- [ ] `config/default/config-defaults.yaml`:
- [ ] `kserve/modelmesh`
- [ ] `kserve/rest-proxy`
- [ ] `kserve/modelmesh-runtime-adapter`
- [ ] `config/dependencies/fvt.yaml`:
- [ ] `image: kserve/modelmesh-minio-dev-examples:v...`
- [ ] `image: kserve/modelmesh-minio-examples:v...`
- [ ] `image: kserve/modelmesh-minio-dev-examples:v...`
- [ ] `image: kserve/modelmesh-minio-examples:v...`
- [ ] `config/dependencies/quickstart.yaml`:
- [ ] `image: kserve/modelmesh-minio-examples:v...`
- [ ] `config/manager/kustomization.yaml`: update the `newTag` to `v...`
Expand All @@ -166,9 +168,9 @@ with KServe.
(e.g. `v0.11.0`) with the new release branch name or new version tags.
Submit them in a PR to `main`, and wait for that PR to be merged:

- [ ] `docs/install/install-script.md`
- [ ] `docs/component-versions.md`
- [ ] `docs/quickstart.md`
- [ ] `docs/install/install-script.md`
- [ ] `scripts/setup_user_namespaces.sh`

## Generate Release Artifacts and Publish the Release
Expand Down
2 changes: 1 addition & 1 deletion scripts/setup_user_namespaces.sh
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ EOF

ctrl_ns="modelmesh-serving"
user_ns_array=()
modelmesh_release="v0.11.0" # The latest release is the default
modelmesh_release="v0.11.2" # The latest release is the default
create_storage_secret=false
deploy_serving_runtimes=false
dev_mode=false # Set to true to use locally cloned files instead of from a release
Expand Down

0 comments on commit b3c8f08

Please sign in to comment.