Skip to content

Update README.md #1890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
francisguillier wants to merge 1 commit into from
Closed

Update README.md #1890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 2 additions & 8 deletions .github/workflows/stale.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Stale issues and pull requests
name: Stale issues

on:
workflow_dispatch:
Expand All @@ -10,22 +10,16 @@ jobs:
permissions:
actions: write
issues: write
pull-requests: write
runs-on: ubuntu-latest

steps:
- uses: actions/stale@v10
with:
stale-issue-message: 'This issue is stale because it has been open 90 days with no activity. This issue will be closed in 30 days unless new comments are made or the stale label is removed. To skip these checks, apply the "lifecycle/frozen" label.'
stale-pr-message: 'This PR is stale because it has been open 90 days with no activity. This PR will be closed in 30 days unless new comments are made or the stale label is removed. To skip these checks, apply the "lifecycle/frozen" label.'
stale-issue-label: 'lifecycle/stale'
stale-pr-label: 'lifecycle/stale'
exempt-issue-labels: 'lifecycle/frozen'
exempt-pr-labels: 'lifecycle/frozen'
exempt-issue-labels: 'lifecycle/frozen,feature,enhancement'
days-before-stale: 90
close-issue-message: 'This issue was automatically closed due to inactivity.'
close-pr-message: 'This pull request was automatically closed due to inactivity.'
days-before-issue-close: 30
days-before-pr-close: 30
remove-stale-when-updated: true
operations-per-run: 1000
40 changes: 40 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,46 @@ To deploy the GPU Operator on OpenShift, follow the instructions in the [officia
## Product Documentation
For information on platform support and getting started, visit the official documentation [repository](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/overview.html).

## Quick Start

Make sure your k8s cluster meets the pre-requisites as listed in the platform support page:
Copy link
Contributor

@tariq1890 tariq1890 Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Make sure your k8s cluster meets the pre-requisites as listed in the platform support page:
Make sure your Kubernetes cluster meets the pre-requisites as listed in the platform support page:


https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/platform-support.html

Copy link
Collaborator

@ArangoGutierrez ArangoGutierrez Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change


Step1: Install Helm locally:
Copy link
Contributor

@tariq1890 tariq1890 Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Step1: Install Helm locally:
Step 1: Install Helm locally:

```
Comment on lines +56 to +57
Copy link
Collaborator

@ArangoGutierrez ArangoGutierrez Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Step1: Install Helm locally:
```
Step1: Install Helm locally:
```bash

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 \
&& chmod 700 get_helm.sh \
&& ./get_helm.sh
```


Step2: Deploy GPU operator:
Copy link
Contributor

@tariq1890 tariq1890 Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Step2: Deploy GPU operator:
Step 2: Deploy GPU operator:

```
Comment on lines +64 to +65
Copy link
Collaborator

@ArangoGutierrez ArangoGutierrez Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Step2: Deploy GPU operator:
```
Step2: Deploy GPU operator:
```bash

helm install --wait --generate-name \
-n gpu-operator --create-namespace \
nvidia/gpu-operator \
--version=v25.10.0
Copy link
Contributor

@tariq1890 tariq1890 Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this is a quick start guide, I'd prefer dropping the version flag here.

Let's also add the helm repo commands before helm install command

helm repo add nvidia https://helm.ngc.nvidia.com/nvidia \
    && helm repo update

```

That's all.

GPU Operator and its operands should be up and running as shown below:
```
Comment on lines +74 to +75
Copy link
Collaborator

@ArangoGutierrez ArangoGutierrez Nov 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
GPU Operator and its operands should be up and running as shown below:
```
GPU Operator and its operands should be up and running as shown below:
```bash

gpu-operator gpu-feature-discovery-98x9m 1/1 Running 0 22h
gpu-operator gpu-operator-1762903711-node-feature-discovery-gc-5c458899bbwpk 1/1 Running 0 22h
gpu-operator gpu-operator-1762903711-node-feature-discovery-master-856b8tvqs 1/1 Running 0 22h
gpu-operator gpu-operator-1762903711-node-feature-discovery-worker-m5jdr 1/1 Running 0 22h
gpu-operator gpu-operator-5b685fc9c9-wntlj 1/1 Running 0 22h
gpu-operator nvidia-container-toolkit-daemonset-c7c6f 1/1 Running 0 22h
gpu-operator nvidia-cuda-validator-zt45l 0/1 Completed 0 22h
gpu-operator nvidia-dcgm-exporter-px9hw 1/1 Running 0 22h
gpu-operator nvidia-device-plugin-daemonset-cd4hp 1/1 Running 0 22h
gpu-operator nvidia-driver-daemonset-xkqnp 1/1 Running 0 22h
gpu-operator nvidia-mig-manager-jrthj 1/1 Running 0 22h
gpu-operator nvidia-operator-validator-5kq7z 1/1 Running 0 22h
```

## Roadmap

Expand Down