diff --git a/Makefile b/Makefile index fa8082056760..7de6d5058b96 100644 --- a/Makefile +++ b/Makefile @@ -59,6 +59,7 @@ BIN_DIR := bin TEST_DIR := test TOOLS_DIR := hack/tools TOOLS_BIN_DIR := $(abspath $(TOOLS_DIR)/$(BIN_DIR)) +DOCS_DIR := docs E2E_FRAMEWORK_DIR := $(TEST_DIR)/framework CAPD_DIR := $(TEST_DIR)/infrastructure/docker TEST_EXTENSION_DIR := $(TEST_DIR)/extension @@ -153,6 +154,8 @@ YQ_BIN := yq YQ := $(abspath $(TOOLS_BIN_DIR)/$(YQ_BIN)-$(YQ_VER)) YQ_PKG := github.com/mikefarah/yq/v4 +PLANTUML_VER := 1.2023 + GINKGO_BIN := ginkgo GINGKO_VER := $(call get_go_version,github.com/onsi/ginkgo/v2) GINKGO := $(abspath $(TOOLS_BIN_DIR)/$(GINKGO_BIN)-$(GINGKO_VER)) @@ -544,7 +547,16 @@ generate-metrics-config: $(ENVSUBST_BIN) ## Generate ./hack/observability/kube-s .PHONY: generate-diagrams generate-diagrams: ## Generate diagrams for *.plantuml files - $(MAKE) -C docs diagrams + $(MAKE) generate-diagrams-book + $(MAKE) generate-diagrams-proposals + +.PHONY: generate-diagrams-book +generate-diagrams-book: ## Generate diagrams for *.plantuml files in book + docker run -v $(ROOT_DIR)/$(DOCS_DIR):/$(DOCS_DIR)$(DOCKER_VOL_OPTS) plantuml/plantuml:$(PLANTUML_VER) /$(DOCS_DIR)/book/**/*.plantuml + +.PHONY: generate-diagrams-proposals +generate-diagrams-proposals: ## Generate diagrams for *.plantuml files in proposals + docker run -v $(ROOT_DIR)/$(DOCS_DIR):/$(DOCS_DIR)$(DOCKER_VOL_OPTS) plantuml/plantuml:$(PLANTUML_VER) /$(DOCS_DIR)/proposals/**/*.plantuml ## -------------------------------------- ## Lint / Verify diff --git a/docs/Dockerfile b/docs/Dockerfile deleted file mode 100644 index a606e65866d3..000000000000 --- a/docs/Dockerfile +++ /dev/null @@ -1,25 +0,0 @@ -# syntax=docker/dockerfile:1.4 - -# Copyright 2019 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# To generate diagrams run 'make diagrams' in the docs/ folder. -FROM maven:3-jdk-8 - -RUN apt-get update && apt-get install -y --no-install-recommends graphviz=2.42.2-5 fonts-symbola=2.60-1.1 fonts-wqy-zenhei=0.9.45-8 && rm -rf /var/lib/apt/lists/* -RUN wget -nv -O /plantuml.jar https://github.com/plantuml/plantuml/releases/download/v1.2022.6/plantuml-1.2022.6.jar - -# By default, java writes a 'hsperfdata_' directory in the work dir. -# This directory is not needed; to ensure it is not written, we set `-XX:-UsePerfData` -ENTRYPOINT [ "java", "-XX:-UsePerfData", "-jar", "/plantuml.jar" ] diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 16985daf1205..000000000000 --- a/docs/Makefile +++ /dev/null @@ -1,50 +0,0 @@ -# Copyright 2019 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -SHELL:=/usr/bin/env bash - -.DEFAULT_GOAL:=help - -DIAGRAM_SRCS := $(call rwildcard,.,*.md,*.plantuml) - -# Hosts running SELinux need :z added to volume mounts -SELINUX_ENABLED := $(shell cat /sys/fs/selinux/enforce 2> /dev/null || echo 0) - -ifeq ($(SELINUX_ENABLED),1) - DOCKER_VOL_OPTS?=:z -endif - -##@ PlantUML diagrams - -.PHONY: diagrams -diagrams: plantuml-builder diagrams-book diagrams-proposals ## Make all diagrams - -.PHONY: diagrams-book -diagrams-book: plantuml-builder ## Make all book diagrams - -docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder /docs/book/**/*.md - -docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder /docs/book/**/*.plantuml - -.PHONY: diagrams-proposals -diagrams-proposals: plantuml-builder ## Make all proposals diagrams - -docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder /docs/proposals/**/*.md - -docker run -u $(UID):$(GID) -v $(abspath .):/docs$(DOCKER_VOL_OPTS) plantuml-builder /docs/proposals/**/*.plantuml - -.PHONY: plantuml-builder -plantuml-builder: Dockerfile ## Make diagram build container - docker build -f Dockerfile -t "plantuml-builder" . - -##@ general - -help: ## Display this help - @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) diff --git a/docs/book/src/images/bootstrap-controller.png b/docs/book/src/images/bootstrap-controller.png index de7dbd11c0e1..21db2d26587c 100644 Binary files a/docs/book/src/images/bootstrap-controller.png and b/docs/book/src/images/bootstrap-controller.png differ diff --git a/docs/book/src/images/bootstrap-provider.png b/docs/book/src/images/bootstrap-provider.png index c7eff2d583bb..1a58524bfced 100644 Binary files a/docs/book/src/images/bootstrap-provider.png and b/docs/book/src/images/bootstrap-provider.png differ diff --git a/docs/book/src/images/cluster-admission-cluster-controller.png b/docs/book/src/images/cluster-admission-cluster-controller.png index 4678779b73da..8a08df94be4e 100644 Binary files a/docs/book/src/images/cluster-admission-cluster-controller.png and b/docs/book/src/images/cluster-admission-cluster-controller.png differ diff --git a/docs/book/src/images/cluster-admission-machine-controller.png b/docs/book/src/images/cluster-admission-machine-controller.png index 4952fe2187fe..5f9c9b520792 100644 Binary files a/docs/book/src/images/cluster-admission-machine-controller.png and b/docs/book/src/images/cluster-admission-machine-controller.png differ diff --git a/docs/book/src/images/cluster-admission-machinedeployment-controller.png b/docs/book/src/images/cluster-admission-machinedeployment-controller.png index 6d6824f805c1..5e2a9fe01f57 100644 Binary files a/docs/book/src/images/cluster-admission-machinedeployment-controller.png and b/docs/book/src/images/cluster-admission-machinedeployment-controller.png differ diff --git a/docs/book/src/images/cluster-admission-machinepool-controller.png b/docs/book/src/images/cluster-admission-machinepool-controller.png index b2f347f501d9..8c7b582dc6e1 100644 Binary files a/docs/book/src/images/cluster-admission-machinepool-controller.png and b/docs/book/src/images/cluster-admission-machinepool-controller.png differ diff --git a/docs/book/src/images/cluster-admission-machineset-controller.png b/docs/book/src/images/cluster-admission-machineset-controller.png index 1d4bd6899761..e9ea358c154e 100644 Binary files a/docs/book/src/images/cluster-admission-machineset-controller.png and b/docs/book/src/images/cluster-admission-machineset-controller.png differ diff --git a/docs/book/src/images/cluster-infra-provider.png b/docs/book/src/images/cluster-infra-provider.png index d8bbca0ca5e7..fc58b3dff732 100644 Binary files a/docs/book/src/images/cluster-infra-provider.png and b/docs/book/src/images/cluster-infra-provider.png differ diff --git a/docs/book/src/images/cluster-resource-set-controller.png b/docs/book/src/images/cluster-resource-set-controller.png index fa456a18010e..57716645eb59 100644 Binary files a/docs/book/src/images/cluster-resource-set-controller.png and b/docs/book/src/images/cluster-resource-set-controller.png differ diff --git a/docs/book/src/images/cluster-topology-controller.png b/docs/book/src/images/cluster-topology-controller.png index 93e2eedd2e37..e8015a62c2ca 100644 Binary files a/docs/book/src/images/cluster-topology-controller.png and b/docs/book/src/images/cluster-topology-controller.png differ diff --git a/docs/book/src/images/cluster-topology-reconciller.png b/docs/book/src/images/cluster-topology-reconciller.png index c0c010bdf2d6..aeb20addb722 100644 Binary files a/docs/book/src/images/cluster-topology-reconciller.png and b/docs/book/src/images/cluster-topology-reconciller.png differ diff --git a/docs/book/src/images/control-plane-controller.png b/docs/book/src/images/control-plane-controller.png index b768a8f04d5a..7ea511cd917e 100644 Binary files a/docs/book/src/images/control-plane-controller.png and b/docs/book/src/images/control-plane-controller.png differ diff --git a/docs/book/src/images/kubeadm-control-plane-machines-resources.png b/docs/book/src/images/kubeadm-control-plane-machines-resources.png index 91784a6b66ac..2e2c7a1b495c 100644 Binary files a/docs/book/src/images/kubeadm-control-plane-machines-resources.png and b/docs/book/src/images/kubeadm-control-plane-machines-resources.png differ diff --git a/docs/book/src/images/machine-infra-provider.png b/docs/book/src/images/machine-infra-provider.png index 38ef7da809c4..2b0d8eec9463 100644 Binary files a/docs/book/src/images/machine-infra-provider.png and b/docs/book/src/images/machine-infra-provider.png differ diff --git a/docs/book/src/images/machinehealthcheck-controller.png b/docs/book/src/images/machinehealthcheck-controller.png index 38672cd8f747..2a0affef6702 100644 Binary files a/docs/book/src/images/machinehealthcheck-controller.png and b/docs/book/src/images/machinehealthcheck-controller.png differ diff --git a/docs/book/src/images/management-workload-same-cluster.png b/docs/book/src/images/management-workload-same-cluster.png index 5e25f3bba209..8d631fd39452 100644 Binary files a/docs/book/src/images/management-workload-same-cluster.png and b/docs/book/src/images/management-workload-same-cluster.png differ diff --git a/docs/book/src/images/management-workload-separate-clusters.png b/docs/book/src/images/management-workload-separate-clusters.png index 325fe5802af9..a3ec82376931 100644 Binary files a/docs/book/src/images/management-workload-separate-clusters.png and b/docs/book/src/images/management-workload-separate-clusters.png differ diff --git a/docs/book/src/images/runtime-sdk-topology-mutation.png b/docs/book/src/images/runtime-sdk-topology-mutation.png index cd1804bea312..99f3fb976a9e 100644 Binary files a/docs/book/src/images/runtime-sdk-topology-mutation.png and b/docs/book/src/images/runtime-sdk-topology-mutation.png differ diff --git a/docs/book/src/images/worker-machines-resources.png b/docs/book/src/images/worker-machines-resources.png index d710d4d91582..74d24f9d8416 100644 Binary files a/docs/book/src/images/worker-machines-resources.png and b/docs/book/src/images/worker-machines-resources.png differ diff --git a/docs/proposals/images/capi-provider-operator/fig1.png b/docs/proposals/images/capi-provider-operator/fig1.png index 2fd277f2054b..f4a6d6b98772 100644 Binary files a/docs/proposals/images/capi-provider-operator/fig1.png and b/docs/proposals/images/capi-provider-operator/fig1.png differ diff --git a/docs/proposals/images/capi-provider-operator/fig2.png b/docs/proposals/images/capi-provider-operator/fig2.png index 9e54dc3384df..07b57f0fdf56 100644 Binary files a/docs/proposals/images/capi-provider-operator/fig2.png and b/docs/proposals/images/capi-provider-operator/fig2.png differ diff --git a/docs/proposals/images/cluster-class/create.png b/docs/proposals/images/cluster-class/create.png index a36482500c30..ae427693ecfe 100644 Binary files a/docs/proposals/images/cluster-class/create.png and b/docs/proposals/images/cluster-class/create.png differ diff --git a/docs/proposals/images/cluster-class/update.png b/docs/proposals/images/cluster-class/update.png index 2a09eacddb44..82275538236f 100644 Binary files a/docs/proposals/images/cluster-class/update.png and b/docs/proposals/images/cluster-class/update.png differ diff --git a/docs/proposals/images/cluster-spec-crds/figure1.png b/docs/proposals/images/cluster-spec-crds/figure1.png index fc5bc7f2f0fa..21f79d5aaf95 100644 Binary files a/docs/proposals/images/cluster-spec-crds/figure1.png and b/docs/proposals/images/cluster-spec-crds/figure1.png differ diff --git a/docs/proposals/images/cluster-spec-crds/figure2.png b/docs/proposals/images/cluster-spec-crds/figure2.png index 56d5441fbc62..ed753a83eacb 100644 Binary files a/docs/proposals/images/cluster-spec-crds/figure2.png and b/docs/proposals/images/cluster-spec-crds/figure2.png differ diff --git a/docs/proposals/images/clusterctl-extensible-templates/pkgCalls.png b/docs/proposals/images/clusterctl-extensible-templates/pkgCalls.png index 4ade29a41100..5aa53a702b1f 100644 Binary files a/docs/proposals/images/clusterctl-extensible-templates/pkgCalls.png and b/docs/proposals/images/clusterctl-extensible-templates/pkgCalls.png differ diff --git a/docs/proposals/images/clusterctl-extensible-templates/templateClient.png b/docs/proposals/images/clusterctl-extensible-templates/templateClient.png index c136cfeeb721..7219434c304e 100644 Binary files a/docs/proposals/images/clusterctl-extensible-templates/templateClient.png and b/docs/proposals/images/clusterctl-extensible-templates/templateClient.png differ diff --git a/docs/proposals/images/clusterctl-extensible-templates/yamlProcessor.png b/docs/proposals/images/clusterctl-extensible-templates/yamlProcessor.png index b752bebc237f..7e60c095439c 100644 Binary files a/docs/proposals/images/clusterctl-extensible-templates/yamlProcessor.png and b/docs/proposals/images/clusterctl-extensible-templates/yamlProcessor.png differ diff --git a/docs/proposals/images/clusterctl-redesign/config.png b/docs/proposals/images/clusterctl-redesign/config.png index e503b6728e1c..d1b2fcfe99ee 100644 Binary files a/docs/proposals/images/clusterctl-redesign/config.png and b/docs/proposals/images/clusterctl-redesign/config.png differ diff --git a/docs/proposals/images/clusterctl-redesign/init.png b/docs/proposals/images/clusterctl-redesign/init.png index eed657851cbb..a94ba1fe915b 100644 Binary files a/docs/proposals/images/clusterctl-redesign/init.png and b/docs/proposals/images/clusterctl-redesign/init.png differ diff --git a/docs/proposals/images/controlplane/controlplane-init-1.png b/docs/proposals/images/controlplane/controlplane-init-1.png index d2c1d002038a..e8f1fc4d0a7b 100644 Binary files a/docs/proposals/images/controlplane/controlplane-init-1.png and b/docs/proposals/images/controlplane/controlplane-init-1.png differ diff --git a/docs/proposals/images/controlplane/controlplane-init-2.png b/docs/proposals/images/controlplane/controlplane-init-2.png index d82c9e37b9d7..db2925e7bcc1 100644 Binary files a/docs/proposals/images/controlplane/controlplane-init-2.png and b/docs/proposals/images/controlplane/controlplane-init-2.png differ diff --git a/docs/proposals/images/controlplane/controlplane-init-3.png b/docs/proposals/images/controlplane/controlplane-init-3.png index e4f15fd61fab..cc0e7ceb9541 100644 Binary files a/docs/proposals/images/controlplane/controlplane-init-3.png and b/docs/proposals/images/controlplane/controlplane-init-3.png differ diff --git a/docs/proposals/images/controlplane/controlplane-init-4.png b/docs/proposals/images/controlplane/controlplane-init-4.png index 576e1d7209cb..3599126d5a38 100644 Binary files a/docs/proposals/images/controlplane/controlplane-init-4.png and b/docs/proposals/images/controlplane/controlplane-init-4.png differ diff --git a/docs/proposals/images/controlplane/controlplane-init-6.png b/docs/proposals/images/controlplane/controlplane-init-6.png index 3912952977c7..b1156903529b 100644 Binary files a/docs/proposals/images/controlplane/controlplane-init-6.png and b/docs/proposals/images/controlplane/controlplane-init-6.png differ diff --git a/docs/proposals/images/controlplane/controlplane-init-7.png b/docs/proposals/images/controlplane/controlplane-init-7.png index a26f2ed60eb5..d9db505d5163 100644 Binary files a/docs/proposals/images/controlplane/controlplane-init-7.png and b/docs/proposals/images/controlplane/controlplane-init-7.png differ diff --git a/docs/proposals/images/developer/diagram.png b/docs/proposals/images/developer/diagram.png index 4d4e11c51cb8..bd98352e2425 100644 Binary files a/docs/proposals/images/developer/diagram.png and b/docs/proposals/images/developer/diagram.png differ diff --git a/docs/proposals/images/kubelet-authentication/client-authenticator-flow.png b/docs/proposals/images/kubelet-authentication/client-authenticator-flow.png index 653741da2460..fe45ea87c663 100644 Binary files a/docs/proposals/images/kubelet-authentication/client-authenticator-flow.png and b/docs/proposals/images/kubelet-authentication/client-authenticator-flow.png differ diff --git a/docs/proposals/images/machine-health-check/mhc.png b/docs/proposals/images/machine-health-check/mhc.png index 4fade3cf686d..395a7bba289a 100644 Binary files a/docs/proposals/images/machine-health-check/mhc.png and b/docs/proposals/images/machine-health-check/mhc.png differ diff --git a/docs/proposals/images/machine-states-preboot/Figure3.png b/docs/proposals/images/machine-states-preboot/Figure3.png index e3f2295bcc04..2c89cde5f993 100644 Binary files a/docs/proposals/images/machine-states-preboot/Figure3.png and b/docs/proposals/images/machine-states-preboot/Figure3.png differ diff --git a/docs/proposals/images/machine-states-preboot/Figure4.png b/docs/proposals/images/machine-states-preboot/Figure4.png index 9cf864f60be7..5ca0e4933267 100644 Binary files a/docs/proposals/images/machine-states-preboot/Figure4.png and b/docs/proposals/images/machine-states-preboot/Figure4.png differ diff --git a/docs/proposals/images/machine-states-preboot/Figure5.png b/docs/proposals/images/machine-states-preboot/Figure5.png index 7310d396a02a..f423b4a22c47 100644 Binary files a/docs/proposals/images/machine-states-preboot/Figure5.png and b/docs/proposals/images/machine-states-preboot/Figure5.png differ diff --git a/docs/proposals/images/machine-states-preboot/Figure6.png b/docs/proposals/images/machine-states-preboot/Figure6.png index 01ff81b36865..cafff947435c 100644 Binary files a/docs/proposals/images/machine-states-preboot/Figure6.png and b/docs/proposals/images/machine-states-preboot/Figure6.png differ diff --git a/docs/proposals/images/machine-states-preboot/Figure7.png b/docs/proposals/images/machine-states-preboot/Figure7.png index 2ec14f3c0258..3d574ed737cd 100644 Binary files a/docs/proposals/images/machine-states-preboot/Figure7.png and b/docs/proposals/images/machine-states-preboot/Figure7.png differ diff --git a/docs/proposals/images/machine-states-preboot/Figure8.png b/docs/proposals/images/machine-states-preboot/Figure8.png index 94536068d6b6..e5d7b30e5e48 100644 Binary files a/docs/proposals/images/machine-states-preboot/Figure8.png and b/docs/proposals/images/machine-states-preboot/Figure8.png differ diff --git a/docs/proposals/images/machinepool-api/figure1.png b/docs/proposals/images/machinepool-api/figure1.png index c2a34a6d7b53..f50fc5246062 100644 Binary files a/docs/proposals/images/machinepool-api/figure1.png and b/docs/proposals/images/machinepool-api/figure1.png differ diff --git a/docs/proposals/images/machinepool-machines/infraref-changed-sequence.png b/docs/proposals/images/machinepool-machines/infraref-changed-sequence.png index d3df1addf413..69c9e46f5d4e 100644 Binary files a/docs/proposals/images/machinepool-machines/infraref-changed-sequence.png and b/docs/proposals/images/machinepool-machines/infraref-changed-sequence.png differ diff --git a/docs/proposals/images/topology-mutation-hook/topology-reconciliation.png b/docs/proposals/images/topology-mutation-hook/topology-reconciliation.png index cd1804bea312..99f3fb976a9e 100644 Binary files a/docs/proposals/images/topology-mutation-hook/topology-reconciliation.png and b/docs/proposals/images/topology-mutation-hook/topology-reconciliation.png differ