Skip to content

[CP 775][Build] Add sanity to check docs build #241

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.

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

Open
wants to merge 1 commit into
base: staging
Choose a base branch
from
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
4 changes: 4 additions & 0 deletions Dockerfile.build
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ RUN apt-get update -y && \
curl \
gosu \
gpg \
make \
python3-sphinx \
python3-pip \
libsqlite3-dev \
protobuf-compiler \
locales \
ca-certificates \
Expand Down
20 changes: 20 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ PROJECT_VERSION ?= v1.2.0
# GPU Operator Image Build variables
# Note: when using images from DockerHub, please make sure to input the full DockerHub registry URL (docker.io) into DOCKER_REGISTRY
# user's container runtime may not set DockerHub as default registry and auto-search on DockerHub
TOP_DIR = $(PWD)
GOFLAGS := "-mod=mod"
GIT_COMMIT ?= $(shell git rev-parse --short HEAD)
DOCKER_REGISTRY ?= docker.io/rocm
Expand Down Expand Up @@ -116,6 +117,12 @@ CONTAINER_WORKDIR := /gpu-operator
BUILD_BASE_IMG ?= ubuntu:22.04
GOLANG_BASE_IMG ?= golang:1.23

##################
# Documentation website build variables
DOCS_DIR := ${TOP_DIR}/docs
BUILD_DIR := $(DOCS_DIR)/_build
HTML_DIR := $(BUILD_DIR)/html

##################
# Makefile targets

Expand Down Expand Up @@ -372,6 +379,19 @@ bundle-build: operator-sdk manifests kustomize ## OpenShift Build OLM bundle.
${OPERATOR_SDK} bundle validate ./bundle
docker build -f bundle.Dockerfile -t $(BUNDLE_IMG) .

.PHONY: dep-docs
dep-docs:
pip install -r $(DOCS_DIR)/sphinx/requirements.txt

.PHONY: docs
docs: dep-docs ## Build documentation website
sphinx-build -b html $(DOCS_DIR) $(HTML_DIR)
@echo "Docs built at $(HTML_DIR)/index.html"

.PHONY: clean-docs
clean-docs: ## Clean up documentation website build cache
rm -rf $(BUILD_DIR)

##@ Deployment

ifndef ignore-not-found
Expand Down
4 changes: 2 additions & 2 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,13 @@ kubectl logs -n kube-amd-gpu <pod-name>

## Potential Issues with default ``DeviceConfig``

* Please refer to [Typical Deployment Scenarios](../usage.html#typical-deployment-scenarios) for more information and get corresponding ```helm install``` commands and configs that fits your specific use case.
* Please refer to {ref}`typical-deployment-scenarios` for more information and get corresponding ```helm install``` commands and configs that fits your specific use case.

* If operand pods (e.g. device plugin, metrics exporter) are stuck in ``Init:0/1`` state, it means your GPU worker doesn't have GPU driver loaded or driver was not loaded properly.

* If you try to use inbox or pre-installed driver please check the node ``dmesg`` to see why the driver was not loaded properly.

* If you want to deploy out-of-tree driver, we suggest check the `Driver Installation Guide <./drivers/installation.html>`_ then modify the default ``DeviceConfig`` to ask Operator to install the out-of-tree GPU driver for your worker nodes.
* If you want to deploy out-of-tree driver, we suggest check the [Driver Installation Guide](./drivers/installation) then modify the default ``DeviceConfig`` to ask Operator to install the out-of-tree GPU driver for your worker nodes.

```bash
kubectl edit deviceconfigs -n kube-amd-gpu default
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Quick Start Guide

Getting up and running with the AMD GPU Operator and Device Metrics Exporter on Kubernetes is quick and easy. Below is a short guide on how to get started using the helm installation method on a standard Kubernetes install. Note that more detailed instructions on the different installation methods can be found on this site:

`GPU Operator Kubernetes Helm Install <../installation/kubernetes-helm.html>`_
`GPU Operator Kubernetes Helm Install <./installation/kubernetes-helm.html>`_

`GPU Operator Red Hat OpenShift Install <../installation/openshift-olm.html>`_
`GPU Operator Red Hat OpenShift Install <./installation/openshift-olm.html>`_

Installing the GPU Operator
---------------------------
Expand Down
Loading