Skip to content

Commit ce8a2aa

Browse files
committed
update and improve CONTRIBUTING documentation
1 parent 0d641d5 commit ce8a2aa

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

CONTRIBUTING.md

+23-16
Original file line numberDiff line numberDiff line change
@@ -19,18 +19,22 @@ The GPU Operator is made up of the following software components - each of the c
1919
* [k8s-device-plugin](https://github.com/NVIDIA/k8s-device-plugin)
2020
* [driver](https://gitlab.com/nvidia/container-images/driver)
2121
* [container-toolkit](https://gitlab.com/nvidia/container-toolkit/container-config)
22-
* [dcgm-exporter](https://gitlab.com/nvidia/container-toolkit/gpu-monitoring-tools)
23-
* [samples](https://gitlab.com/nvidia/container-images/samples/-/tree/master/cuda/rhel-ubi8/vector-add)
22+
* [dcgm-exporter](https://github.com/NVIDIA/dcgm-exporter)
23+
* [gpu-feature-discovery](https://gitlab.com/nvidia/kubernetes/gpu-feature-discovery)
24+
* [mig-manager](https://gitlab.com/nvidia/cloud-native/mig-parted)
25+
* [samples](https://gitlab.com/nvidia/container-images/samples/-/tree/main/cuda/archive/rhel-ubi8/vector-add)
2426

2527
```
2628
gitlab.com/
2729
├── nvidia/
28-
│ ├── gpu-operator (CRD and controller logic that implements the reconciliation)
29-
│ ├── k8s-device-plugin (NVIDIA Device Plugin for Kubernetes)
30-
│ ├── driver (NVIDIA Driver qualified for data center GPUs)
31-
│ ├── container-toolkit (NVIDIA Container Toolkit, runtime for Docker)
32-
│ ├── dcgm-exporter (NVIDIA DCGM for monitoring and telemetry)
33-
│ ├── samples (CUDA VectorAdd sample used for validation steps)
30+
│ ├── gpu-operator (CRD and controller logic that implements the reconciliation)
31+
│ ├── k8s-device-plugin (NVIDIA Device Plugin for Kubernetes)
32+
│ ├── driver (NVIDIA Driver qualified for data center GPUs)
33+
│ ├── container-toolkit (NVIDIA Container Toolkit, runtime for Docker)
34+
│ ├── dcgm-exporter (NVIDIA DCGM for monitoring and telemetry)
35+
│ ├── gpu-feature-discovery (NVIDIA GPU Feature Discovery for Kubernetes)
36+
│ ├── mig-manager (NVIDIA Multi-Instance GPU Manager for Kubernetes)
37+
│ ├── samples (CUDA VectorAdd sample used for validation steps)
3438
```
3539

3640
## License
@@ -42,7 +46,7 @@ The NVIDIA GPU Operator has three artifacts as part of the product release:
4246
1. [Container Images](#container-images)
4347
1. [Helm Charts](#helm-charts)
4448

45-
The GPU Operator releases follow semantic versioning.
49+
The GPU Operator releases follow [calendar versioning](https://calver.org/).
4650

4751
### <a name="source-code"></a> Source Code
4852

@@ -61,16 +65,19 @@ Releases of the GPU Operator include container images that are currently availab
6165
The following are the container images (and tag format) that are released:
6266
```
6367
├── nvidia/
64-
│ ├── gpu-operator (<version-number>)
65-
│ ├── k8s-device-plugin (<version-number><os--base-image>)
66-
│ ├── driver (<driver-branch><version-number><kernel-version><operating-system>)
67-
│ ├── container-toolkit (<version-number><os-base-image>)
68-
│ ├── dcgm-exporter (<dcgm-version><version-number><os-base-image>)
69-
│ ├── samples (<version-number><sample-name>)
68+
│ ├── gpu-operator (<version-number>)
69+
│ ├── k8s-device-plugin (<version-number><os-base-image>)
70+
│ ├── driver (<driver-branch><version-number><kernel-version><operating-system>)
71+
│ ├── container-toolkit (<version-number><os-base-image>)
72+
│ ├── dcgm-exporter (<dcgm-version><version-number><os-base-image>)
73+
│ ├── gpu-feature-discovery (<version-number><os-base-image>)
74+
│ ├── mig-manager (<version-number><operating-system>)
75+
│ ├── samples (<version-number><sample-name>)
7076
```
7177

7278
### <a name="helm-charts"></a> Helm Charts
73-
To simplify the deployment, the Operator can be installed using a Helm chart (note only Helm v3 is supported). A Helm chart repository is maintained at the following URL: https://nvidia.github.io/gpu-operator (which in turn is maintained at the corresponding ‘gh-pages’ directory under https://github.com/NVIDIA/gpu-operator/tree/gh-pages)
79+
To simplify the deployment, the Operator can be installed using a Helm chart (note only Helm v3 is supported). The documentation for helm installation
80+
can be viewed [here](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/getting-started.html#install-helm).
7481

7582
Continuous (‘nightly’) releases of the operator are available. Release milestones are available under ‘stable’.
7683
```

0 commit comments

Comments
 (0)