Skip to content

Commit ba6504d

Browse files
committedJul 18, 2024··
Update CONTRIBUTING.md following Github migration
Signed-off-by: Christopher Desiniotis <cdesiniotis@nvidia.com>
1 parent 951df73 commit ba6504d

File tree

1 file changed

+31
-50
lines changed

1 file changed

+31
-50
lines changed
 

‎CONTRIBUTING.md

+31-50
Original file line numberDiff line numberDiff line change
@@ -15,88 +15,69 @@ The NVIDIA GPU Operator is an open-source product built and maintained by NVIDIA
1515
## Architecture
1616
The GPU Operator is made up of the following software components - each of the components runs as a container, including NVIDIA drivers. The associated code is linked to each of the components below:
1717

18-
* [gpu-operator](https://gitlab.com/nvidia/kubernetes/gpu-operator)
18+
* [gpu-operator](https://github.com/NVIDIA/gpu-operator)
1919
* [k8s-device-plugin](https://github.com/NVIDIA/k8s-device-plugin)
20-
* [driver](https://gitlab.com/nvidia/container-images/driver)
21-
* [container-toolkit](https://gitlab.com/nvidia/container-toolkit/container-config)
20+
* [driver](https://github.com/NVIDIA/gpu-driver-container)
21+
* [container-toolkit](https://github.com/NVIDIA/nvidia-container-toolkit)
2222
* [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)
23+
* [gpu-feature-discovery](https://github.com/NVIDIA/k8s-device-plugin)
24+
* [mig-manager](https://github.com/NVIDIA/mig-parted)
25+
* [sandbox-device-plugin](https://github.com/NVIDIA/kubevirt-gpu-device-plugin)
26+
* [vgpu-device-manager](https://github.com/NVIDIA/vgpu-device-manager)
27+
* [kata-manager](https://github.com/NVIDIA/k8s-kata-manager)
28+
* [samples](https://github.com/NVIDIA/k8s-samples)
2629

2730
```
28-
gitlab.com/
29-
├── nvidia/
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)
31+
github.com/
32+
├── NVIDIA/
33+
│ ├── gpu-operator (CRD and controller logic that implements the reconciliation)
34+
│ ├── k8s-device-plugin (NVIDIA Device Plugin for Kubernetes)
35+
│ ├── gpu-driver-container (NVIDIA Driver qualified for data center GPUs)
36+
│ ├── nvidia-container-toolkit (NVIDIA Container Toolkit, runtime for Docker)
37+
│ ├── dcgm-exporter (NVIDIA DCGM for monitoring and telemetry)
38+
│ ├── gpu-feature-discovery (NVIDIA GPU Feature Discovery for Kubernetes)
39+
│ ├── mig-manager (NVIDIA Multi-Instance GPU Manager for Kubernetes)
40+
│ ├── sandbox-device-plugin (NVIDIA Device Plugin for sandboxed environments)
41+
│ ├── vgpu-device-manager (NVIDIA vGPU Device Manager for Kubernetes)
42+
│ ├── kata-manager (NVIDIA Kata Manager for Kubernetes)
43+
│ ├── samples (CUDA VectorAdd sample used for validation steps)
3844
```
3945

4046
## License
4147
The NVIDIA GPU Operator is open-source and its components are licensed under the permissive Apache 2.0 license.
4248

4349
## Artifacts
44-
The NVIDIA GPU Operator has three artifacts as part of the product release:
50+
The NVIDIA GPU Operator has the following artifacts as part of the product release:
4551
1. [Source Code](#source-code)
52+
1. [Documentation](#documentation)
4653
1. [Container Images](#container-images)
4754
1. [Helm Charts](#helm-charts)
4855

4956
The GPU Operator releases follow [calendar versioning](https://calver.org/).
5057

5158
### <a name="source-code"></a> Source Code
5259

53-
The NVIDIA GPU Operator is available on two external source code repositories:
54-
* GitHub: https://github.com/NVIDIA/gpu-operator
55-
* GitLab: https://gitlab.com/nvidia/kubernetes/gpu-operator
60+
The NVIDIA GPU Operator source code is available on GitHub at https://github.com/NVIDIA/gpu-operator
5661

57-
The product page of the GPU Operator is available on NVIDIA’s official repository on GitHub. GitHub is where we interact primarily with users for issues related to the operator. GitHub is a mirror of the source code repository on GitLab - no development happens on GitHub.
62+
### <a name="source-code"></a> Documentation
5863

59-
GitLab is where the GPU Operator is actively developed - we leverage GitLab’s CI/CD infrastructure for build, test, package and release of the Operator. GitLab is where we expect users and partners to contribute patches (“Merge Requests” or “MRs”) against the source code repository. MRs do not require explicit contributor license agreements (CLA), but we expect contributors to sign their work.
64+
The official NVIDIA GPU Operator documentation is available at https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/index.html
6065

6166
### <a name="container-images"></a> Container Images
6267

63-
Releases of the GPU Operator include container images that are currently available on NVIDIA’s Docker Hub [repository](https://hub.docker.com/u/nvidia). In the future, the operator will be available on [NVIDIA NGC Catalog](https://ngc.nvidia.com/).
64-
65-
The following are the container images (and tag format) that are released:
66-
```
67-
├── nvidia/
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>)
76-
```
68+
Releases of the GPU Operator include container images that are currently available on [NVIDIA NGC Catalog](https://ngc.nvidia.com/).
7769

7870
### <a name="helm-charts"></a> Helm Charts
7971
To simplify the deployment, the Operator can be installed using a Helm chart (note only Helm v3 is supported). The documentation for helm installation
8072
can be viewed [here](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/getting-started.html#install-helm).
8173

82-
Continuous (‘nightly’) releases of the operator are available. Release milestones are available under ‘stable’.
83-
```
84-
├── nightly/index.yaml
85-
├── stable/index.yaml (default when installing the operator)
86-
```
74+
8775
## Contributions
8876
NVIDIA is willing to work with partners for adding platform support for the GPU Operator. The GPU Operator is open-source and permissively licensed under the Apache 2.0 license with only minimal requirements for source code [contributions](#signing).
8977

90-
To get started with building the GPU Operator, follow these steps:
91-
92-
```shell
93-
$ git clone https://gitlab.com/nvidia/kubernetes/gpu-operator.git
94-
$ cd gpu-operator
95-
$ make .build-image
96-
```
97-
We also use a CI infrastructure on AWS for nightly and per-change testing on the GPU Operator. This infrastructure is available here: https://gitlab.com/nvidia/container-infrastructure/aws-kube-ci
78+
To file feature requests, bugs, or questions, submit an issue at https://github.com/NVIDIA/gpu-operator/issues
9879

99-
To ensure that the GPU Operator releases can be effectively validated on new platforms, it would be ideal for contributions to make available CI infrastructure (e.g. runners) and associated changes to the CI scripts.
80+
To contribute to the project, file a Pull Request at https://github.com/NVIDIA/gpu-operator/pulls. Contributions do not require explicit contributor license agreements (CLA), but we expect contributors to sign their work.
10081

10182
## <a name="signing"></a>Signing your work
10283

0 commit comments

Comments
 (0)
Please sign in to comment.