From f2af31a913f31e2b3aa6370286ec54b885f5a4e6 Mon Sep 17 00:00:00 2001 From: Jooho Lee Date: Sat, 19 Oct 2024 22:37:42 -0400 Subject: [PATCH] use global variable for kserve_release_version (#407) Signed-off-by: jooho lee --- docs/admin/kubernetes_deployment.md | 7 +++---- docs/admin/serverless/serverless.md | 8 ++++---- docs/get_started/README.md | 4 ++-- docs/modelserving/v1beta1/triton/huggingface/README.md | 2 +- mkdocs.yml | 4 ++++ 5 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/admin/kubernetes_deployment.md b/docs/admin/kubernetes_deployment.md index 1ac501397..9d70354e6 100644 --- a/docs/admin/kubernetes_deployment.md +++ b/docs/admin/kubernetes_deployment.md @@ -6,7 +6,7 @@ Kubernetes version. ## Recommended Version Matrix | Kubernetes Version | Recommended Istio Version | -|:-------------------|:--------------------------| +| :----------------- | :------------------------ | | 1.27 | 1.18, 1.19 | | 1.28 | 1.19, 1.20 | | 1.29 | 1.20, 1.21 | @@ -46,14 +46,14 @@ The minimally required Cert Manager version is 1.9.0 and you can refer to [Cert === "kubectl" ```bash - kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.13.0/kserve.yaml + kubectl apply -f https://github.com/kserve/kserve/releases/download/v{{ kserve_release_version }}/kserve.yaml ``` Install KServe default serving runtimes: === "kubectl" ```bash - kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.13.0/kserve-cluster-resources.yaml + kubectl apply -f https://github.com/kserve/kserve/releases/download/v{{ kserve_release_version }}/kserve-cluster-resources.yaml ``` **ii. Change default deployment mode and ingress option** @@ -72,4 +72,3 @@ then modify the `ingressClassName` in `ingress` section to point to `IngressClas "ingressClassName" : "your-ingress-class", } ``` - diff --git a/docs/admin/serverless/serverless.md b/docs/admin/serverless/serverless.md index c4ecb5e56..8e51677cf 100644 --- a/docs/admin/serverless/serverless.md +++ b/docs/admin/serverless/serverless.md @@ -7,7 +7,7 @@ Kubernetes version. ## Recommended Version Matrix | Kubernetes Version | Recommended Istio Version | Recommended Knative Version | -|:-------------------|:--------------------------|:----------------------------| +| :----------------- | :------------------------ | :-------------------------- | | 1.27 | 1.18,1.19 | 1.10,1.11 | | 1.28 | 1.19,1.20 | 1.11,1.12.4 | | 1.29 | 1.20,1.21 | 1.12.4,1.13.1 | @@ -35,14 +35,14 @@ The minimally required Cert Manager version is 1.9.0 and you can refer to [Cert ## 4. Install KServe === "kubectl" ```bash - kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.13.0/kserve.yaml + kubectl apply -f https://github.com/kserve/kserve/releases/download/v{{ kserve_release_version }}/kserve.yaml ``` ## 5. Install KServe Built-in ClusterServingRuntimes - +{{ kserve_release_version }} === "kubectl" ```bash - kubectl apply -f https://github.com/kserve/kserve/releases/download/v0.13.0/kserve-cluster-resources.yaml + kubectl apply -f https://github.com/kserve/kserve/releases/download/v{{ kserve_release_version }}/kserve-cluster-resources.yaml ``` !!! note diff --git a/docs/get_started/README.md b/docs/get_started/README.md index 8b5699ecf..91e92ca1f 100644 --- a/docs/get_started/README.md +++ b/docs/get_started/README.md @@ -42,6 +42,6 @@ The [Kubernetes CLI (`kubectl`)](https://kubernetes.io/docs/tasks/tools/install- or install via our published Helm Charts: ```bash - helm install kserve-crd oci://ghcr.io/kserve/charts/kserve-crd --version v0.13.0 - helm install kserve oci://ghcr.io/kserve/charts/kserve --version v0.13.0 + helm install kserve-crd oci://ghcr.io/kserve/charts/kserve-crd --version v{{ kserve_release_version }} + helm install kserve oci://ghcr.io/kserve/charts/kserve --version v{{ kserve_release_version }} ``` diff --git a/docs/modelserving/v1beta1/triton/huggingface/README.md b/docs/modelserving/v1beta1/triton/huggingface/README.md index 2d9dbf5be..eacc0e45c 100644 --- a/docs/modelserving/v1beta1/triton/huggingface/README.md +++ b/docs/modelserving/v1beta1/triton/huggingface/README.md @@ -45,7 +45,7 @@ Create an InferenceService with triton predictor by specifying the `storageUri` - --model_id=bert-base-uncased - --predictor_protocol=v2 - --tensor_input_names=input_ids - image: kserve/huggingfaceserver:v0.13.0 + image: kserve/huggingfaceserver:v{{ kserve_release_version }} name: kserve-container resources: limits: diff --git a/mkdocs.yml b/mkdocs.yml index 344d43a60..51269abd6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -176,6 +176,8 @@ copyright: "Copyright © 2021 The KServe Authors" plugins: - search + - macros: + on_undefined: keep - mkdocstrings: default_handler: python handlers: @@ -191,8 +193,10 @@ plugins: filter: "" syntaxHighlightTheme: monokai tryItOutEnabled: true + extra: + kserve_release_version: 0.13.0 social: - icon: fontawesome/brands/github link: https://github.com/kserve