Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions mkdocs.yml

This file was deleted.

17 changes: 15 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
[build]
publish = "site"
command = "pip install mkdocs && mkdocs build"
base = "site"
publish = "public"
command = "npm ci && hugo --gc --minify"

[build.environment]
HUGO_VERSION = "0.157.0"
GO_VERSION = "1.25.0"
NODE_VERSION = "20"
GIT_DEPTH = "0"

[context.deploy-preview]
command = "npm ci && hugo --gc --minify --buildDrafts --buildFuture --baseURL $DEPLOY_PRIME_URL"

[context.branch-deploy]
command = "npm ci && hugo --gc --minify --buildDrafts --buildFuture --baseURL $DEPLOY_PRIME_URL"
10 changes: 10 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Hugo build output
public/
resources/
.hugo_build.lock

# npm
node_modules/

# Local Netlify CLI state
.netlify/
1 change: 1 addition & 0 deletions site/assets/icons/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 23 additions & 0 deletions site/assets/scss/_variables_project.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// Kubernetes brand palette overrides for Docsy.
// SIG-affiliated project — no NVIDIA branding.
// See https://kubernetes.io/community/ for visual identity references.

$primary: #326ce5; // Kubernetes blue
$secondary: #6c757d;
$info: #1d63ed;
$success: #2ecc71;
$warning: #f1c40f;
$danger: #e74c3c;
$dark: #2c3e50;
$light: #ecf0f1;

$enable-gradients: false;
$enable-shadows: true;

// Tweak Docsy defaults toward a flatter, k8s-style look
$navbar-bg-color: $primary;
$footer-bg-color: $dark;

$td-enable-google-fonts: true;
$google_font_name: "Open Sans";
$google_font_family: "Open+Sans:300,300i,400,400i,700,700i";
14 changes: 14 additions & 0 deletions site/content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: DRA Driver for NVIDIA GPUs
description: A Kubernetes DRA driver for NVIDIA GPUs, MIG, VFIO, and Multi-Node NVLink.
aliases:
- /home/
sitemap:
disable: true
outputs:
- HTML
---

<meta http-equiv="refresh" content="0; url=/docs/">

Redirecting to [Docs](/docs/)…
21 changes: 21 additions & 0 deletions site/content/contribute/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: Contribute
linkTitle: Contribute
weight: 60
description: Build, test, and propose changes to the driver.
cascade:
type: docs
---

The DRA driver is a Kubernetes SIG Node project. Contributions go through
GitHub PRs and follow the upstream Kubernetes contribution model.

- [Development](/contribute/development/) — local build, test, and cluster
loop.
- [Documentation site](/contribute/site/) — build and preview this site
locally; how it gets deployed.
- [Proposals](/contribute/proposals/) — when and how to file a design
proposal before writing code.

For repo-level contribution rules, see
[CONTRIBUTING.md](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/CONTRIBUTING.md).
44 changes: 44 additions & 0 deletions site/content/contribute/development.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: Development
linkTitle: Development
weight: 10
description: Build, test, and the local-cluster iteration loop.
---

**Tooling:** Go (version per [`go.mod`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/go.mod)), Docker + Buildx, Helm v3, kind, golangci-lint. Codegen tools are installed by `make -C deployments/devel install-tools`.

## Make targets

```
make build # go build ./...
make cmds # build the five binaries in cmd/
make test # race-enabled unit tests
make generate # CRDs, deepcopy, clientset, listers, informers
make check # golangci-lint + check-generate (the CI gate)
make helm-lint # lint the Helm chart
make bats # BATS integration tests (needs a live cluster)
```

Prefix any target with `docker-` to run it in the devel container (requires `BUILD_DEVEL_IMAGE=yes`).

## Local cluster

```sh
export KIND_CLUSTER_NAME=kind-dra-1
./demo/clusters/kind/build-dra-driver-gpu.sh # build & load driver image
./demo/clusters/kind/create-cluster.sh # create the cluster
./demo/clusters/kind/install-dra-driver-gpu.sh # helm install
```

Iterate: edit → rerun the build script → rerun the install script.

GPU-aware variant: [`demo/clusters/nvkind/`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/tree/main/demo/clusters/nvkind). GKE recipes: [`demo/clusters/gke/`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/tree/main/demo/clusters/gke).

## Tests

- **Unit**: `make test`.
- **BATS**: [`tests/bats/`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/tree/main/tests/bats) — invasive, runs against a real cluster. Read [`tests/bats/README.md`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/tests/bats/README.md) first.

## CI

GitHub Actions in [`.github/workflows/`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/tree/main/.github/workflows) run lint, codegen check, unit tests, build, chart lint, and CodeQL. End-to-end GPU tests run on Prow / Lambda Cloud — see [`hack/ci/lambda/e2e-test.sh`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/hack/ci/lambda/e2e-test.sh).
42 changes: 42 additions & 0 deletions site/content/contribute/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Contribute to Docs
linkTitle: Docs
weight: 15
description: Build and preview this site locally.
---

The site lives in
[`site/`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/tree/main/site)
and is built with [Hugo](https://gohugo.io/) (the extended build) and the
[Docsy](https://www.docsy.dev/) theme.

## Quick start

You need [Hugo (extended)](https://gohugo.io/installation/),
[Go](https://go.dev/doc/install), [Node.js](https://nodejs.org/) (which
provides `npm`), and [Git](https://git-scm.com/downloads) installed. The versions on your machine should meed the minium required versions listed in
[`netlify.toml`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/netlify.toml).

```bash
git clone https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu.git
cd dra-driver-nvidia-gpu/site
npm ci # one-time; installs PostCSS deps from package-lock.json
npm run serve # http://localhost:1313, live-reload, drafts visible
```

To produce the same output Netlify builds for production, from `site/`:

```bash
npm run build # output written to ./public
```

## Where to look for more details

| If you need to know… | Look at |
| --- | --- |
| Exact Hugo / Go / Node versions used for production builds | [`netlify.toml`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/netlify.toml) |
| Minimum Hugo version enforced locally, plus all site configuration | [`site/hugo.toml`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/site/hugo.toml) |
| Docsy theme version this site pins | [`site/go.mod`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/site/go.mod) |
| npm scripts and PostCSS dependencies | [`site/package.json`](https://github.com/kubernetes-sigs/dra-driver-nvidia-gpu/blob/main/site/package.json) |
| How to install Hugo on any OS (use the extended build) | [Hugo installation docs](https://gohugo.io/installation/) |
| Docsy theme prerequisites, configuration, and authoring guide | [Docsy documentation](https://www.docsy.dev/docs/) |
Loading