From b664591c15a6174f03105066317b3042cc2946a1 Mon Sep 17 00:00:00 2001 From: Yugang Wang Date: Mon, 20 Mar 2023 14:20:00 -0400 Subject: [PATCH] TAAP-1075 Improve K8S definitions --- install.hbs.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/install.hbs.md b/install.hbs.md index 8936c4005c..e03708c80e 100644 --- a/install.hbs.md +++ b/install.hbs.md @@ -240,7 +240,7 @@ shared: username: "KP-DEFAULT-REPO-USERNAME" password: "KP-DEFAULT-REPO-PASSWORD" - kubernetes_distribution: "openshift" # To be passed only for OpenShift. Defaults to "". + kubernetes_distribution: "K8S-DISTRO" kubernetes_version: "K8S-VERSION" ca_cert_data: | # To be passed if using custom certificates. @@ -316,9 +316,8 @@ service's External IP address. It is not required to know the External IP addres - `KP-DEFAULT-REPO-PASSWORD` is the password for the user that can write to `KP-DEFAULT-REPO`. You can `docker push` to this location with this credential. * For Google Cloud Registry, use the contents of the service account JSON file. * Alternatively, you can configure this credential as a [secret reference](tanzu-build-service/install-tbs.md#install-secret-refs). -- `K8S-VERSION` is the Kubernetes version used by your OpenShift cluster. It must be in the form of `1.23.x` or `1.24.x`, where `x` stands for the patch version. Examples: - - Red Hat OpenShift Container Platform v4.10 uses the Kubernetes version `1.23.3`. - - Red Hat OpenShift Container Platform v4.11 uses the Kubernetes version `1.24.1`. +- `K8S-DISTRO` (optional) is the type of Kubernetes infrastructure in use. You can use it in coordination with `kubernetes_version`. For example, `openshift`. +- `K8S-VERSION` (optional) is the Kubernetes version in use. You can use it independently or in coordination with `kubernetes_distribution`. For example, `1.24.x`, where `x` is the Kubernetes patch version. - `SERVER-NAME` is the host name of the registry server. Examples: * Harbor has the form `server: "my-harbor.io"`. * Docker Hub has the form `server: "index.docker.io"`.