Makefile

# To generate docs with make targets
# from this repo base directory,
# set the following environment variables
# to match your environment and release version
#
# K8S_WEBROOT=~/src/github.com/kubernetes/website
# K8S_ROOT=~/path/to/your/kubernetes/clone (REQUIRED)
# K8S_RELEASE=1.17.0, 1.17.5, 1.17.0-rc.2
#
# PREFERRED directory structure (follows Go workspace conventions):
#   <work dir>/k8s.io/kubernetes     <- Set K8S_ROOT to this path
#   <work dir>/k8s.io/website
#   <work dir>/k8s.io/reference-docs
#
# Examples:
#   export K8S_ROOT=~/go/src/k8s.io/kubernetes
#   export K8S_ROOT=~/workspace/k8s.io/kubernetes
#   export K8S_ROOT=~/dev/kubernetes  # any valid path works


WEBROOT=${K8S_WEBROOT}
K8SROOT=${K8S_ROOT}
K8SRELEASE=${K8S_RELEASE}

K8SRELEASE_PREFIX=$(shell echo "$(K8SRELEASE)" | cut -c 1-4)

# create a directory name from release string, e.g. 1.17 -> 1_17
K8SRELEASEDIR=$(shell echo "$(K8SRELEASE_PREFIX)" | sed "s/\./_/g")

# Per-target guards. Recipes that need a specific env var add the matching
# guard as a dependency rather than failing the whole Makefile at parse time.
require-k8sroot:
	@if [ -z "$(K8SROOT)" ]; then \
		echo "K8S_ROOT not set. Example: export K8S_ROOT=~/go/src/k8s.io/kubernetes"; exit 1; \
	fi
	@if [ ! -f "$(K8SROOT)/go.mod" ]; then \
		echo "K8S_ROOT ($(K8SROOT)) is not a Kubernetes clone (no go.mod)."; exit 1; \
	fi

require-k8srelease:
	@if [ -z "$(K8SRELEASE)" ]; then \
		echo "K8S_RELEASE not set. Example: export K8S_RELEASE=1.36.0"; exit 1; \
	fi

require-webroot:
	@if [ -z "$(WEBROOT)" ]; then \
		echo "K8S_WEBROOT not set. Example: export K8S_WEBROOT=~/src/k8s.io/website"; exit 1; \
	fi

CLISRC=gen-kubectldocs/generators/build
CLIDST=$(WEBROOT)/static/docs/reference/generated/kubectl
CLISRCFONT=$(CLISRC)/node_modules/font-awesome
CLIDSTFONT=$(CLIDST)/node_modules/font-awesome

all:
	@echo "Supported targets:"
	@echo "  Build:    api apimd cli comp configapi"
	@echo "  Copy:     copyapi copyapimd copycli copycomp copyconfigapi"
	@echo "  Setup:    createversiondirs updateapispec"
	@echo "  Clean:    cleanapi cleanapimd cleancli cleancomp"
	@echo "  Other:    genresources (deprecated)"

# create directories for new release
createversiondirs: require-k8srelease
	@echo "Calling set_version_dirs.sh"
	./set_version_dirs.sh
	@echo "K8S Release dir: $(K8SRELEASEDIR)"

# Build kubectl docs
cleancli:
	@echo "WARNING: gen-kubectl is deprecated; use gen-compdocs kubectl instead."
	sudo rm -f main
	sudo rm -rf $(shell pwd)/gen-kubectldocs/generators/includes
	sudo rm -rf $(shell pwd)/gen-kubectldocs/generators/build
	sudo rm -rf $(shell pwd)/gen-kubectldocs/generators/manifest.json

cli: require-k8srelease cleancli
	@echo "WARNING: gen-kubectl is deprecated; use gen-compdocs kubectl instead."
	cd gen-kubectldocs && go mod download && go run main.go --kubernetes-version v$(K8SRELEASEDIR)
	mkdir -p $(CLISRC)
	docker run -v $(shell pwd)/gen-kubectldocs/generators/includes:/source -v $(shell pwd)/gen-kubectldocs/generators/build:/build -v $(shell pwd)/gen-kubectldocs/generators/:/manifest brianpursley/brodocs:latest

copycli: require-webroot cli
	@echo "WARNING: gen-kubectl is deprecated; use gen-compdocs kubectl instead."
	cp gen-kubectldocs/generators/build/index.html $(WEBROOT)/static/docs/reference/generated/kubectl/kubectl-commands.html
	cp gen-kubectldocs/generators/build/navData.js $(WEBROOT)/static/docs/reference/generated/kubectl/navData.js
	cp $(CLISRC)/scroll.js $(CLIDST)/scroll.js
	cp $(CLISRC)/stylesheet.css $(CLIDST)/stylesheet.css
	cp $(CLISRC)/tabvisibility.js $(CLIDST)/tabvisibility.js
	cp $(CLISRC)/node_modules/bootstrap/dist/css/bootstrap.min.css $(CLIDST)/node_modules/bootstrap/dist/css/bootstrap.min.css
	cp $(CLISRC)/node_modules/highlight.js/styles/default.css $(CLIDST)/node_modules/highlight.js/styles/default.css
	cp $(CLISRC)/node_modules/jquery.scrollto/jquery.scrollTo.min.js $(CLIDST)/node_modules/jquery.scrollto/jquery.scrollTo.min.js
	cp $(CLISRC)/node_modules/jquery/dist/jquery.min.js $(CLIDST)/node_modules/jquery/dist/jquery.min.js
	cp $(CLISRCFONT)/css/font-awesome.min.css $(CLIDSTFONT)/css/font-awesome.min.css
	cp -r $(CLISRCFONT)/fonts $(CLIDSTFONT)

# Build kube component,tool docs
cleancomp:
	rm -rf $(shell pwd)/gen-compdocs/build

comp: cleancomp
	make -C gen-compdocs

# Copy component docs into k/website. The destinations
# contain curated _index.md (and README.md for kubeadm) plus unrelated
# subdirs (feature-gates*), so we don't rm -rf — we overlay on top.
COMPSRC=gen-compdocs/build
COMPCOREDST=$(WEBROOT)/content/en/docs/reference/command-line-tools-reference
COMPKUBEADMDST=$(WEBROOT)/content/en/docs/reference/setup-tools/kubeadm/generated
COMPKUBECTLDST=$(WEBROOT)/content/en/docs/reference/kubectl/generated

# Copy core component docs (kube-apiserver, controller-manager, scheduler, proxy, kubelet)
copycomp-core: require-webroot comp
	cp $(COMPSRC)/kube-apiserver.md $(COMPCOREDST)/
	cp $(COMPSRC)/kube-controller-manager.md $(COMPCOREDST)/
	cp $(COMPSRC)/kube-scheduler.md $(COMPCOREDST)/
	cp $(COMPSRC)/kube-proxy.md $(COMPCOREDST)/
	cp $(COMPSRC)/kubelet.md $(COMPCOREDST)/

# Copy kubeadm command docs (overlay; destination has hand-curated _index.md, README.md)
copycomp-kubeadm: require-webroot comp
	cp $(COMPSRC)/kubeadm.md $(COMPKUBEADMDST)/
	for d in $(COMPSRC)/kubeadm_*; do cp -r "$$d" $(COMPKUBEADMDST)/; done

# Copy kubectl command docs (overlay; destination has hand-curated _index.md)
copycomp-kubectl: require-webroot comp
	cp $(COMPSRC)/kubectl.md $(COMPKUBECTLDST)/
	for d in $(COMPSRC)/kubectl_*; do cp -r "$$d" $(COMPKUBECTLDST)/; done

# Run all three copycomp-* targets
copycomp: copycomp-core copycomp-kubeadm copycomp-kubectl

# Build API docs
APISRC=gen-apidocs
APIDST=$(WEBROOT)/static/docs/reference/generated/kubernetes-api/v$(K8SRELEASE_PREFIX)

updateapispec: require-k8sroot require-k8srelease createversiondirs
	@echo "Updating swagger.json for release v$(K8SRELEASE)"
	cd $(K8SROOT) && git show "v$(K8SRELEASE):api/openapi-spec/swagger.json" > $(CURDIR)/$(APISRC)/config/v$(K8SRELEASEDIR)/swagger.json

api: require-k8srelease cleanapi
	cd $(APISRC) && go run main.go --kubernetes-release=$(K8SRELEASE_PREFIX) --work-dir=. --auto-detect

# Build API docs as markdown (Hugo-compatible output in gen-apidocs/build/markdown/).
# Output is intended to replace gen-resourcesdocs once parity is reached.
apimd: require-k8srelease cleanapimd
	cd $(APISRC) && go run main.go --kubernetes-release=$(K8SRELEASE_PREFIX) --work-dir=. --auto-detect --backend=markdown

cleanapi:
	rm -rf $(shell pwd)/gen-apidocs/build/html
	rm -rf $(shell pwd)/gen-apidocs/build/includes
	rm -f $(shell pwd)/gen-apidocs/build/index.html
	rm -f $(shell pwd)/gen-apidocs/build/navData.js

cleanapimd:
	rm -rf $(shell pwd)/gen-apidocs/build/markdown

copyapi: require-webroot api
	mkdir -p $(APIDST)
	cp $(APISRC)/build/html/index.html $(APIDST)/index.html
	# copy the new navData.js
	mkdir -p $(APIDST)/js
	cp $(APISRC)/build/html/navData.js $(APIDST)/js/

# Copy the markdown API reference into k/website. The top-level
# _index.md is hand-curated (glossary shortcode, card metadata) and
# preserved across regenerations.
APIMDSRC=$(APISRC)/build/markdown
APIMDDST=$(WEBROOT)/content/en/docs/reference/kubernetes-api

copyapimd: require-webroot apimd
	@if [ -f $(APIMDDST)/_index.md ]; then cp $(APIMDDST)/_index.md /tmp/kubernetes-api-index.md; fi
	rm -rf $(APIMDDST)
	mkdir -p $(APIMDDST)
	cp -r $(APIMDSRC)/. $(APIMDDST)/
	@if [ -f /tmp/kubernetes-api-index.md ]; then cp /tmp/kubernetes-api-index.md $(APIMDDST)/_index.md; fi

# Build resource reference
genresources:
	@echo "WARNING: gen-resourcesdocs is deprecated; use make apimd instead."
	make -C gen-resourcesdocs kwebsite

# Build config API reference
CONFIGSRC=genref/output/md
CONFIGDST=$(WEBROOT)/content/en/docs/reference/config-api/
configapi:
	make -C genref

copyconfigapi: require-webroot configapi
	cp $(CONFIGSRC)/*.md $(CONFIGDST)/