Development

Mon, 01 Jan 0001 00:00:00 +0000

Tooling: Go (version per 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).

Contribute to Docs

Mon, 01 Jan 0001 00:00:00 +0000

The site lives in site/ and is built with Hugo (the extended build) and the Docsy theme.

Quick start

You need Hugo (extended), Go, Node.js (which provides npm), and Git installed. The versions on your machine should meed the minium required versions listed in netlify.toml.

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/:

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`
Minimum Hugo version enforced locally, plus all site configuration	`site/hugo.toml`
Docsy theme version this site pins	`site/go.mod`
npm scripts and PostCSS dependencies	`site/package.json`
How to install Hugo on any OS (use the extended build)	Hugo installation docs
Docsy theme prerequisites, configuration, and authoring guide	Docsy documentation

Contribute on DRA Driver for NVIDIA GPUs

Development

Make targets

Contribute to Docs

Quick start

Where to look for more details