You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+31-50
Original file line number
Diff line number
Diff line change
@@ -15,88 +15,69 @@ The NVIDIA GPU Operator is an open-source product built and maintained by NVIDIA
15
15
## Architecture
16
16
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:
The NVIDIA GPU Operator source code is available on GitHub at https://github.com/NVIDIA/gpu-operator
56
61
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 sourcecode repository on GitLab - no development happens on GitHub.
62
+
### <aname="source-code"></a> Documentation
58
63
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
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:
Releases of the GPU Operator include container images that are currently available on [NVIDIA NGC Catalog](https://ngc.nvidia.com/).
77
69
78
70
### <aname="helm-charts"></a> Helm Charts
79
71
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
72
can be viewed [here](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/getting-started.html#install-helm).
81
73
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
+
87
75
## Contributions
88
76
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).
89
77
90
-
To get started with building the GPU Operator, follow these steps:
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
98
79
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.
0 commit comments