Skip to content
This repository has been archived by the owner on May 27, 2024. It is now read-only.

Commit

Permalink
Update RELEASE and README for v0.6.0
Browse files Browse the repository at this point in the history
Signed-off-by: Kevin Klues <[email protected]>
  • Loading branch information
klueska committed Jun 6, 2022
1 parent 7479ebb commit c960fcb
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ The following command will deploy NFD with the minimum required set of
parameters to run `gpu-feature-discovery`.

```shell
kubectl apply -f https://raw.githubusercontent.com/NVIDIA/gpu-feature-discovery/v0.6.0-rc.1/deployments/static/nfd.yaml
kubectl apply -f https://raw.githubusercontent.com/NVIDIA/gpu-feature-discovery/v0.6.0/deployments/static/nfd.yaml
```

**Note:** This is a simple static daemonset meant to demonstrate the basic
Expand All @@ -97,7 +97,7 @@ or as a Job.
#### Daemonset

```shell
kubectl apply -f https://raw.githubusercontent.com/NVIDIA/gpu-feature-discovery/v0.6.0-rc.1/deployments/static/gpu-feature-discovery-daemonset.yaml
kubectl apply -f https://raw.githubusercontent.com/NVIDIA/gpu-feature-discovery/v0.6.0/deployments/static/gpu-feature-discovery-daemonset.yaml
```

**Note:** This is a simple static daemonset meant to demonstrate the basic
Expand All @@ -112,7 +112,7 @@ node you want to label:

```shell
$ export NODE_NAME=<your-node-name>
$ curl https://raw.githubusercontent.com/NVIDIA/gpu-feature-discovery/v0.6.0-rc.1/deployments/static/gpu-feature-discovery-job.yaml.template \
$ curl https://raw.githubusercontent.com/NVIDIA/gpu-feature-discovery/v0.6.0/deployments/static/gpu-feature-discovery-job.yaml.template \
| sed "s/NODE_NAME/${NODE_NAME}/" > gpu-feature-discovery-job.yaml
$ kubectl apply -f gpu-feature-discovery-job.yaml
```
Expand Down Expand Up @@ -268,7 +268,7 @@ The preferred method to deploy `gpu-feature-discovery` is as a daemonset using `
Instructions for installing `helm` can be found
[here](https://helm.sh/docs/intro/install/).

The `helm` chart for the latest release of GFD (`v0.6.0-rc.1`) includes a number
The `helm` chart for the latest release of GFD (`v0.6.0`) includes a number
of customizable values. The most commonly overridden ones are:

```
Expand All @@ -294,8 +294,8 @@ Please take a look in the following `values.yaml` files to see the full set of
overridable parameters for both the top-level `gpu-feature-discovery` chart and
the `node-feature-discovery` subchart.

* https://github.com/NVIDIA/gpu-feature-discovery/blob/v0.6.0-rc.1/deployments/helm/gpu-feature-discovery/values.yaml
* https://github.com/NVIDIA/gpu-feature-discovery/blob/v0.6.0-rc.1/deployments/helm/gpu-feature-discovery/charts/node-feature-discovery/values.yaml
* https://github.com/NVIDIA/gpu-feature-discovery/blob/v0.6.0/deployments/helm/gpu-feature-discovery/values.yaml
* https://github.com/NVIDIA/gpu-feature-discovery/blob/v0.6.0/deployments/helm/gpu-feature-discovery/charts/node-feature-discovery/values.yaml

#### Installing via `helm install`

Expand All @@ -313,11 +313,11 @@ $ helm repo add nvgfd https://nvidia.github.io/gpu-feature-discovery
$ helm repo update
```

Then verify that the latest release (`v0.6.0-rc.1`) of the plugin is available:
Then verify that the latest release (`v0.6.0`) of the plugin is available:
```
$ helm search repo nvgfd --devel
NAME CHART VERSION APP VERSION DESCRIPTION
nvgfd/gpu-feature-discovery 0.6.0-rc.1 0.6.0-rc.1 A Helm chart for ...
NAME CHART VERSION APP VERSION DESCRIPTION
nvgfd/gpu-feature-discovery 0.6.0 0.6.0 A Helm chart for ...
```

Once this repo is updated, you can begin installing packages from it to deploy
Expand All @@ -326,7 +326,7 @@ the `gpu-feature-discovery` helm chart.
The most basic installation command without any options is then:
```
$ helm upgrade -i nvgfd nvgfd/gpu-feature-discovery \
--version 0.6.0-rc.1 \
--version 0.6.0 \
--namespace gpu-feature-discovery \
--create-namespace
```
Expand All @@ -335,7 +335,7 @@ Disabling auto-deployment of NFD and running with a MIG strategy of 'mixed' in
the default namespace.
```shell
$ helm upgrade -i nvgfd nvgfd/gpu-feature-discovery \
--version=0.6.0-rc.1 \
--version=0.6.0 \
--set allowDefaultNamespace=true \
--set nfd.enabled=false \
--set migStrategy=mixed
Expand Down Expand Up @@ -385,7 +385,7 @@ Using the default values for the flags:
```shell
$ helm upgrade -i nvgfd \
--set allowDefaultNamespace=true \
https://nvidia.github.io/gpu-feature-discovery/stable/gpu-feature-discovery-0.6.0-rc.1.tgz
https://nvidia.github.io/gpu-feature-discovery/stable/gpu-feature-discovery-0.6.0.tgz
```

Disabling auto-deployment of NFD and running with a MIG strategy of 'mixed' in
Expand All @@ -395,7 +395,7 @@ $ helm upgrade -i nvgfd \
--set nfd.deploy=false \
--set migStrategy=mixed \
--set allowDefaultNamespace=true \
https://nvidia.github.io/gpu-feature-discovery/stable/gpu-feature-discovery-0.6.0-rc.1.tgz
https://nvidia.github.io/gpu-feature-discovery/stable/gpu-feature-discovery-0.6.0.tgz
```

## Building and running locally with Docker
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.1.0`) with the new version
- [ ] Update the README to change occurances of the old version (e.g: `v0.6.0`) with the new version
- [ ] Commit, Tag and Push to Gitlab
- [ ] Build a new helm package with `helm package ./deployments/helm/gpu-feature-discovery`
- [ ] Switch to the `gh-pages` branch and move the newly generated package to either the `stable` helm repo
Expand Down

0 comments on commit c960fcb

Please sign in to comment.