Developer Guide

Developer Guide#

This guide provides information for developers who want to contribute to or modify the AMD GPU Operator.

Prerequisites#

  • Go v1.20 (due to open issues with Go v1.21 or v1.22)

  • Docker

  • Kubernetes cluster (v1.29.0+) or OpenShift (4.16+)

  • kubectl or oc CLI tool configured to access your cluster

  • Access to rocm/gpu-kernel-module-manager image (available on Docker Hub)

Development Environment Setup#

  • Install Helm:

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

For alternative installation methods, refer to the Helm Official Website.

  • Install Helmify:

  • Clone the repository:

git clone https://github.com/ROCm/gpu-operator.git
cd gpu-operator

  • (Optional) Set up a local Docker registry. If you want to build and host container images locally, you can set up a local Docker registry:

docker run -d -p 5000:5000 --name registry registry:latest

  • Modify the registry-related variables in the Makefile:

    • DOCKER_REGISTRY: Set to localhost:5000 for local development, or your preferred registry

    • IMAGE_NAME: Set to rocm/gpu-operator

    • IMAGE_TAG: Set as needed (e.g., v1.0.0 or latest)

  • Compile the project:

make

This will generate the basic YAML files for CRD and build controller images.

  • Build and push the AMD GPU Operator image:

make docker-build
make docker-push

Note: If you’re using a remote registry that requires authentication, ensure you’ve logged in using docker login before pushing.

  • Generate Helm charts:

    • For vanilla Kubernetes: make helm

    • For OpenShift: OPENSHIFT=1 make helm

Running Tests#

To run the e2e tests:

make e2e

To run e2e tests with a specific Helm chart:

make e2e GPU_OPERATOR_CHART="path to helm chart"

To run e2e test only:

make -C tests/e2e # run e2e tests only

Creating a Pull Request#

  1. Fork the repository on GitHub.

  2. Create a new branch for your changes.

  3. Make your changes and commit them with clear, descriptive commit messages.

  4. Push your changes to your fork.

  5. Create a pull request against the main repository.

Please ensure your code follows our coding standards and includes appropriate tests.

Build Documentation Website Locally#

  • Download mkdocs utilities

python3 -m pip install mkdocs

  • Build the website

cd docs
python3 -m mkdocs build

  • Deploy the website

python3 -m mkdocs serve --dev-addr localhost:2345

  • The local docs website will dynmically update as changes are made to markdown docs.