Skip to content

Commit

Permalink
Update README.md and RELEASE.md with v0.7.0-rc.3 tag
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Klues <kklues@nvidia.com>
  • Loading branch information
klueska committed Jul 20, 2020
1 parent ef6b138 commit 9da11f3
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 16 deletions.
37 changes: 22 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.2/nvidia-device-plugin.yml
$ kubectl create -f https://raw.githubusercontent.com/NVIDIA/k8s-device-plugin/v0.7.0-rc.3/nvidia-device-plugin.yml
```

**Note:** This is a simple static daemonset meant to demonstrate the basic
Expand Down Expand Up @@ -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.2`) includes
The `helm` chart for the latest release of the plugin (`v0.7.0-rc.3`) includes
a number of customizable values. The most commonly overridden ones are:

```
Expand Down Expand Up @@ -176,7 +176,7 @@ that you can set in your pod spec to get access to a specific MIG device.
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.2/deployments/helm/nvidia-device-plugin/values.yaml
* https://github.com/NVIDIA/k8s-device-plugin/blob/v0.7.0-rc.3/deployments/helm/nvidia-device-plugin/values.yaml

#### Installing via `helm install`from the `nvidia-device-plugin` `helm` repository

Expand All @@ -199,7 +199,7 @@ plugin with the various flags from above.
Using the default values for the flags:
```shell
$ helm install \
--version=0.7.0-rc.2 \
--version=0.7.0-rc.3 \
--generate-name \
nvdp/nvidia-device-plugin
```
Expand All @@ -208,7 +208,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.2 \
--version=0.7.0-rc.3 \
--generate-name \
--set compatWithCPUManager=true \
--set resources.requests.cpu=100m \
Expand All @@ -219,7 +219,7 @@ $ helm install \
Use the legacy Daemonset API (only available on Kubernetes < `v1.16`):
```shell
$ helm install \
--version=0.7.0-rc.2 \
--version=0.7.0-rc.3 \
--generate-name \
--set legacyDaemonsetAPI=true \
nvdp/nvidia-device-plugin
Expand All @@ -228,7 +228,7 @@ $ helm install \
Enabling compatibility with the `CPUManager` and the `mixed` `migStrategy`
```shell
$ helm install \
--version=0.7.0-rc.2 \
--version=0.7.0-rc.3 \
--generate-name \
--set compatWithCPUManager=true \
--set migStrategy=mixed \
Expand All @@ -246,7 +246,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.2.tgz
https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.3.tgz
```

Enabling compatibility with the `CPUManager` and running with a request for
Expand All @@ -257,15 +257,15 @@ $ 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.2.tgz
https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.3.tgz
```

Use the legacy Daemonset API (only available on Kubernetes < `v1.16`):
```shell
$ helm install \
--generate-name \
--set legacyDaemonsetAPI=true \
https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.2.tgz
https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.3.tgz
```

Enabling compatibility with the `CPUManager` and the `mixed` `migStrategy`
Expand All @@ -274,31 +274,31 @@ $ 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.2.tgz
https://nvidia.github.com/k8s-device-plugin/stable/nvidia-device-plugin-0.7.0-rc.3.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.2`), but can
It assumes you are pinning to the latest release tag (i.e. `v0.7.0-rc.3`), but can
easily be modified to work with any available tag or branch.

### With Docker

#### 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.2
$ docker tag nvidia/k8s-device-plugin:v0.7.0-rc.2 nvidia/k8s-device-plugin:devel
$ docker pull nvidia/k8s-device-plugin:v0.7.0-rc.3
$ docker tag nvidia/k8s-device-plugin:v0.7.0-rc.3 nvidia/k8s-device-plugin:devel
```

Option 2, build without cloning the repository:
```shell
$ 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.2
https://github.com/NVIDIA/k8s-device-plugin.git#v0.7.0-rc.3
```

Option 3, if you want to modify the code:
Expand Down Expand Up @@ -352,6 +352,13 @@ $ ./k8s-device-plugin --pass-device-specs

## Changelog

### Version v0.7.0-rc.3

- Fail the plugin if NVML cannot be loaded
- Update logging to print to stderr on error
- Add best effort removal of socket file before serving
- Add logic to implement GetPreferredAllocation() call from kubelet

### Version v0.7.0-rc.2

- Add the ability to set 'resources' as part of a helm install
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ 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.2`) with the new version
- [ ] Update the README to change occurances of the old version (e.g: `v0.7.0-rc.3`) with the new version
- [ ] Update the README changelog
- [ ] Commit, Tag and Push to Gitlab
- [ ] Build a new helm package with `helm package ./deployments/helm/nvidia-device-plugin`
Expand Down

0 comments on commit 9da11f3

Please sign in to comment.