docs: Update docs for v0.31.0 (#4717)

aws · Sep 27, 2023 · 27a4422 · 27a4422
1 parent 3c87bc6
commit 27a4422
Show file tree

Hide file tree

Showing 10 changed files with 276 additions and 871 deletions.
diff --git a/Makefile b/Makefile
@@ -161,7 +161,7 @@ delete: ## Delete the controller from your ~/.kube/config cluster
 	helm uninstall karpenter --namespace karpenter
 
 docgen: ## Generate docs
-	$(WITH_GOFLAGS) ./hack/docgen.sh
+	KARPENTER_CORE_DIR=$(KARPENTER_CORE_DIR) $(WITH_GOFLAGS) ./hack/docgen.sh
 
 codegen: ## Auto generate files based on AWS APIs response
 	$(WITH_GOFLAGS) ./hack/codegen.sh

diff --git a/hack/docgen.sh b/hack/docgen.sh
@@ -3,12 +3,12 @@ set -euo pipefail
 
 compatibilitymatrix() {
     go run hack/docs/version_compatibility.go hack/docs/compatibility-karpenter.yaml "$(git describe --exact-match --tags || echo "no tag")"
-    go run hack/docs/compatibilitymetrix_gen_docs.go website/content/en/preview/upgrade-guide.md hack/docs/compatibility-karpenter.yaml
+    go run hack/docs/compatibilitymetrix_gen_docs.go website/content/en/preview/upgrade-guide.md hack/docs/compatibility-karpenter.yaml 6
 }
 
 
 compatibilitymatrix
-go run hack/docs/metrics_gen_docs.go pkg/ $(KARPENTER_CORE_DIR)/pkg website/content/en/preview/concepts/metrics.md
+go run hack/docs/metrics_gen_docs.go pkg/ ${KARPENTER_CORE_DIR}/pkg website/content/en/preview/concepts/metrics.md
 go run hack/docs/instancetypes_gen_docs.go website/content/en/preview/concepts/instance-types.md
 go run hack/docs/configuration_gen_docs.go website/content/en/preview/concepts/settings.md
 cd charts/karpenter && helm-docs
diff --git a/hack/docs/compatibility-karpenter.yaml b/hack/docs/compatibility-karpenter.yaml
@@ -29,4 +29,7 @@ compatibility:
     maxK8sVersion: 1.27
   - appVersion: 0.30.x
     minK8sVersion: 1.23
-    maxK8sVersion: 1.27
+    maxK8sVersion: 1.27
+  - appVersion: 0.31.x
+    minK8sVersion: 1.23
+    maxK8sVersion: 1.28
diff --git a/hack/docs/compatibilitymetrix_gen_docs.go b/hack/docs/compatibilitymetrix_gen_docs.go
@@ -18,6 +18,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"strconv"
 	"strings"
 
 	"github.com/aws/karpenter/tools/kompat/pkg/kompat"
@@ -54,5 +55,6 @@ func main() {
 	if err != nil {
 		log.Fatalf("unable to open %s to write generated output: %v", outputFileName, err)
 	}
-	f.WriteString(topDoc + baseText.Markdown(kompat.Options{LastN: 5}) + bottomDoc)
+	numOfk8sVersion, _ := strconv.Atoi(os.Args[3])
+	f.WriteString(topDoc + baseText.Markdown(kompat.Options{LastN: numOfk8sVersion}) + bottomDoc)
 }