Skip to content

Commit

Permalink
adapt documentation to new field
Browse files Browse the repository at this point in the history
  • Loading branch information
@Diaphteiros
Diaphteiros committed Mar 16, 2023
1 parent eae4f6b commit 1a02167
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@ landscape:
<a href="#landscapecluster">cluster</a>: # information about your base cluster
kubeconfig: &lt;relative path + filename&gt; # path to your `kubeconfig` file, rel. to directory `landscape` (defaults to `./kubeconfig`)
k8sVersion: 1.24.10 # your cluster's k8s version
<a href="#landscapenetworks">networks</a>: # <a target="_blank" rel="noopener noreferrer" href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">CIDR IP ranges</a> of base cluster
nodes: &lt;CIDR IP range&gt;
pods: &lt;CIDR IP range&gt;
Expand All @@ -169,6 +170,7 @@ landscape:
- &lt;major region&gt;-&lt;minor region&gt;-&lt;zone&gt; # Example: europe-west1-c
- &lt;major region&gt;-&lt;minor region&gt;-&lt;zone&gt; # 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: &lt;CIDR IP range&gt;
pods: &lt;CIDR IP range&gt;
Expand Down Expand Up @@ -230,6 +232,7 @@ Basis domain for DNS entries. As a best practice, use an individual prefix toget
```yaml
cluster:
kubeconfig: <relative path + filename>
k8sVersion: 1.24.10
networks:
nodes: <CIDR IP range>
pods: <CIDR IP range>
Expand All @@ -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.
Expand All @@ -262,6 +267,7 @@ iaas:
- <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>
Expand All @@ -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 <a href="#landscapecluster">landscape.cluster</a> 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.
Expand Down
2 changes: 2 additions & 0 deletions acre.yaml.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ landscape:

cluster:
# kubeconfig: ./kubeconfig # optional
k8sVersion: 1.24.10
networks:
nodes: <node CIDR>
pods: <pod CIDR>
Expand All @@ -27,6 +28,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 # cluster's k8s version
# networks: # CIDR IP ranges of seed cluster
# nodes: <CIDR IP range>
# pods: <CIDR IP range>
Expand Down
1 change: 1 addition & 0 deletions docs/extended/iaas.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ iaas:
- <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>
Expand Down

0 comments on commit 1a02167

Please sign in to comment.