diff --git a/README.md b/README.md index 6c47b579f..3f347e280 100644 --- a/README.md +++ b/README.md @@ -82,7 +82,7 @@ Once you have configured the options above on all the GPU nodes in your cluster, you can enable GPU support by deploying the following Daemonset: ```shell -$ kubectl create -f https://raw.githubusercontent.com/NVIDIA/k8s-device-plugin/v0.7.0-rc.6/nvidia-device-plugin.yml +$ kubectl create -f https://raw.githubusercontent.com/NVIDIA/k8s-device-plugin/v0.7.0-rc.7/nvidia-device-plugin.yml ``` **Note:** This is a simple static daemonset meant to demonstrate the basic @@ -123,7 +123,7 @@ The preferred method to deploy the device plugin is as a daemonset using `helm`. Instructions for installing `helm` can be found [here](https://helm.sh/docs/intro/install/). -The `helm` chart for the latest release of the plugin (`v0.7.0-rc.6`) includes +The `helm` chart for the latest release of the plugin (`v0.7.0-rc.7`) includes a number of customizable values. The most commonly overridden ones are: ``` @@ -191,7 +191,7 @@ rationale behind this strategy can be found Please take a look in the following `values.yaml` file to see the full set of overridable parameters for the device plugin. -* https://github.com/NVIDIA/k8s-device-plugin/blob/v0.7.0-rc.6/deployments/helm/nvidia-device-plugin/values.yaml +* https://github.com/NVIDIA/k8s-device-plugin/blob/v0.7.0-rc.7/deployments/helm/nvidia-device-plugin/values.yaml #### Installing via `helm install`from the `nvidia-device-plugin` `helm` repository @@ -214,7 +214,7 @@ plugin with the various flags from above. Using the default values for the flags: ```shell $ helm install \ - --version=0.7.0-rc.6 \ + --version=0.7.0-rc.7 \ --generate-name \ nvdp/nvidia-device-plugin ``` @@ -223,7 +223,7 @@ Enabling compatibility with the `CPUManager` and running with a request for 100ms of CPU time and a limit of 512MB of memory. ```shell $ helm install \ - --version=0.7.0-rc.6 \ + --version=0.7.0-rc.7 \ --generate-name \ --set compatWithCPUManager=true \ --set resources.requests.cpu=100m \ @@ -234,7 +234,7 @@ $ helm install \ Use the legacy Daemonset API (only available on Kubernetes < `v1.16`): ```shell $ helm install \ - --version=0.7.0-rc.6 \ + --version=0.7.0-rc.7 \ --generate-name \ --set legacyDaemonsetAPI=true \ nvdp/nvidia-device-plugin @@ -243,7 +243,7 @@ $ helm install \ Enabling compatibility with the `CPUManager` and the `mixed` `migStrategy` ```shell $ helm install \ - --version=0.7.0-rc.6 \ + --version=0.7.0-rc.7 \ --generate-name \ --set compatWithCPUManager=true \ --set migStrategy=mixed \ @@ -261,7 +261,7 @@ Using the default values for the flags: ```shell $ helm install \ --generate-name \ - https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.6.tgz + https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.7.tgz ``` Enabling compatibility with the `CPUManager` and running with a request for @@ -272,7 +272,7 @@ $ helm install \ --set compatWithCPUManager=true \ --set resources.requests.cpu=100m \ --set resources.limits.memory=512Mi \ - https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.6.tgz + https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.7.tgz ``` Use the legacy Daemonset API (only available on Kubernetes < `v1.16`): @@ -280,7 +280,7 @@ Use the legacy Daemonset API (only available on Kubernetes < `v1.16`): $ helm install \ --generate-name \ --set legacyDaemonsetAPI=true \ - https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.6.tgz + https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.7.tgz ``` Enabling compatibility with the `CPUManager` and the `mixed` `migStrategy` @@ -289,14 +289,14 @@ $ helm install \ --generate-name \ --set compatWithCPUManager=true \ --set migStrategy=mixed \ - https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.6.tgz + https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.7.tgz ``` ## Building and Running Locally The next sections are focused on building the device plugin locally and running it. It is intended purely for development and testing, and not required by most users. -It assumes you are pinning to the latest release tag (i.e. `v0.7.0-rc.6`), but can +It assumes you are pinning to the latest release tag (i.e. `v0.7.0-rc.7`), but can easily be modified to work with any available tag or branch. ### With Docker @@ -304,8 +304,8 @@ easily be modified to work with any available tag or branch. #### Build Option 1, pull the prebuilt image from [Docker Hub](https://hub.docker.com/r/nvidia/k8s-device-plugin): ```shell -$ docker pull nvidia/k8s-device-plugin:v0.7.0-rc.6 -$ docker tag nvidia/k8s-device-plugin:v0.7.0-rc.6 nvidia/k8s-device-plugin:devel +$ docker pull nvidia/k8s-device-plugin:v0.7.0-rc.7 +$ docker tag nvidia/k8s-device-plugin:v0.7.0-rc.7 nvidia/k8s-device-plugin:devel ``` Option 2, build without cloning the repository: @@ -313,7 +313,7 @@ Option 2, build without cloning the repository: $ docker build \ -t nvidia/k8s-device-plugin:devel \ -f docker/amd64/Dockerfile.ubuntu16.04 \ - https://github.com/NVIDIA/k8s-device-plugin.git#v0.7.0-rc.6 + https://github.com/NVIDIA/k8s-device-plugin.git#v0.7.0-rc.7 ``` Option 3, if you want to modify the code: diff --git a/RELEASE.md b/RELEASE.md index f54471c05..561c67d83 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -8,11 +8,11 @@ Publishing the container is automated through gitlab-ci and only requires one to Publishing the helm chart is currently manual, and we should move to an automated process ASAP # Release Process Checklist -- [ ] Update the README to change occurances of the old version (e.g: `v0.7.0-rc.6`) with the new version - [ ] Update the README changelog +- [ ] Update the README to change occurances of the old version (e.g: `v0.7.0-rc.7`) with the new version - [ ] Commit, Tag and Push to Gitlab - [ ] Build a new helm package with `helm package ./deployments/helm/nvidia-device-plugin` -- [ ] Switch to the `gh-pages` branch and move the newly generated package to either the `stable` or `experimental` helm repo as appropriate +- [ ] Switch to the `gh-pages` branch and move the newly generated package to the `stable` helm repo - [ ] Run the `./build-index.sh` script to rebuild the indices for each repo - [ ] Commit and push the `gh-pages` branch to GitHub - [ ] Wait for the [CI job associated with your tag] (https://gitlab.com/nvidia/kubernetes/device-plugin/-/pipelines) to complete