Skip to content

Commit 7cab58b

Browse files
author
Jennifer Travinski
committed
Merge branch 'staging' of https://github.com/rancher/docs into staging-to-master
2 parents 2039744 + 61e8f35 commit 7cab58b

File tree

22 files changed

+303
-7090
lines changed

22 files changed

+303
-7090
lines changed

content/k3s/latest/en/upgrades/_index.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,22 @@ title: "Upgrades"
33
weight: 25
44
---
55

6-
This section describes how to upgrade your K3s cluster.
6+
### Upgrading your K3s cluster
77

88
[Upgrade basics]({{< baseurl >}}/k3s/latest/en/upgrades/basic/) describes several techniques for upgrading your cluster manually. It can also be used as a basis for upgrading through third-party Infrastructure-as-Code tools like [Terraform](https://www.terraform.io/).
99

1010
[Automated upgrades]({{< baseurl >}}/k3s/latest/en/upgrades/automated/) describes how to perform Kubernetes-native automated upgrades using Rancher's [system-upgrade-controller](https://github.com/rancher/system-upgrade-controller).
1111

12-
> If Traefik is not disabled K3s versions 1.20 and earlier will have installed Traefik v1, while K3s versions 1.21 and later will install Traefik v2 if v1 is not already present. To upgrade Traefik, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/migration/v1-to-v2/) and use the [migration tool](https://github.com/traefik/traefik-migration-tool) to migrate from the older Traefik v1 to Traefik v2.
12+
### Version-specific caveats
1313

14-
> The experimental embedded Dqlite data store was deprecated in K3s v1.19.1. Please note that upgrades from experimental Dqlite to experimental embedded etcd are not supported. If you attempt an upgrade it will not succeed and data will be lost.
14+
- **Traefik:** If Traefik is not disabled, K3s versions 1.20 and earlier will install Traefik v1, while K3s versions 1.21 and later will install Traefik v2, if v1 is not already present. To upgrade from the older Traefik v1 to Traefik v2, please refer to the [Traefik documentation](https://doc.traefik.io/traefik/migration/v1-to-v2/) and use the [migration tool](https://github.com/traefik/traefik-migration-tool).
15+
16+
- **K3s bootstrap data:** If you are using K3s in an HA configuration with an external SQL datastore, and your server (control-plane) nodes were not started with the `--token` CLI flag, you will no longer be able to add additional K3s servers to the cluster without specifying the token. Ensure that you retain a copy of this token, as it is required when restoring from backup. Previously, K3s did not enforce the use of a token when using external SQL datastores.
17+
- The affected versions are <= v1.19.12+k3s1, v1.20.8+k3s1, v1.21.2+k3s1; the patched versions are v1.19.13+k3s1, v1.20.9+k3s1, v1.21.3+k3s1.
18+
19+
- You may retrieve the token value from any server already joined to the cluster as follows:
20+
```
21+
cat /var/lib/rancher/k3s/server/token
22+
```
23+
24+
- **Experimental Dqlite:** The experimental embedded Dqlite data store was deprecated in K3s v1.19.1. Please note that upgrades from experimental Dqlite to experimental embedded etcd are not supported. If you attempt an upgrade, it will not succeed, and data will be lost.

content/rancher/v2.0-v2.4/en/installation/install-rancher-on-k8s/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -231,7 +231,7 @@ helm install rancher rancher-<CHART_REPO>/rancher \
231231
If you are using a Private CA signed certificate , add `--set privateCA=true` to the command:
232232

233233
```
234-
helm install rancher rancher-latest/rancher \
234+
helm install rancher rancher-<CHART_REPO>/rancher \
235235
--namespace cattle-system \
236236
--set hostname=rancher.my.org \
237237
--set ingress.tls.source=secret \

content/rancher/v2.5/en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/_index.md

Lines changed: 57 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Resource targeting uses `*` as the ARN of many of the resources created cannot b
2424
"ec2:RunInstances",
2525
"ec2:RevokeSecurityGroupIngress",
2626
"ec2:RevokeSecurityGroupEgress",
27+
"ec2:DescribeRegions",
2728
"ec2:DescribeVpcs",
2829
"ec2:DescribeTags",
2930
"ec2:DescribeSubnets",
@@ -123,31 +124,6 @@ Resource targeting uses `*` as the ARN of many of the resources created cannot b
123124

124125
### Service Role Permissions
125126

126-
Rancher will create a service role with the following trust policy:
127-
128-
```json
129-
{
130-
"Version": "2012-10-17",
131-
"Statement": [
132-
{
133-
"Action": "sts:AssumeRole",
134-
"Principal": {
135-
"Service": "eks.amazonaws.com"
136-
},
137-
"Effect": "Allow",
138-
"Sid": ""
139-
}
140-
]
141-
}
142-
```
143-
144-
This role will also have two role policy attachments with the following policies ARNs:
145-
146-
```
147-
arn:aws:iam::aws:policy/AmazonEKSClusterPolicy
148-
arn:aws:iam::aws:policy/AmazonEKSServicePolicy
149-
```
150-
151127
Permissions required for Rancher to create service role on users behalf during the EKS cluster creation process.
152128

153129
```json
@@ -182,36 +158,66 @@ Permissions required for Rancher to create service role on users behalf during t
182158
}
183159
```
184160

161+
When an EKS cluster is created, Rancher will create a service role with the following trust policy:
162+
163+
```json
164+
{
165+
"Version": "2012-10-17",
166+
"Statement": [
167+
{
168+
"Action": "sts:AssumeRole",
169+
"Principal": {
170+
"Service": "eks.amazonaws.com"
171+
},
172+
"Effect": "Allow",
173+
"Sid": ""
174+
}
175+
]
176+
}
177+
```
178+
179+
This role will also have two role policy attachments with the following policies ARNs:
180+
181+
```
182+
arn:aws:iam::aws:policy/AmazonEKSClusterPolicy
183+
arn:aws:iam::aws:policy/AmazonEKSServicePolicy
184+
```
185+
185186
### VPC Permissions
186187

187188
Permissions required for Rancher to create VPC and associated resources.
188189

189190
```json
190191
{
191-
"Sid": "VPCPermissions",
192-
"Effect": "Allow",
193-
"Action": [
194-
"ec2:ReplaceRoute",
195-
"ec2:ModifyVpcAttribute",
196-
"ec2:ModifySubnetAttribute",
197-
"ec2:DisassociateRouteTable",
198-
"ec2:DetachInternetGateway",
199-
"ec2:DescribeVpcs",
200-
"ec2:DeleteVpc",
201-
"ec2:DeleteTags",
202-
"ec2:DeleteSubnet",
203-
"ec2:DeleteRouteTable",
204-
"ec2:DeleteRoute",
205-
"ec2:DeleteInternetGateway",
206-
"ec2:CreateVpc",
207-
"ec2:CreateSubnet",
208-
"ec2:CreateSecurityGroup",
209-
"ec2:CreateRouteTable",
210-
"ec2:CreateRoute",
211-
"ec2:CreateInternetGateway",
212-
"ec2:AttachInternetGateway",
213-
"ec2:AssociateRouteTable"
214-
],
215-
"Resource": "*"
192+
"Version": "2012-10-17",
193+
"Statement": [
194+
{
195+
"Sid": "VPCPermissions",
196+
"Effect": "Allow",
197+
"Action": [
198+
"ec2:ReplaceRoute",
199+
"ec2:ModifyVpcAttribute",
200+
"ec2:ModifySubnetAttribute",
201+
"ec2:DisassociateRouteTable",
202+
"ec2:DetachInternetGateway",
203+
"ec2:DescribeVpcs",
204+
"ec2:DeleteVpc",
205+
"ec2:DeleteTags",
206+
"ec2:DeleteSubnet",
207+
"ec2:DeleteRouteTable",
208+
"ec2:DeleteRoute",
209+
"ec2:DeleteInternetGateway",
210+
"ec2:CreateVpc",
211+
"ec2:CreateSubnet",
212+
"ec2:CreateSecurityGroup",
213+
"ec2:CreateRouteTable",
214+
"ec2:CreateRoute",
215+
"ec2:CreateInternetGateway",
216+
"ec2:AttachInternetGateway",
217+
"ec2:AssociateRouteTable"
218+
],
219+
"Resource": "*"
220+
}
221+
]
216222
}
217-
```
223+
```

content/rancher/v2.5/en/helm-charts/_index.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,27 @@ From the left sidebar select _"Repositories"_.
5050

5151
These items represent helm repositories, and can be either traditional helm endpoints which have an index.yaml, or git repositories which will be cloned and can point to a specific branch. In order to use custom charts, simply add your repository here and they will become available in the Charts tab under the name of the repository.
5252

53+
To add a private CA for Helm Chart repositories:
54+
55+
- **HTTP-based chart repositories**: You must add a base64 encoded copy of the CA certificate in DER format to the spec.caBundle field of the chart repo, such as `openssl x509 -outform der -in ca.pem | base64 -w0`. Click **Edit YAML** for the chart repo and set, as in the following example:</br>
56+
```
57+
[...]
58+
spec:
59+
caBundle:
60+
MIIFXzCCA0egAwIBAgIUWNy8WrvSkgNzV0zdWRP79j9cVcEwDQYJKoZIhvcNAQELBQAwPzELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRQwEgYDVQQKDAtNeU9yZywgSW5jLjENMAsGA1UEAwwEcm9vdDAeFw0yMTEyMTQwODMyMTdaFw0yNDEwMDMwODMyMT
61+
...
62+
nDxZ/tNXt/WPJr/PgEB3hQdInDWYMg7vGO0Oz00G5kWg0sJ0ZTSoA10ZwdjIdGEeKlj1NlPyAqpQ+uDnmx6DW+zqfYtLnc/g6GuLLVPamraqN+gyU8CHwAWPNjZonFN9Vpg0PIk1I2zuOc4EHifoTAXSpnjfzfyAxCaZsnTptimlPFJJqAMj+FfDArGmr4=
63+
[...]
64+
```
65+
66+
- **Git-based chart repositories**: It is not currently possible to add a private CA. For git-based chart repositories with a certificate signed by a private CA, you must disable TLS verification. Click **Edit YAML** for the chart repo, and add the key/value pair as follows:
67+
```
68+
[...]
69+
spec:
70+
insecureSkipTLSVerify: true
71+
[...]
72+
```
73+
5374
> **Note:** Helm chart repositories with authentication
5475
>
5576
> As of Rancher v2.5.12, a new value `disableSameOriginCheck` has been added to the Repo.Spec. This allows users to bypass the same origin checks, sending the repository Authentication information as a Basic Auth Header with all API calls. This is not recommended but can be used as a temporary solution in cases of non-standard Helm chart repositories such as those that have redirects to a different origin URL.
@@ -61,7 +82,7 @@ These items represent helm repositories, and can be either traditional helm endp
6182
spec:
6283
disableSameOriginCheck: true
6384
[...]
64-
```
85+
```
6586

6687
### Helm Compatibility
6788

content/rancher/v2.5/en/installation/install-rancher-on-k8s/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -245,7 +245,7 @@ helm install rancher rancher-<CHART_REPO>/rancher \
245245
If you are using a Private CA signed certificate , add `--set privateCA=true` to the command:
246246

247247
```
248-
helm install rancher rancher-latest/rancher \
248+
helm install rancher rancher-<CHART_REPO>/rancher \
249249
--namespace cattle-system \
250250
--set hostname=rancher.my.org \
251251
--set ingress.tls.source=secret \

content/rancher/v2.5/en/monitoring-alerting/configuration/servicemonitor-podmonitor/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,6 @@ For more information about how ServiceMonitors work, refer to the [Prometheus Op
2626

2727
This pseudo-CRD maps to a section of the Prometheus custom resource configuration. It declaratively specifies how group of pods should be monitored.
2828

29-
When a PodMonitor is created, the Prometheus Operator updates the Prometheus scrape configuration to include the PodMonitor configuration. Then Prometheus begins scraping metrics from the endpoint defined in the ServiceMonitor.
29+
When a PodMonitor is created, the Prometheus Operator updates the Prometheus scrape configuration to include the PodMonitor configuration. Then Prometheus begins scraping metrics from the endpoint defined in the PodMonitor.
3030

3131
Any Pods in your cluster that match the labels located within the PodMonitor `selector` field will be monitored based on the `podMetricsEndpoints` specified on the PodMonitor. For more information on what fields can be specified, please look at the [spec](https://github.com/prometheus-operator/prometheus-operator/blob/master/Documentation/api.md#podmonitorspec) provided by Prometheus Operator.

content/rancher/v2.6/en/cluster-provisioning/hosted-kubernetes-clusters/eks/permissions/_index.md

Lines changed: 57 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Resource targeting uses `*` as the ARN of many of the resources created cannot b
2424
"ec2:RunInstances",
2525
"ec2:RevokeSecurityGroupIngress",
2626
"ec2:RevokeSecurityGroupEgress",
27+
"ec2:DescribeRegions",
2728
"ec2:DescribeVpcs",
2829
"ec2:DescribeTags",
2930
"ec2:DescribeSubnets",
@@ -123,31 +124,6 @@ Resource targeting uses `*` as the ARN of many of the resources created cannot b
123124

124125
### Service Role Permissions
125126

126-
Rancher will create a service role with the following trust policy:
127-
128-
```json
129-
{
130-
"Version": "2012-10-17",
131-
"Statement": [
132-
{
133-
"Action": "sts:AssumeRole",
134-
"Principal": {
135-
"Service": "eks.amazonaws.com"
136-
},
137-
"Effect": "Allow",
138-
"Sid": ""
139-
}
140-
]
141-
}
142-
```
143-
144-
This role will also have two role policy attachments with the following policies ARNs:
145-
146-
```
147-
arn:aws:iam::aws:policy/AmazonEKSClusterPolicy
148-
arn:aws:iam::aws:policy/AmazonEKSServicePolicy
149-
```
150-
151127
Permissions required for Rancher to create service role on users behalf during the EKS cluster creation process.
152128

153129
```json
@@ -182,36 +158,66 @@ Permissions required for Rancher to create service role on users behalf during t
182158
}
183159
```
184160

161+
When an EKS cluster is created, Rancher will create a service role with the following trust policy:
162+
163+
```json
164+
{
165+
"Version": "2012-10-17",
166+
"Statement": [
167+
{
168+
"Action": "sts:AssumeRole",
169+
"Principal": {
170+
"Service": "eks.amazonaws.com"
171+
},
172+
"Effect": "Allow",
173+
"Sid": ""
174+
}
175+
]
176+
}
177+
```
178+
179+
This role will also have two role policy attachments with the following policies ARNs:
180+
181+
```
182+
arn:aws:iam::aws:policy/AmazonEKSClusterPolicy
183+
arn:aws:iam::aws:policy/AmazonEKSServicePolicy
184+
```
185+
185186
### VPC Permissions
186187

187188
Permissions required for Rancher to create VPC and associated resources.
188189

189190
```json
190191
{
191-
"Sid": "VPCPermissions",
192-
"Effect": "Allow",
193-
"Action": [
194-
"ec2:ReplaceRoute",
195-
"ec2:ModifyVpcAttribute",
196-
"ec2:ModifySubnetAttribute",
197-
"ec2:DisassociateRouteTable",
198-
"ec2:DetachInternetGateway",
199-
"ec2:DescribeVpcs",
200-
"ec2:DeleteVpc",
201-
"ec2:DeleteTags",
202-
"ec2:DeleteSubnet",
203-
"ec2:DeleteRouteTable",
204-
"ec2:DeleteRoute",
205-
"ec2:DeleteInternetGateway",
206-
"ec2:CreateVpc",
207-
"ec2:CreateSubnet",
208-
"ec2:CreateSecurityGroup",
209-
"ec2:CreateRouteTable",
210-
"ec2:CreateRoute",
211-
"ec2:CreateInternetGateway",
212-
"ec2:AttachInternetGateway",
213-
"ec2:AssociateRouteTable"
214-
],
215-
"Resource": "*"
192+
"Version": "2012-10-17",
193+
"Statement": [
194+
{
195+
"Sid": "VPCPermissions",
196+
"Effect": "Allow",
197+
"Action": [
198+
"ec2:ReplaceRoute",
199+
"ec2:ModifyVpcAttribute",
200+
"ec2:ModifySubnetAttribute",
201+
"ec2:DisassociateRouteTable",
202+
"ec2:DetachInternetGateway",
203+
"ec2:DescribeVpcs",
204+
"ec2:DeleteVpc",
205+
"ec2:DeleteTags",
206+
"ec2:DeleteSubnet",
207+
"ec2:DeleteRouteTable",
208+
"ec2:DeleteRoute",
209+
"ec2:DeleteInternetGateway",
210+
"ec2:CreateVpc",
211+
"ec2:CreateSubnet",
212+
"ec2:CreateSecurityGroup",
213+
"ec2:CreateRouteTable",
214+
"ec2:CreateRoute",
215+
"ec2:CreateInternetGateway",
216+
"ec2:AttachInternetGateway",
217+
"ec2:AssociateRouteTable"
218+
],
219+
"Resource": "*"
220+
}
221+
]
216222
}
217-
```
223+
```

0 commit comments

Comments
 (0)