Skip to content

Commit 5c0b5eb

Browse files
Update theme (#142)
Update theme --------- Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
1 parent fbcf81b commit 5c0b5eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

58 files changed

+274
-1955
lines changed

.codespell_exclude_lines.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,31 @@ command-line argument to the ``az aks nodepool add`` command.
1818
`Skip GPU driver installation (preview) <https://learn.microsoft.com/en-us/azure/aks/gpu-cluster?source=recommendations&tabs=add-ubuntu-gpu-node-pool#skip-gpu-driver-installation-preview>`__
1919
After you start your Azure AKS cluster with an image that includes a preinstalled NVIDIA GPU Driver
2020
Azure AKS <microsoft-aks.rst>
21+
.. |prod-name-short| replace:: MKE
22+
Mirantis Kubernetes Engine (MKE) gives you the power to build, run, and scale cloud-native
23+
* - MKE 3.6.2+ and 3.5.7+
24+
* A running MKE cluster with at least one control plane node and two worker nodes.
25+
* A seed node to connect to the MKE instance, with Helm 3.x installed on the seed node.
26+
* The kubeconfig file for the MKE cluster on the seed node.
27+
You can get the file from the MKE web interface by downloading a client bundle.
28+
Alternatively, if the MKE cluster is a managed cluster of a Mirantis Container Cloud (MCC) instance,
29+
In this case, the MKE web interface can be accessed from the MCC web interface.
30+
* You have an MKE administrator user name and password, and you have the MKE host URL.
31+
Perform the following steps to prepare the MKE cluster:
32+
#. MKE does not apply a label to worker nodes.
33+
$ export MKE_USERNAME=<mke-username> \
34+
MKE_PASSWORD=<mke-password> \
35+
MKE_HOST=<mke-fqdn-or-ip-address>
36+
#. Get an API key from MKE so that you can make API calls later:
37+
'{"username":"'$MKE_USERNAME'","password":"'$MKE_PASSWORD'"}' \
38+
https://$MKE_HOST/auth/login | jq --raw-output .auth_token)
39+
#. Download the MKE configuration file:
40+
$ curl --silent --insecure -X GET "https://$MKE_HOST/api/ucp/config-toml" \
41+
#. Upload the edited MKE configuration file:
42+
https://$MKE_HOST/api/ucp/config-toml
43+
The MKE cluster is ready for you to install the GPU Operator with Helm.
44+
Refer to the MKE product documentation for information about working with MKE.
45+
* https://docs.mirantis.com/mke/3.6/overview.html
46+
$ cat <<EOF > nvidia-container-microshift.te
47+
$ checkmodule -m -M -o nvidia-container-microshift.mod nvidia-container-microshift.te
48+
2023/06/22 14:25:38 Retreiving plugins.

.gitlab-ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ variables:
22
CONTAINER_TEST_IMAGE: "${CI_REGISTRY_IMAGE}:${CI_COMMIT_REF_SLUG}"
33
CONTAINER_RELEASE_IMAGE: "${CI_REGISTRY_IMAGE}:0.5.0"
44
BUILDER_IMAGE: ghcr.io/nvidia/cloud-native-docs:0.2.0
5-
PUBLISHER_IMAGE: "${CI_REGISTRY_PUBLISHER}/publisher:2.0.0"
5+
PUBLISHER_IMAGE: "${CI_REGISTRY_PUBLISHER}/publisher:3.1.0"
66

77
stages:
88
- .pre

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -108,25 +108,24 @@ Always update the openshift docset when there is a new gpu-operator docset versi
108108
copyright_start = 2020
109109
```
110110

111-
1. Update the version in `<component-name>/versions.json`:
111+
1. Update the version in `<component-name>/versions1.json`:
112112

113113
```diff
114-
diff --git a/container-toolkit/versions.json b/container-toolkit/versions.json
115-
index 334338a..b15af73 100644
116-
--- a/container-toolkit/versions.json
117-
+++ b/container-toolkit/versions.json
118-
@@ -1,7 +1,10 @@
119-
{
120-
- "latest": "1.13.1",
121-
+ "latest": "NEW_VERSION",
122-
"versions":
123-
[
124-
+ {
125-
+ "version": "NEW_VERSION"
126-
+ },
127-
{
128-
"version": "1.13.1"
129-
},
114+
diff --git a/container-toolkit/versions1.json b/container-toolkit/versions1.json
115+
index 95429953..e2738987 100644
116+
--- a/container-toolkit/versions1.json
117+
+++ b/container-toolkit/versions1.json
118+
@@ -1,6 +1,10 @@
119+
[
120+
{
121+
"preferred": "true",
122+
+ "url": "../1.17.4",
123+
+ "version": "1.17.4"
124+
+ },
125+
+ {
126+
"url": "../1.17.3",
127+
"version": "1.17.3"
128+
},
130129
```
131130

132131
These values control the menu at the bottom of the table of contents and
@@ -137,13 +136,13 @@ Always update the openshift docset when there is a new gpu-operator docset versi
137136
The documentation for the older releases is not removed, readers are just
138137
less likely to browse the older releases.
139138

140-
### Tagging and Special Branch Naming
139+
### Tagging for Publication
141140

142141
Changes to the default branch are not published on docs.nvidia.com.
143142

144-
Only tags or specially-named branches are published to docs.nvidia.com.
143+
Only tags are published to docs.nvidia.com.
145144

146-
1. Create a tag or specially-named branch from your commit with the following naming pattern: `<component-name>-v<version>`.
145+
1. Create a tag from your commit with the following naming pattern: `<component-name>-v<version>`.
147146

148147
*Example*
149148

@@ -152,13 +151,13 @@ Only tags or specially-named branches are published to docs.nvidia.com.
152151
```
153152

154153
The first three fields of the semantic version are used.
155-
For a "do over," push a tag like `gpu-operator-v23.3.1.1`.
154+
For a "do over," push a tag like `gpu-operator-v23.3.1-1`.
156155

157-
Always tag the openshift docset and driver-containers docset for each new gpu-operator docset release.
156+
Always tag the openshift docset and for each new gpu-operator docset release.
158157

159-
1. Push the tag or specially-named branch to the repository.
158+
1. Push the tag to the repository.
160159

161-
CI builds the documentation for the Git ref---currently for all software components.
160+
CI builds the documentation for the Git ref, for all software components.
162161
However, only the documentation for the `component-name` and specified version is updated on the web.
163162
By default, the documentation for the "latest" URL is updated.
164163

container-toolkit/cdi-support.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,6 @@
88

99
# Support for Container Device Interface
1010

11-
```{contents}
12-
---
13-
depth: 2
14-
local: true
15-
backlinks: none
16-
---
17-
```
18-
1911
## About the Container Device Interface
2012

2113
As of the `v1.12.0` release the NVIDIA Container Toolkit includes support for generating Container Device Interface (CDI) specifications.

container-toolkit/docker-specialized.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@
44

55
# Specialized Configurations with Docker
66

7-
```{contents}
8-
---
9-
depth: 2
10-
local: true
11-
backlinks: none
12-
---
13-
```
14-
157
## Environment variables (OCI spec)
168

179
Users can control the behavior of the NVIDIA container runtime using environment variables - especially for

container-toolkit/install-guide.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,6 @@
44

55
# Installing the NVIDIA Container Toolkit
66

7-
```{contents}
8-
---
9-
depth: 2
10-
local: true
11-
backlinks: none
12-
---
13-
```
14-
157
## Installation
168

179
(pre-requisites)=

container-toolkit/sample-workload.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
# Running a Sample Workload
22

3-
```{contents}
4-
---
5-
depth: 2
6-
local: true
7-
backlinks: none
8-
---
9-
```
10-
113
## Running a Sample Workload with Docker
124

135
After you install and configure the toolkit and install an NVIDIA GPU Driver,

container-toolkit/supported-platforms.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,6 @@
66

77
# Supported Platforms
88

9-
```{contents}
10-
---
11-
depth: 2
12-
local: true
13-
backlinks: none
14-
---
15-
```
169

1710
## Linux Distributions
1811

container-toolkit/troubleshooting.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,6 @@
66

77
# Troubleshooting
88

9-
```{contents}
10-
---
11-
depth: 2
12-
local: true
13-
backlinks: none
14-
---
15-
```
16-
179
## Troubleshooting with Docker
1810

1911
### Generating Debugging Logs
@@ -67,7 +59,7 @@ The conflicting repository references can be obtained by running and inspecting
6759
$ grep "nvidia.github.io" /etc/apt/sources.list.d/*
6860
```
6961

70-
The list of files with (possibly) conflicting references can be optained by running:
62+
The list of files with possibly conflicting references can be obtained by running:
7163

7264
```console
7365
$ grep -l "nvidia.github.io" /etc/apt/sources.list.d/* | grep -vE "/nvidia-container-toolkit.list\$"
@@ -105,7 +97,7 @@ allow this access for now by executing:
10597

10698
This occurs because `nvidia-docker` forwards the command line arguments with minor modifications to the `docker` executable.
10799

108-
To address this it is recommeded that the `docker` command be used directly specifying the `nvidia` runtime:
100+
To address this, specify the NVIDIA runtime in the the `docker` command:
109101

110102
```console
111103
$ sudo docker run --gpus=all --runtime=nvidia --rm nvcr.io/nvidia/cuda:11.6.2-base-ubuntu20.04 nvidia-smi

container-toolkit/versions.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,6 @@
2525
},
2626
{
2727
"version": "1.16.0"
28-
},
28+
}
2929
]
3030
}

0 commit comments

Comments
 (0)