From 1a021675c754e5ac9fbc6fecfdba105878576f6c Mon Sep 17 00:00:00 2001 From: Johannes Aubart Date: Thu, 16 Mar 2023 13:30:21 +0100 Subject: [PATCH] adapt documentation to new field --- README.md | 7 +++++++ acre.yaml.example | 2 ++ docs/extended/iaas.md | 1 + 3 files changed, 10 insertions(+) diff --git a/README.md b/README.md index eaad2880..7f75f076 100644 --- a/README.md +++ b/README.md @@ -147,6 +147,7 @@ landscape: cluster: # information about your base cluster kubeconfig: <relative path + filename> # path to your `kubeconfig` file, rel. to directory `landscape` (defaults to `./kubeconfig`) + k8sVersion: 1.24.10 # your cluster's k8s version networks: # CIDR IP ranges of base cluster nodes: <CIDR IP range> pods: <CIDR IP range> @@ -169,6 +170,7 @@ landscape: - <major region>-<minor region>-<zone> # Example: europe-west1-c - <major region>-<minor region>-<zone> # Example: europe-west1-d cluster: # information about your seed's base cluster + k8sVersion: 1.25.2 # seed cluster's k8s version networks: # CIDR IP ranges of seed cluster nodes: <CIDR IP range> pods: <CIDR IP range> @@ -230,6 +232,7 @@ Basis domain for DNS entries. As a best practice, use an individual prefix toget ```yaml cluster: kubeconfig: + k8sVersion: 1.24.10 networks: nodes: pods: @@ -240,6 +243,8 @@ Information about your base cluster, where the Gardener will be deployed on. `landscape.cluster.kubeconfig` contains the path to your kubeconfig, relative to your landscape directory. It is recommended to create a kubeconfig file in your landscape directory to be able to sync all files relevant for your installation with a git repository. This value is optional and will default to `./kubeconfig` if not specified. +`landscape.cluster.k8sVersion` is the kubernetes version of your base cluster. This is given to `helm template` commands using the `--kube-version` flag, which allows helm to take your cluster's capabilities into account. + `landscape.cluster.networks` contains the CIDR ranges of your base cluster. Finding out CIDR ranges of your cluster is not trivial. For example, GKE only tells you a "pod address range" which is actually a combination of pod and service CIDR. However, since the `kubernetes` service typically has the first IP of the service IP range and most methods to get a kubernetes cluster tell you at least something about the CIDRs, it is usually possible to find out the CIDRs with a little bit of educated guessing. @@ -262,6 +267,7 @@ iaas: - -- # example: europe-west1-c - -- # example: europe-west1-d cluster: # information about your seed's base cluster + k8sVersion: 1.25.2 # seed cluster's k8s version networks: # CIDR IP ranges of seed cluster nodes: pods: @@ -283,6 +289,7 @@ Contains the information where Gardener will create intial seed clusters and clo | `credentials` | IaaS provider specific | Credentials in a provider-specific format. | See table with yaml keys below. | [GCP](https://cloud.google.com/iam/docs/creating-managing-service-account-keys#creating_service_account_keys), [AWS](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_users.html#id_users_service_accounts), [Azure](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal) | | `cluster.kubeconfig` | Kubeconfig | The kubeconfig for your seed base cluster. Must have basic auth authentification. | | | | `cluster.networks` | CIDRs | The CIDRs of your seed cluster. See landscape.cluster for more information. | | | +| `cluster.k8sVersion` | Kubernetes Version | The seed cluster's kubernetes version. | | | Here a list of configurations can be given. The setup will create one cloudprofile and seed per entry. Currently, you will have to provide the cluster you want to use as a seed - in future, the setup will be able to create a shoot and configure that shoot as a seed. The `type` should match the type of the underlying cluster. diff --git a/acre.yaml.example b/acre.yaml.example index ff03d412..c3246a89 100644 --- a/acre.yaml.example +++ b/acre.yaml.example @@ -4,6 +4,7 @@ landscape: cluster: # kubeconfig: ./kubeconfig # optional + k8sVersion: 1.24.10 networks: nodes: pods: @@ -27,6 +28,7 @@ landscape: # - -- # example: europe-west1-c # - -- # example: europe-west1-d # cluster: # information about your seed's base cluster + # k8sVersion: 1.25.2 # cluster's k8s version # networks: # CIDR IP ranges of seed cluster # nodes: # pods: diff --git a/docs/extended/iaas.md b/docs/extended/iaas.md index bfcaf96f..885aa2ed 100644 --- a/docs/extended/iaas.md +++ b/docs/extended/iaas.md @@ -60,6 +60,7 @@ iaas: - -- # example: europe-west1-c - -- # example: europe-west1-d cluster: # information about your seed's base cluster + k8sVersion: 1.25.2 # seed cluster's k8s version networks: # CIDR IP ranges of seed cluster nodes: pods: