From 6f812d167d6a7dba1f7e4c61ab297c76295eba86 Mon Sep 17 00:00:00 2001 From: Wen Zhou Date: Tue, 27 Aug 2024 19:25:46 +0200 Subject: [PATCH] deps: uplift crd-ref-docs to 0.1.0 (#1206) * deps: uplift crd-ref-docs to 0.1.0 - their release changed and support different os/arch binary Signed-off-by: Wen Zhou * update: rewrite after review Signed-off-by: Wen Zhou --------- Signed-off-by: Wen Zhou (cherry picked from commit 3ce4d589518d2437d26ed747a24da1dae18451f4) --- Makefile | 19 +++++++++++-------- docs/api-overview.md | 7 ++++++- 2 files changed, 17 insertions(+), 9 deletions(-) diff --git a/Makefile b/Makefile index 56f6482508d..28d787524f9 100644 --- a/Makefile +++ b/Makefile @@ -76,7 +76,7 @@ YQ_VERSION ?= v4.12.2 # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. ENVTEST_K8S_VERSION = 1.24.2 ENVTEST_PACKAGE_VERSION = v0.0.0-20240320141353-395cfc7486e6 -CRD_REF_DOCS_VERSION = 0.0.11 +CRD_REF_DOCS_VERSION = 0.1.0 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set) ifeq (,$(shell go env GOBIN)) @@ -98,8 +98,8 @@ E2E_TEST_FLAGS = "--skip-deletion=false" -timeout 20m # See README.md, default g # see target "image-build" IMAGE_BUILD_FLAGS ?= --build-arg USE_LOCAL=false -# Read any custom variables overrides from a local.mk file. This will only be read if it exists in the -# same directory as this Makefile. Variables can be specified in the standard format supported by +# Read any custom variables overrides from a local.mk file. This will only be read if it exists in the +# same directory as this Makefile. Variables can be specified in the standard format supported by # GNU Make since `include` processes any valid Makefile # Standard variables override would include anything you would pass at runtime that is different # from the defaults specified in this file @@ -178,7 +178,7 @@ CLEANFILES += opt/manifests/* api-docs: crd-ref-docs ## Creates API docs using https://github.com/elastic/crd-ref-docs $(CRD_REF_DOCS) --source-path ./ --output-path ./docs/api-overview.md --renderer markdown --config ./crd-ref-docs.config.yaml && \ grep -Ev '\.io/[^v][^1].*)$$' ./docs/api-overview.md > temp.md && mv ./temp.md ./docs/api-overview.md - + ##@ Build .PHONY: build @@ -269,12 +269,15 @@ golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary. $(GOLANGCI_LINT): $(LOCALBIN) test -s $(GOLANGCI_LINT) || { curl -sSfL $(GOLANGCI_LINT_INSTALL_SCRIPT) | bash -s $(GOLANGCI_LINT_VERSION); } -CRD_REF_DOCS_DL_URL ?= 'https://github.com/elastic/crd-ref-docs/releases/download/v$(CRD_REF_DOCS_VERSION)/crd-ref-docs' + +OS=$(shell uname -s) +ARCH=$(shell uname -m) .PHONY: crd-ref-docs -crd-ref-docs: $(CRD_REF_DOCS) ## Download crd-ref-docs locally if necessary. +crd-ref-docs: $(CRD_REF_DOCS) $(CRD_REF_DOCS): $(LOCALBIN) - test -s $(CRD_REF_DOCS) || curl -sSLo $(CRD_REF_DOCS) $(CRD_REF_DOCS_DL_URL) && \ - chmod +x $(CRD_REF_DOCS) ;\ + test -s $(CRD_REF_DOCS) || ( \ + curl -sSL https://github.com/elastic/crd-ref-docs/releases/download/v$(CRD_REF_DOCS_VERSION)/crd-ref-docs_$(CRD_REF_DOCS_VERSION)_$(OS)_$(ARCH).tar.gz | tar -xzf - -C $(LOCALBIN) crd-ref-docs \ + ) BUNDLE_DIR ?= "bundle" .PHONY: bundle diff --git a/docs/api-overview.md b/docs/api-overview.md index 710f3b429b4..6edf0a162e5 100644 --- a/docs/api-overview.md +++ b/docs/api-overview.md @@ -181,7 +181,7 @@ _Appears in:_ | --- | --- | --- | --- | | `Component` _[Component](#component)_ | | | | | `serving` _[ServingSpec](#servingspec)_ | Serving configures the KNative-Serving stack used for model serving. A Service
Mesh (Istio) is prerequisite, since it is used as networking layer. | | | -| `defaultDeploymentMode` _[DefaultDeploymentMode](#defaultdeploymentmode)_ | Configures the default deployment mode for Kserve. This can be set to 'Serverless' or 'RawDeployment'.
The value specified in this field will be used to set the default deployment mode in the 'inferenceservice-config' configmap for Kserve.
This field is optional. If no default deployment mode is specified, Kserve will use Serverless mode. | | Enum: [Serverless RawDeployment]
Pattern: `^(Serverless|RawDeployment)$`
| +| `defaultDeploymentMode` _[DefaultDeploymentMode](#defaultdeploymentmode)_ | Configures the default deployment mode for Kserve. This can be set to 'Serverless' or 'RawDeployment'.
The value specified in this field will be used to set the default deployment mode in the 'inferenceservice-config' configmap for Kserve.
This field is optional. If no default deployment mode is specified, Kserve will use Serverless mode. | | Enum: [Serverless RawDeployment]
Pattern: `^(Serverless\|RawDeployment)$`
| @@ -313,6 +313,11 @@ _Underlying type:_ _string_ _Appears in:_ - [CertificateSpec](#certificatespec) +| Field | Description | +| --- | --- | +| `SelfSigned` | | +| `Provided` | | +| `OpenshiftDefaultIngress` | | #### CertificateSpec