Compare commits

..
Author SHA1 Message Date
Sunil Singh 6177452735 Merge pull request #1977 from rancher/v2.12.1
Merge release branch v2.12.1 into main
2025-08-28 16:08:32 -07:00
Billy TatandSunil Singh 9decee9ee7 Merge release branch v2.11.5 into main (#1976)
* [2.11.5] versions update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.11.5] webhook update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.11.5] CSP adapter update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.11.5] deprecated features update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* Update release date

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

---------

Signed-off-by: Sunil Singh <sunil.singh@suse.com>
Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2025-08-28 11:13:56 -07:00
Sunil Singh c1c11a335b Merge pull request #1979 from sunilarjun/update-date
Update release date
2025-08-28 08:54:47 -07:00
Sunil Singh d6e594c7bf Updating date
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-28 08:25:48 -07:00
Billy TatandSunil Singh 92637ee27c Merge release branch v2.10.9 into main (#1975)
* [2.10.9] versions update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.10.9] webhook update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.10.9] CSP adapter update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.10.9] deprecated features update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

---------

Signed-off-by: Sunil Singh <sunil.singh@suse.com>
Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2025-08-28 08:01:03 -07:00
Billy TatandSunil Singh 42a4484d7c Merge release branch v2.9.11 into main (#1974)
* [2.9.11] versions update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.9.11] webhook update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.9.11] CSP adapter update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

* [2.9.11] deprecated features update

Signed-off-by: Sunil Singh <sunil.singh@suse.com>

---------

Signed-off-by: Sunil Singh <sunil.singh@suse.com>
Co-authored-by: Sunil Singh <sunil.singh@suse.com>
2025-08-28 07:59:51 -07:00
Sunil Singh 14cbc7bd0d Merge pull request #1973 from sunilarjun/update-custom-cluster-section
Adding back custom cluster section
2025-08-25 12:04:34 -07:00
Sunil Singh 11486ac437 Adding back custom cluster section with updated links to RKE2/K3s sites.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-25 11:22:18 -07:00
Billy Tat 9bdb705c91 Merge pull request #1972 from btat/misc-errors
Fix errors from PR #1882 #1930
2025-08-25 10:00:43 -07:00
Billy Tat 7a4dfe349d Fix missed removals from PR #1882 2025-08-25 09:23:42 -07:00
Billy Tat 50b12d2577 Fix typos from PR #1930 2025-08-25 09:19:00 -07:00
Billy Tat 4739ef2238 Merge pull request #1971 from jbiers/document-bro-monitoring-features
[main] Document BRO monitoring features
2025-08-22 10:57:33 -07:00
Julia Bier bf2add3f04 Add sections on BRO monitoring to versioned docs 2025-08-22 12:23:03 -04:00
Julia Bier 9993243e49 Add sections on BRO monitoring 2025-08-22 12:22:08 -04:00
Billy Tat 9049774f69 Merge pull request #1967 from sunilarjun/v2.12.1-maintenance
v2.12.1 Maintenance Tasks
2025-08-21 18:46:31 -07:00
Sunil Singh 4b09a47046 [2.12.1] CNI update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-21 13:29:24 -07:00
Sunil Singh 2d91d1ca9b [2.12.1] deprecated features update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-21 13:25:43 -07:00
Sunil Singh 77e9bc07aa [2.12.1] CSP adapter update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-21 13:22:17 -07:00
Billy Tat 1ac6e81329 Merge pull request #1954 from LucasSaintarbor/rke1-removal-integrations-in-rancher-pt2
Remove RKE1: /integrations-in-rancher pages Part 2
2025-08-21 13:19:20 -07:00
Sunil Singh 98ec291627 [2.12.1] webhook update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-21 13:19:09 -07:00
Billy Tat f6b53affe0 Merge pull request #1955 from btat/sync-pr1603
Sync PR #1603 (Detail resourceset usage in Backup docs) to 2.10
2025-08-21 13:19:01 -07:00
Sunil Singh 5ada24df1c [2.12.1] versions update
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-08-21 13:15:58 -07:00
Billy Tat 91a1c316be Merge pull request #1965 from btat/revise-api-ref
Remove NodeDriver.management.cattle.io from RK-API ref
2025-08-21 10:01:47 -07:00
Billy Tat a17cc6c019 Remove NodeDriver.management.cattle.io from RK-API ref 2025-08-21 09:28:20 -07:00
Billy Tat d2d2208f38 Merge pull request #1963 from rancher/main
Sync main to v2.12.1
2025-08-20 15:42:47 -07:00
Billy Tat 7e01f8d408 Merge pull request #1961 from btat/revise-api-ref
Remove CustomMachine.rke.cattle.io and ETCDSnapshot.rke.cattle.io from the RK-API reference
2025-08-20 08:46:07 -07:00
Billy Tat 942717bd89 Remove APIs weren't intended to be listed 2025-08-20 08:03:16 -07:00
Billy Tat 85f5bbc922 Sync PR #1603 (Detail resourceset usage in Backup docs) to 2.10 2025-08-12 16:41:39 -07:00
LucasSaintarbor d23aff28d8 Remove RKE references in monitoring-and-alerting 2025-08-12 15:09:41 -07:00
LucasSaintarbor 64526859ce Remove RKE references in windows-support 2025-08-12 15:09:13 -07:00
Billy Tat 32e9b1f9c6 Merge pull request #1951 from btat/cluster-drivers
Remove invalid node and cluster drivers
2025-08-08 15:41:31 -07:00
Billy Tat 94ff32cc80 Remove invalid node and cluster drivers 2025-08-08 14:42:11 -07:00
Billy Tat 40abdb7d85 Merge pull request #1948 from btat/audit-log
[2.12] Add missing flag to enable auditlog
2025-08-07 16:43:23 -07:00
Billy Tat 7f39814047 [2.12] Add missing flag to enable auditlog 2025-08-07 15:55:01 -07:00
Lucas Saintarbor 20f3c5fd4c Remove RKE1: /integrations-in-rancher pages Part 1 (#1946)
* Remove RKE reference in logging-helm-chart-options

* Remove RKE reference in neuvector/overview

* Remove RKE reference in monitoring-and-alerting/how-monitoring-works
2025-08-06 11:52:55 -07:00
Sunil Singh 91ec72ff28 Merge pull request #1934 from joshmeranda/imperative-api-required
[main] add aggregation layer configuration required
2025-08-04 09:41:48 -07:00
joshmeranda 0e5afc1dd6 clarify imperative api supported versions 2025-08-04 10:56:15 -04:00
Josh MerandaandPetr Kovar e3725b97a0 Update versioned_docs/version-2.12/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md
Co-authored-by: Petr Kovar <pknbe@volny.cz>
2025-08-04 10:50:13 -04:00
Josh MerandaandPetr Kovar 69ddd76917 Update docs/getting-started/installation-and-upgrade/installation-requirements/installation-requirements.md
Co-authored-by: Petr Kovar <pknbe@volny.cz>
2025-08-04 10:50:06 -04:00
Dan P.andLucas Saintarbor d0511be5c3 Expand helm requirements page to explain matching the helm policy (#1943)
* Add details on selecting proper Helm 3 version

* Simplify notes about helm V2 into a single bulletpoint

* Add note about tools that use helm indirectly for users

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Update docs/getting-started/installation-and-upgrade/resources/helm-version-requirements.md

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>

* Sync new helm docs to versioned docs

* Add helm info to 2.10/2.9 docs with updated example

---------

Co-authored-by: Lucas Saintarbor <lucas.saintarbor@suse.com>
2025-08-01 14:45:01 -07:00
Sunil Singh 976f1aa2dc Merge pull request #1941 from sunilarjun/remove-rke-getting-started
Remove RKE-  /getting-started section
2025-07-31 16:38:30 -07:00
Lucas Saintarbor 13d44fde15 Remove RKE references in launch-kubernetes-with-rancher.md (#1942) 2025-07-31 16:31:24 -07:00
Sunil Singh 557c98b9db Merge branch 'main' into remove-rke-getting-started 2025-07-31 15:58:54 -07:00
Sunil Singh eedc5691bb rm rke1 getting-started/installation-and-upgrade/installation-references/tls-settings.md
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 15:16:08 -07:00
Sunil Singh 4156df0eab rm rke1 getting-started/installation-and-upgrade/installation-references/helm-chart-options.md
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 15:12:50 -07:00
Sunil Singh 5e0d2ddf8e rm rke1 getting-started/installation-and-upgrade/installation-references/feature-flags.md
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 15:10:14 -07:00
Sunil Singh 5fe045cba2 rm rke1 getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 15:07:03 -07:00
Sunil Singh 4b109ff5a7 rm rke1 getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/troubleshooting.md
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 14:39:04 -07:00
Sunil Singh 191bbc611a rm rke1 getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/install-upgrade-on-a-kubernetes-cluster.md
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 14:23:03 -07:00
Sunil Singh 13a5965ba7 rm rke1 getting-started/overview.md page
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 14:19:19 -07:00
Sunil Singh 5928170579 Merge pull request #1939 from sunilarjun/update-link-oidc
Updating OIDC Link - /docs folder
2025-07-31 14:00:50 -07:00
Sunil Singh ab606b6e51 Updating broken link in /docs configure-oidc-provider.md page.
Signed-off-by: Sunil Singh <sunil.singh@suse.com>
2025-07-31 10:55:37 -07:00
Petr Kovar 30a5a05733 Merge branch 'main' into imperative-api-required 2025-07-31 19:30:20 +02:00
Sunil Singh 8268557cfb Merge pull request #1935 from yassan/patch-1
Fix incorrect link URL on "Configure Rancher as an OIDC provider" page
2025-07-31 09:18:19 -07:00
Lucas Saintarbor 4d0b5d2eee Add back RKE2 CAPI info to Launching Kubernetes with Rancher page (#1937) 2025-07-31 08:41:35 -07:00
yassan(Yasukazu Nagatomi) 90c2f00d9b Fix incorrect doc page URL 2025-07-31 15:53:08 +09:00
joshmeranda 80dc50b560 add aggregation layer configuration required 2025-07-30 09:47:29 -04:00
182 changed files with 533 additions and 6778 deletions
+2 -1
View File
@@ -12,7 +12,8 @@ Rancher extends Kubernetes with additional APIs by registering an extension API
The API aggregation layer must be configured on the local Kubernetes cluster for the `v1.ext.cattle.io` `APIService` to work correctly. If the `APIService` does not receive a registration request after the Rancher server starts, the pod will crash with a log entry indicating the error. If your pods are consistently failing to detect registration despite having a correctly configured cluster, you can increase the timeout by setting the `.Values.aggregationRegistrationTimeout` in Helm.
All versions of Kubernetes supported by Rancher with the feature will have the aggregation layer configured by default. However, if you suspect that your cluster configuration is incorrect, refer to the [Kubernetes Aggregation Layer documentation](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer.
All versions of Kubernetes supported in this Rancher versions K8s distributions (RKE2/K3s) will have the aggregation layer configured and enabled by default. However, if you suspect that your cluster configuration is incorrect, refer to the [Kubernetes Aggregation Layer documentation](https://kubernetes.io/docs/tasks/extend-kubernetes/configure-aggregation-layer/) for information on configuring the aggregation layer.
:::note
If the underlying Kubernetes distribution does not support the aggregation layer, you must migrate to a Kubernetes distribution that does before upgrading.
+1
View File
@@ -16,6 +16,7 @@ Rancher will publish deprecated features as part of the [release notes](https://
| Patch Version | Release Date |
|---------------|---------------|
| [2.12.1](https://github.com/rancher/rancher/releases/tag/v2.12.1) | August 28, 2025 |
| [2.12.0](https://github.com/rancher/rancher/releases/tag/v2.12.0) | July 30, 2025 |
## What can I expect when a feature is marked for deprecation?
@@ -24,7 +24,6 @@ Rancher can be installed on any Kubernetes cluster. This cluster can use upstrea
For help setting up a Kubernetes cluster, we provide these tutorials:
- **RKE:** For the tutorial to install an RKE Kubernetes cluster, refer to [this page.](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher.md) For help setting up the infrastructure for a high-availability RKE cluster, refer to [this page.](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md)
- **K3s:** For the tutorial to install a K3s Kubernetes cluster, refer to [this page.](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md) For help setting up the infrastructure for a high-availability K3s cluster, refer to [this page.](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md)
- **RKE2:** For the tutorial to install an RKE2 Kubernetes cluster, refer to [this page.](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md) For help setting up the infrastructure for a high-availability RKE2 cluster, refer to [this page.](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md)
- **Amazon EKS:** For details on how to install Rancher on Amazon EKS, including how to install an Ingress controller so that the Rancher server can be accessed, refer to [this page.](rancher-on-amazon-eks.md)
@@ -36,7 +35,7 @@ For help setting up a Kubernetes cluster, we provide these tutorials:
The Rancher UI and API are exposed through an Ingress. This means the Kubernetes cluster that you install Rancher in must contain an Ingress controller.
For RKE, RKE2, and K3s installations, you don't have to install the Ingress controller manually because one is installed by default.
For RKE2 and K3s installations, you don't have to install the Ingress controller manually because one is installed by default.
For distributions that do not include an Ingress Controller by default, like a hosted Kubernetes cluster such as EKS, GKE, or AKS, you have to deploy an Ingress controller first. Note that the Rancher Helm chart does not set an `ingressClassName` on the ingress by default. Because of this, you have to configure the Ingress controller to also watch ingresses without an `ingressClassName`.
@@ -175,18 +175,10 @@ $ nc xxx.xxx.xxx.xxx 22
SSH-2.0-OpenSSH_6.6.1p1 Ubuntu-2ubuntu2.10
```
### Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: Error configuring SSH: ssh: no key found
The key file specified as `ssh_key_path` cannot be accessed. Make sure that you specified the private key file (not the public key, `.pub`), and that the user that is running the `rke` command can access the private key file.
### Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey], no supported methods remain
The key file specified as `ssh_key_path` is not correct for accessing the node. Double-check if you specified the correct `ssh_key_path` for the node and if you specified the correct user to connect with.
### Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: Error configuring SSH: ssh: cannot decode encrypted private keys
If you want to use encrypted private keys, you should use `ssh-agent` to load your keys with your passphrase. If the `SSH_AUTH_SOCK` environment variable is found in the environment where the `rke` command is run, it will be used automatically to connect to the node.
### Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
The node is not reachable on the configured `address` and `port`.
@@ -10,18 +10,15 @@ The following instructions will guide you through upgrading a Rancher server tha
For the instructions to upgrade Rancher installed with Docker, refer to [this page.](../other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md)
To upgrade the components in your Kubernetes cluster, or the definition of the [Kubernetes services](https://rancher.com/docs/rke/latest/en/config-options/services/) or [add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/), refer to the [upgrade documentation for RKE](https://rancher.com/docs/rke/latest/en/upgrades/), the Rancher Kubernetes Engine.
## Prerequisites
### Access to kubeconfig
### Access to Kubeconfig
Helm should be run from the same location as your kubeconfig file, or the same location where you run your kubectl commands from.
Helm should be run from the same location as your Kubeconfig file, or the same location where you run your `kubectl` commands from.
If you installed Kubernetes with RKE, the config will have been created in the directory you ran `rke up` in.
If you installed Kubernetes with RKE2/K3s, the Kubeconfig is stored in the `/etc/rancher/rke2/rke2.yaml` or `/etc/rancher/k3s/k3s.yaml` directory depending on your chosen distribution.
The kubeconfig can also be manually targeted for the intended cluster with the `--kubeconfig` tag (see: https://helm.sh/docs/helm/helm/)
The Kubeconfig can also be manually targeted for the intended cluster with the `--kubeconfig` tag (see: https://helm.sh/docs/helm/helm/)
### Review Known Issues
@@ -152,6 +149,7 @@ Upgrade Rancher to the latest version with all your settings.
Take all the values from the previous step and append them to the command using `--set key=value`.
```
helm upgrade rancher rancher-<CHART_REPO>/rancher \
--namespace cattle-system \
@@ -184,6 +182,7 @@ Alternatively, it's possible to export the current values to a file and referenc
```
1. Update only the Rancher version:
```
helm upgrade rancher rancher-<CHART_REPO>/rancher \
--namespace cattle-system \
@@ -51,7 +51,6 @@ You can enable this feature on a per-cluster basis. For more information, please
:::
- `multi-cluster-management`: Allows multi-cluster provisioning and management of Kubernetes clusters. This flag can only be set at install time. It can't be enabled or disabled later.
- `rke1-custom-node-cleanup`: Enables cleanup of deleted RKE1 custom nodes. We recommend that you keep this flag enabled, to prevent removed nodes from attempting to rejoin the cluster.
- `rke2`: Enables provisioning RKE2 clusters. This flag is enabled by default.
- `token-hashing`: Enables token hashing. Once enabled, existing tokens will be hashed and all new tokens will be hashed automatically with the SHA256 algorithm. Once a token is hashed it can't be undone. This flag can't be disabled after its enabled. See [API Tokens](../../../api/api-tokens.md#token-hashing) for more information.
- `uiextension`: Enables UI extensions. This flag is enabled by default. Enabling or disabling the flag forces the Rancher pod to restart. The first time this flag is set to `Active`, it creates a CRD and enables the controllers and endpoints necessary for the feature to work. If set to `Disabled`, it disables the previously mentioned controllers and endpoints. Setting `uiextension` to `Disabled` has no effect on the CRD -- it does not create a CRD if it does not yet exist, nor does it delete the CRD if it already exists.
@@ -72,7 +71,6 @@ The following table shows the availability and default values for some feature f
| `imperative-api-extension` | `Active` | GA | v2.11.0 | |
| `legacy` | `Disabled` for new installs, `Active` for upgrades | GA | v2.6.0 | |
| `managed-system-upgrade-controller` | `Active` | GA | v2.10.0 | |
| `rke1-custom-node-cleanup`| `true` | GA | v2.6.0 | |
| `rke2` | `true` | Experimental | v2.6.0 | |
| `token-hashing` | `Disabled` for new installs, `Active` for upgrades | GA | v2.6.0 | |
| `uiextension` | `Active` | GA | v2.9.0 | |
@@ -81,7 +81,7 @@ Enabling the [API Audit Log](../../../how-to-guides/advanced-user-guides/enable-
You can collect this log as you would any container log. Enable [logging](../../../integrations-in-rancher/logging/logging.md) for the `System` Project on the Rancher server cluster.
```plain
--set auditLog.level=1
--set auditLog.enabled=true --set auditLog.level=1
```
By default enabling Audit Logging will create a sidecar container in the Rancher pod. This container (`rancher-audit-log`) will stream the log to `stdout`. You can collect this log as you would any container log. When using the sidecar as the audit log destination, the `hostPath`, `maxAge`, `maxBackups`, and `maxSize` options do not apply. It's advised to use your OS or Docker daemon's log rotation features to control disk space use. Enable [logging](../../../integrations-in-rancher/logging/logging.md) for the Rancher server cluster or System Project.
@@ -219,14 +219,6 @@ Your load balancer must support long lived websocket connections and will need t
In NGINX v0.22, the behavior of NGINX has [changed](https://github.com/kubernetes/ingress-nginx/blob/06efac9f0b6f8f84b553f58ccecf79dc42c75cc6/Changelog.md) regarding forwarding headers and external TLS termination. Therefore, in the scenario that you are using external TLS termination configuration with NGINX v0.22, you must enable the `use-forwarded-headers` option for ingress:
For RKE installations, edit the `cluster.yml` to add the following settings.
```yaml
ingress:
provider: nginx
options:
use-forwarded-headers: 'true'
```
For RKE2 installations, you can create a custom `rke2-ingress-nginx-config.yaml` file at `/var/lib/rancher/rke2/server/manifests/rke2-ingress-nginx-config.yaml` containing this required setting to enable using forwarded headers with external TLS termination. Without this required setting applied, the external LB will continuously respond with redirect loops it receives from the ingress controller. (This can be created before or after rancher is installed, rke2 server agent will notice this addition and automatically apply it.)
```yaml
@@ -12,7 +12,7 @@ Changing the default TLS settings depends on the chosen installation method.
When you install Rancher inside of a Kubernetes cluster, TLS is offloaded at the cluster's ingress controller. The possible TLS settings depend on the used ingress controller:
* nginx-ingress-controller (default for RKE1 and RKE2): [Default TLS Version and Ciphers](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-tls-version-and-ciphers).
* nginx-ingress-controller (default for RKE2): [Default TLS Version and Ciphers](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-tls-version-and-ciphers).
* traefik (default for K3s): [TLS Options](https://doc.traefik.io/traefik/https/tls/#tls-options).
## Running Rancher in a single Docker container
@@ -23,6 +23,8 @@ See our page on [best practices](../../../reference-guides/best-practices/ranche
Rancher needs to be installed on a supported Kubernetes version. Consult the [Rancher support matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions) to ensure that your intended version of Kubernetes is supported.
Regardless of version and distribution, the Kubernetes cluster must have the aggregation API layer properly configured to support the [extension API](../../../api/extension-apiserver.md) used by Rancher.
### Install Rancher on a Hardened Kubernetes cluster
If you install Rancher on a hardened Kubernetes cluster, check the [Exempting Required Rancher Namespaces](../../../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/psa-config-templates.md#exempting-required-rancher-namespaces) section for detailed requirements.
@@ -12,7 +12,24 @@ This section contains the requirements for Helm, which is the tool used to insta
<DeprecationHelm2 />
## Identifying the Proper Helm v3 Version
Select any Helm v3 version that is officially compatible with the Kubernetes version range you are using from our [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions).
To apply this rule, you may need to reference two external resources:
- **Helm Version Compatibility:** Refer to the [Helm Version Support Policy](https://helm.sh/docs/topics/version_skew/) and select the version matching the rule for your Rancher minor target.
- **Rancher's Kubernetes Support Range:** Use the [Rancher Support Matrix](https://www.suse.com/suse-rancher/support-matrix/all-supported-versions) to identify the Kubernetes versions supported by your target Rancher minor version.
### Example
- **Scenario:** You are targeting Rancher v2.11.4, which supports Kubernetes versions 1.30 through 1.32.
- **Application:** Our rule requires a Helm version that supports this range. You can verify this by checking the Helm version's compatibility with the highest version in the range, Kubernetes v1.32.
- **Result:** You find that both Helm v3.17 and Helm v3.18 support the Kubernetes v1.30-v1.32 range.
- Although both work, we recommend Helm v3.18 because it is the newest Helm minor version overlapping the supported Kubernetes range.
## Additional Notes
- Helm v3.2.x or higher is required to install or upgrade Rancher v2.5.
- Helm v2.16.0 or higher is required for Kubernetes v1.16. For the default Kubernetes version, refer to the [release notes](https://github.com/rancher/rke/releases) for the version of RKE that you are using.
- Helm v2.15.0 should not be used, because of an issue with converting/comparing numbers.
- Helm v2.12.0 should not be used, because of an issue with `cert-manager`.
- Helm v2 support was removed in Rancher v2.9.x.
- When using tools that run Helm commands for you (like Terraform), you must make sure they are configured to use the correct Helm version.
+2 -2
View File
@@ -10,7 +10,7 @@ Rancher is a container management platform built for organizations that deploy c
## Run Kubernetes Everywhere
Kubernetes has become the container orchestration standard. Most cloud and virtualization vendors now offer it as standard infrastructure. Rancher users have the choice of creating Kubernetes clusters with Rancher Kubernetes Engine (RKE) or cloud Kubernetes services, such as GKE, AKS, and EKS. Rancher users can also import and manage their existing Kubernetes clusters created using any Kubernetes distribution or installer.
Kubernetes has become the container orchestration standard. Most cloud and virtualization vendors now offer it as standard infrastructure. Rancher users have the choice of creating Kubernetes clusters with Rancher Kubernetes distributions (RKE2/K3s) or cloud Kubernetes services, such as GKE, AKS, and EKS. Rancher users can also import and manage their existing Kubernetes clusters created using any Kubernetes distribution or installer.
## Meet IT Requirements
@@ -58,7 +58,7 @@ The Rancher API server is built on top of an embedded Kubernetes API server and
## Editing Downstream Clusters with Rancher
The options and settings available for an existing cluster change based on the method that you used to provision it. For example, only clusters [provisioned by RKE](../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md) have **Cluster Options** available for editing.
The options and settings available for an existing cluster change based on the method that you used to provision it.
After a cluster is created with Rancher, a cluster administrator can manage cluster membership or manage node pools, among [other options.](../reference-guides/cluster-configuration/cluster-configuration.md)
@@ -7,7 +7,7 @@ title: Configure Rancher as an OIDC provider
</head>
Rancher can function as a standard OpenID Connect (OIDC) provider, allowing external applications to use Rancher for authentication.
This can be used for enabling single sign-on (SSO) across Rancher Prime components. For example, see the [documentation](https://documentation.suse.com/cloudnative/suse-observability/next/en/setup/security/authentication/oidc.html) for configuring the OIDC provider for SUSE Observability.
This can be used for enabling single sign-on (SSO) across Rancher Prime components. For example, see the [documentation](https://documentation.suse.com/cloudnative/suse-observability/latest/en/setup/security/authentication/oidc.html) for configuring the OIDC provider for SUSE Observability.
The OIDC provider can be enabled with the `oidc-provider` feature flag. When this flag is on the following endpoints are available:
@@ -27,12 +27,6 @@ By default, Rancher has activated several hosted Kubernetes cloud providers incl
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
There are several other hosted Kubernetes cloud providers that are disabled by default, but are packaged in Rancher:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
### Node Drivers
Node drivers are used to provision hosts, which Rancher uses to launch and manage Kubernetes clusters. A node driver is the same as a [Docker Machine driver](https://github.com/docker/docs/blob/vnext-engine/machine/drivers/index.md). The availability of which node driver to display when creating node templates is defined based on the node driver's status. Only `active` node drivers will be displayed as an option for creating node templates. By default, Rancher is packaged with many existing Docker Machine drivers, but you can also create custom node drivers to add to Rancher.
@@ -11,57 +11,6 @@ They became available and were turned on by default in Kubernetes v1.23, and rep
PSS define security levels for workloads. PSAs describe requirements for pod security contexts and related fields. PSAs reference PSS levels to define security restrictions.
#### Install `helm-mapkubeapis`
1. Open your terminal in the machine you intend to use `helm-mapkubeapis` from and install the plugin:
```shell
helm plugin install https://github.com/helm/helm-mapkubeapis
```
You will see output similar to the following:
```console
Downloading and installing helm-mapkubeapis v0.4.1 ...
https://github.com/helm/helm-mapkubeapis/releases/download/v0.4.1/helm-mapkubeapis_0.4.1_darwin_amd64.tar.gz
Installed plugin: mapkubeapis
```
:::info important
Ensure that the `helm-mapkubeapis` plugin is at least v0.4.1, as older versions _do not_ support removal of resources.
:::
1. Verify that the plugin was correctly installed:
```shell
helm mapkubeapis --help
```
You will see output similar to the following:
```console
Map release deprecated or removed Kubernetes APIs in-place
Usage:
mapkubeapis [flags] RELEASE
Flags:
--dry-run simulate a command
-h, --help help for mapkubeapis
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--mapfile string path to the API mapping file
--namespace string namespace scope of the release
```
#### Cleaning Up Broken Releases
After you install the `helm-mapkubeapis` plugin, clean up the releases that became broken after the upgrade to Kubernetes v1.25.
1. Open your preferred terminal and make sure it's connected to the cluster you wish to target by running `kubectl cluster-info`.
1. List all the releases you have installed in your cluster by running `helm list --all-namespaces`.
1. Perform a dry run for each release you would like to clean up by running `helm mapkubeapis --dry-run <release-name> --namespace <release-namespace>`. The result of this command will inform you what resources are going to be replaced or removed.
1. Finally, after reviewing the changes, perform a full run with `helm mapkubeapis <release-name> --namespace <release-namespace>`.
## Pod Security Admission Configuration Templates
Rancher offers PSA configuration templates. These are pre-defined security configurations that you can apply to a cluster. Rancher admins (or those with the right permissions) can [create, manage, and edit](./psa-config-templates.md) PSA templates.
@@ -128,6 +128,35 @@ Trying to delete and restore a downstream cluster can lead to a variety of issue
Other services, which are backed up by Rancher Backups, often change and evolve. As this happens, their resources and backup needs may change as well. Some resources may not need to be backed up and some may not be backed up at all. It is important for teams to consider this in their development process and assess whether their related resourceSets are correctly capturing the proper set of resources for their services to be restored correctly.
## Monitoring backups and restores
Rancher offers out-of-the box monitoring features for the Backup Operator. They are disabled by default but can be easily enabled when deploying the operator Helm Chart.
### Metrics
Metrics can be enabled by setting `monitoring.metrics.enabled: true` and `monitoring.serviceMonitor.enabled: true` in the Helm Chart values. When enabled, the Operator exports the following metrics. Note that *rancher-monitoring* needs to be previously installed for the metrics to be properly exported.
| **Metric Name** | **Description** |
|----------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------|
| `rancher_backup_info` | Details on a specific Rancher Backup CR (labels: `name`, `status`, `resourceSetName`, `retentionCount`, `backupType`, `filename`, `storageLocation`, `nextSnapshot`, `lastSnapshot`). Type *GaugeVec*. |
| `rancher_backup_count` | Number of existing Rancher Backup CRs. Type *Gauge*. |
| `rancher_backups_attempted_total` | Total number of Rancher Backups processed by the Operator (labels: `name`). Type *CounterVec*. |
| `rancher_backups_failed_total` | Total number of failed Rancher Backups processed by this operator (labels: `name`). Type *CounterVec*. |
| `rancher_backup_duration_seconds` | Duration of each backup processed by the Operator in seconds (labels: `name`). Type *HistogramVec*, buckets can be customized by the user. |
| `rancher_backup_last_processed_timestamp_seconds` | Unix time of when the last Backup was processed (in seconds) (labels: `name`). Type *GaugeVec*. |
| `rancher_restore_info` | Details on a specific Rancher Restore CR (labels: `name`, `status`, `fileName`, `prune`, `storageLocation`, `restoreTime`). Type *GaugeVec*. |
| `rancher_restore_count` | Number of existing Rancher Restore CRs. Type *Gauge*. |
### Alerting
Only one alert is provided by default, 'BackupFailed', which warns users when a Backup fails to be processed by the Operator. It can be enabled by setting `monitoring.prometheusRules.defaultAlert.enabled: true`.
Users can also deploy their own alerting rules by setting `monitoring.prometheusRules.customRules.enabled: true` and defining them under `monitoring.prometheusRules.customRules.rules`.
### Dashboards
Rancher also provides Grafana dashboards to help monitor the Backup Operator health. These, however, can only be deployed by the *rancher-monitoring* Helm Chart. To do so `rancherBackupMonitoring.dashboards.enabled: true` needs to be set.
## Conclusion
Rancher Backups is a very useful tool, however it is somewhat limited in its scope and intended purposes. In order to avoid possible difficulties, it is important to follow the specific procedures described to ensure the proper operation of the chart.
@@ -1,63 +0,0 @@
---
title: Creating an Aliyun ACK Cluster
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba"/>
</head>
You can use Rancher to create a cluster hosted in Alibaba Cloud Kubernetes (ACK). Rancher has already implemented and packaged the [cluster driver](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md) for ACK, but by default, this cluster driver is `inactive`. In order to launch ACK clusters, you will need to [enable the ACK cluster driver](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#activatingdeactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning ACK clusters.
## Prerequisites Outside of Rancher
:::caution
Deploying to ACK will incur charges.
:::
1. In Aliyun, activate the following services in their respective consoles.
- [Container Service](https://cs.console.aliyun.com)
- [Resource Orchestration Service](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. Make sure that the account you will be using to create the ACK cluster has the appropriate permissions. Referring to the official Alibaba Cloud documentation about [Role authorization](https://www.alibabacloud.com/help/doc-detail/86483.htm) and [Use the Container Service console as a RAM user](https://www.alibabacloud.com/help/doc-detail/86484.htm) for details.
3. In Alibaba Cloud, create an [access key](https://www.alibabacloud.com/help/doc-detail/53045.html).
4. In Alibaba Cloud, create an [SSH key pair](https://www.alibabacloud.com/help/doc-detail/51793.html). This key is used to access nodes in the Kubernetes cluster.
## Prerequisite in Rancher
You will need to enable the Alibaba ACK cluster driver:
1. Click **☰ > Cluster Management**.
1. Click **Drivers**.
1. In the **Cluster Drivers** tab, go to the **Alibaba ACK** cluster driver and click **⋮ > Activate**.
When the cluster driver is finished downloading, you will be able to create Alibaba ACK clusters in Rancher.
## Create an ACK Cluster
1. Click **☰ > Cluster Management**.
1. From the **Clusters** page, click **Create**.
1. Choose **Alibaba ACK**.
1. Enter a **Cluster Name**.
1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user.
1. Configure **Account Access** for the ACK cluster. Choose the geographical region in which to build your cluster, and input the access key that was created as part of the prerequisite steps.
1. Click **Next: Configure Cluster**, then choose cluster type, the version of Kubernetes and the availability zone.
1. If you choose **Kubernetes** as the cluster type, Click **Next: Configure Master Nodes**, then complete the **Master Nodes** form.
1. Click **Next: Configure Worker Nodes**, then complete the **Worker Nodes** form.
1. Review your options to confirm they're correct. Then click **Create**.
**Result:**
Your cluster is created and assigned a state of **Provisioning**. Rancher is standing up your cluster.
You can access your cluster after its state is updated to **Active**.
**Active** clusters are assigned two Projects:
- `Default`, containing the `default` namespace
- `System`, containing the `cattle-system`, `ingress-nginx`, `kube-public`, and `kube-system` namespaces
@@ -1,104 +0,0 @@
---
title: Creating a Huawei CCE Cluster
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei"/>
</head>
You can use Rancher to create a cluster hosted in Huawei Cloud Container Engine (CCE). Rancher has already implemented and packaged the [cluster driver](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md) for CCE, but by default, this cluster driver is `inactive`. In order to launch CCE clusters, you will need to [enable the CCE cluster driver](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#activatingdeactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning CCE clusters.
## Prerequisites in Huawei
:::caution
Deploying to CCE will incur charges.
:::
1. Find your project ID in Huawei CCE portal. See the CCE documentation on how to [manage your projects](https://doc.hcs.huawei.com/api/cce/cce_02_0341.html#cce_02_0341__section17571944123214).
2. Create an [Access Key ID and Secret Access Key](https://support.huaweicloud.com/en-us/usermanual-iam/en-us_topic_0079477318.html).
## Prerequisite in Rancher
You will need to enable the Huawei CCE cluster driver:
1. Click **☰ > Cluster Management**.
1. Click **Drivers**.
1. In the **Cluster Drivers** tab, go to the **Huawei CCE** cluster driver and click **⋮ > Activate**.
When the cluster driver is finished downloading, you will be able to create Huawei CCE clusters in Rancher.
## Limitations
Huawei CCE service doesn't support the ability to create clusters with public access through their API. You are required to run Rancher in the same VPC as the CCE clusters that you want to provision.
## Create the CCE Cluster
1. From the **Clusters** page, click **Create**.
1. Click **Huawei CCE**.
1. Enter a **Cluster Name**.
1. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user.
1. Enter **Project Id**, Access Key ID as **Access Key** and Secret Access Key **Secret Key**. Then Click **Next: Configure cluster**. Fill in the cluster configuration. For help filling out the form, refer to [Huawei CCE Configuration.](#huawei-cce-configuration)
1. Fill the following node configuration of the cluster. For help filling out the form, refer to [Node Configuration.](#node-configuration)
1. Click **Create** to create the CCE cluster.
**Result:**
Your cluster is created and assigned a state of **Provisioning**. Rancher is standing up your cluster.
You can access your cluster after its state is updated to **Active**.
**Active** clusters are assigned two Projects:
- `Default`, containing the `default` namespace
- `System`, containing the `cattle-system`, `ingress-nginx`, `kube-public`, and `kube-system` namespaces
## Huawei CCE Configuration
|Settings|Description|
|---|---|
| Cluster Type | Which type or node you want to include into the cluster, `VirtualMachine` or `BareMetal`. |
| Description | The description of the cluster. |
| Master Version | The Kubernetes version. |
| Management Scale Count | The max node count of the cluster. The options are 50, 200 and 1000. The larger of the scale count, the more the cost. |
| High Availability | Enable master node high availability. The cluster with high availability enabled will have more cost. |
| Container Network Mode | The network mode used in the cluster. `overlay_l2` and `vpc-router` is supported in `VirtualMachine` type and `underlay_ipvlan` is supported in `BareMetal` type |
| Container Network CIDR | Network CIDR for the cluster. |
| VPC Name | The VPC name which the cluster is going to deploy into. Rancher will create one if it is blank. |
| Subnet Name | The Subnet name which the cluster is going to deploy into. Rancher will create one if it is blank. |
| External Server | This option is reserved for the future we can enable CCE cluster public access via API. For now, it is always disabled. |
| Cluster Label | The labels for the cluster. |
| Highway Subnet | This option is only supported in `BareMetal` type. It requires you to select a VPC with high network speed for the bare metal machines. |
:::note
If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#config-file-structure-in-rancher)
:::
## Node Configuration
|Settings|Description|
|---|---|
| Zone | The available zone at where the node(s) of the cluster is deployed. |
| Billing Mode | The bill mode for the cluster node(s). In `VirtualMachine` type, only `Pay-per-use` is supported. in `BareMetal`, you can choose `Pay-per-use` or `Yearly/Monthly`. |
| Validity Period | This option only shows in `Yearly/Monthly` bill mode. It means how long you want to pay for the cluster node(s). |
| Auto Renew | This option only shows in `Yearly/Monthly` bill mode. It means that the cluster node(s) will renew the `Yearly/Monthly` payment automatically or not. |
| Data Volume Type | Data volume type for the cluster node(s). `SATA`, `SSD` or `SAS` for this option. |
| Data Volume Size | Data volume size for the cluster node(s) |
| Root Volume Type | Root volume type for the cluster node(s). `SATA`, `SSD` or `SAS` for this option. |
| Root Volume Size | Root volume size for the cluster node(s) |
| Node Flavor | The node flavor of the cluster node(s). The flavor list in Rancher UI is fetched from Huawei Cloud. It includes all the supported node flavors. |
| Node Count | The node count of the cluster |
| Node Operating System | The operating system for the cluster node(s). Only `EulerOS 2.2` and `CentOS 7.4` are supported right now. |
| SSH Key Name | The ssh key for the cluster node(s) |
| EIP | The public IP options for the cluster node(s). `Disabled` means that the cluster node(s) are not going to bind a public IP. `Create EIP` means that the cluster node(s) will bind one or many newly created Eips after provisioned and more options will be shown in the UI to set the to-create EIP parameters. And `Select Existed EIP` means that the node(s) will bind to the EIPs you select. |
| EIP Count | This option will only be shown when `Create EIP` is selected. It means how many EIPs you want to create for the node(s). |
| EIP Type | This option will only be shown when `Create EIP` is selected. The options are `5_bgp` and `5_sbgp`. |
| EIP Share Type | This option will only be shown when `Create EIP` is selected. The only option is `PER`. |
| EIP Charge Mode | This option will only be shown when `Create EIP` is selected. The options are pay by `BandWidth` and pay by `Traffic`. |
| EIP Bandwidth Size | This option will only be shown when `Create EIP` is selected. The BandWidth of the EIPs. |
| Authentication Mode | It means enabling `RBAC` or also enabling `Authenticating Proxy`. If you select `Authenticating Proxy`, the certificate which is used for authenticating proxy will be also required. |
| Node Label | The labels for the cluster node(s). Invalid labels can prevent upgrades or can prevent Rancher from starting. For details on label syntax requirements, see the [Kubernetes documentation.](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set) |
@@ -17,9 +17,6 @@ Rancher supports the following Kubernetes providers:
- [Google GKE (Google Kubernetes Engine)](https://cloud.google.com/kubernetes-engine/)
- [Amazon EKS (Amazon Elastic Container Service for Kubernetes)](https://aws.amazon.com/eks/)
- [Microsoft AKS (Azure Kubernetes Service)](https://azure.microsoft.com/en-us/services/kubernetes-service/)
- [Alibaba ACK (Alibaba Cloud Container Service for Kubernetes)](https://www.alibabacloud.com/product/kubernetes)
- [Tencent TKE (Tencent Kubernetes Engine)](https://intl.cloud.tencent.com/product/tke)
- [Huawei CCE (Huawei Cloud Container Engine)](https://www.huaweicloud.com/en-us/product/cce.html)
## Hosted Kubernetes Provider Authentication
@@ -28,6 +25,3 @@ When using Rancher to create a cluster hosted by a provider, you are prompted fo
- [Creating a GKE Cluster](gke.md)
- [Creating an EKS Cluster](eks.md)
- [Creating an AKS Cluster](aks.md)
- [Creating an ACK Cluster](alibaba.md)
- [Creating a TKE Cluster](tencent.md)
- [Creating a CCE Cluster](huawei.md)
@@ -1,103 +0,0 @@
---
title: Creating a Tencent TKE Cluster
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent"/>
</head>
You can use Rancher to create a cluster hosted in Tencent Kubernetes Engine (TKE). Rancher has already implemented and packaged the [cluster driver](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md) for TKE, but by default, this cluster driver is `inactive`. In order to launch TKE clusters, you will need to [enable the TKE cluster driver](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#activatingdeactivating-cluster-drivers). After enabling the cluster driver, you can start provisioning TKE clusters.
## Prerequisites in Tencent
:::caution
Deploying to TKE will incur charges.
:::
1. Make sure that the account you will be using to create the TKE cluster has the appropriate permissions by referring to the [Cloud Access Management](https://intl.cloud.tencent.com/document/product/598/10600) documentation for details.
2. Create a [Cloud API Secret ID and Secret Key](https://console.cloud.tencent.com/capi).
3. Create a [Private Network and Subnet](https://intl.cloud.tencent.com/document/product/215/4927) in the region that you want to deploy your Kubernetes cluster.
4. Create a [SSH key pair](https://intl.cloud.tencent.com/document/product/213/6092). This key is used to access the nodes in the Kubernetes cluster.
## Prerequisite in Rancher
You will need to enable the Tencent TKE cluster driver:
1. Click **☰ > Cluster Management**.
1. Click **Drivers**.
1. In the **Cluster Drivers** tab, go to the **Tencent TKE** cluster driver and click **⋮ > Activate**.
When the cluster driver is finished downloading, you will be able to create Tencent TKE clusters in Rancher.
## Create a TKE Cluster
1. From the **Clusters** page, click **Create**.
2. Choose **Tencent TKE**.
3. Enter a **Cluster Name**.
4. Use **Member Roles** to configure user authorization for the cluster. Click **Add Member** to add users that can access the cluster. Use the **Role** drop-down to set permissions for each user.
5. Configure **Account Access** for the TKE cluster. Complete each drop-down and field using the information obtained in [Prerequisites](#prerequisites-in-tencent).
| Option | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Region | From the drop-down chooses the geographical region in which to build your cluster. |
| Secret ID | Enter the Secret ID that you obtained from the Tencent Cloud Console. |
| Secret Key | Enter the Secret key that you obtained from Tencent Cloud Console. |
6. Click `Next: Configure Cluster` to set your TKE cluster configurations.
| Option | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Kubernetes Version | The TKE only supports Kubernetes version 1.10.5 now. |
| Node Count | Enter the amount of worker node you want to purchase for your Kubernetes cluster, up to 100. |
| VPC | Select the VPC name that you have created in the Tencent Cloud Console. |
| Container Network CIDR | Enter the CIDR range of your Kubernetes cluster, you may check the available range of the CIDR in the VPC service of the Tencent Cloud Console. Default to 172.16.0.0/16. |
:::note
If you are editing the cluster in the `cluster.yml` instead of the Rancher UI, note that, cluster configuration directives must be nested under the `rancher_kubernetes_engine_config` directive in `cluster.yml`. For more information, refer to the section on [the config file structure in Rancher v2.3.0+.](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#config-file-structure-in-rancher)
:::
7. Click `Next: Select Instance Type` to choose the instance type that will use for your TKE cluster.
| Option | Description |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Availability Zone | Choose the availability zone of the VPC region. |
| Subnet | Select the Subnet that you have created within the VPC, and add a new one if you don't have it in the chosen availability zone. |
| Instance Type | From the drop-down chooses the VM instance type that you want to use for the TKE cluster, default to S2.MEDIUM4 (CPU 2 Memory 4 GiB). |
8. Click `Next: Configure Instance` to configure the VM instance that will use for your TKE cluster.
Option | Description
-------|------------
Operating System | The name of the operating system, currently supports Centos7.2x86_64 or ubuntu16.04.1 LTSx86_64
Security Group | Security group ID, default does not bind any security groups.
Root Disk Type | System disk type. System disk type restrictions are detailed in the [CVM instance configuration](https://cloud.tencent.com/document/product/213/11518).
Root Disk Size | System disk size. Linux system adjustment range is 20 - 50G, step size is 1.
Data Disk Type | Data disk type, default value to the SSD cloud drive
Data Disk Size | Data disk size (GB), the step size is 10
Band Width Type | Type of bandwidth, PayByTraffic or PayByHour
Band Width | Public network bandwidth (Mbps)
Key Pair | Key id, after associating the key can be used to logging to the VM node
9. Click **Create**.
**Result:**
Your cluster is created and assigned a state of **Provisioning**. Rancher is standing up your cluster.
You can access your cluster after its state is updated to **Active**.
**Active** clusters are assigned two Projects:
- `Default`, containing the `default` namespace
- `System`, containing the `cattle-system`, `ingress-nginx`, `kube-public`, and `kube-system` namespaces
@@ -6,41 +6,11 @@ title: Launching Kubernetes with Rancher
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher"/>
</head>
You can have Rancher launch a Kubernetes cluster using any nodes you want. When Rancher deploys Kubernetes onto these nodes, you can choose between [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) or [RKE2](https://docs.rke2.io) distributions. Rancher can launch Kubernetes on any computers, including:
- Bare-metal servers
- On-premise virtual machines
- Virtual machines hosted by an infrastructure provider
Rancher allows you to launch a Kubernetes cluster on different types of nodes, including bare-metal servers, on-premise virtual machines, and virtual machines from an infrastructure provider. When deploying Kubernetes to these nodes, Rancher gives you the option to use [RKE2](https://docs.rke2.io).
Rancher can install Kubernetes on existing nodes, or it can dynamically provision nodes in an infrastructure provider and install Kubernetes on them.
Rancher can also create pools of nodes. One benefit of installing Kubernetes on node pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the node pool is as expected.
## RKE
### Requirements
If you use RKE to set up a cluster, your nodes must meet the [requirements](../kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md) for nodes in downstream user clusters.
### Launching Kubernetes on New Nodes in an Infrastructure Provider
Using Rancher, you can create pools of nodes based on a [node template](use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#node-templates). This node template defines the parameters you want to use to launch nodes in your cloud providers.
One benefit of installing Kubernetes on node pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the node pool is as expected.
For more information, refer to the section on [launching Kubernetes on new nodes.](use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)
### Launching Kubernetes on Existing Custom Nodes
In this scenario, you want to install Kubernetes on bare-metal servers, on-prem virtual machines, or virtual machines that already exist in a cloud provider. With this option, you will run a Rancher agent Docker container on the machine.
If you want to reuse a node from a previous custom cluster, [clean the node](../manage-clusters/clean-cluster-nodes.md) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail.
For more information, refer to the section on [custom nodes.](../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md)
### Programmatically Creating RKE Clusters
The most common way to programmatically deploy RKE clusters through Rancher is by using the Rancher2 Terraform provider. The documentation for creating clusters with Terraform is [here.](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster)
Rancher can also create pools of machines. One benefit of installing Kubernetes on machine pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the machine pool is as expected.
## RKE2
@@ -54,11 +24,17 @@ If you use RKE2 to set up a cluster, your nodes must meet the [requirements](htt
### Launching Kubernetes on New Nodes in an Infrastructure Provider
RKE2 provisioning is built on top of a new provisioning framework that leverages the upstream [Cluster API](https://github.com/kubernetes-sigs/cluster-api) project. With this new provisioning framework, you can:
RKE2 provisioning is built on top of a new provisioning framework that leverages the upstream [Cluster API (CAPI)](https://github.com/kubernetes-sigs/cluster-api) project. With this new provisioning framework, you can:
- Provision RKE2 clusters onto any provider for which Rancher has a node driver
- Fully configure RKE2 clusters within Rancher
- Choose CNI options Calico, Cilium, and Multus in addition to Canal
- Provision RKE2 clusters onto any provider for which Rancher has a node driver.
- Fully configure RKE2 clusters within Rancher.
- Choose CNI options Calico, Cilium, and Multus in addition to Canal.
When you make changes to your cluster configuration in RKE2, this may result in nodes reprovisioning. This is controlled by CAPI controllers and not by Rancher itself. Note that for etcd nodes, the same behavior does not apply.
The following are some specific example configuration changes that may cause the described behavior:
- When editing the cluster and enabling drain before delete, the existing control plane nodes and worker are deleted and new nodes are created.
RKE2 provisioning also includes installing RKE2 on clusters with Windows nodes.
@@ -75,10 +51,10 @@ Windows Support for RKE2 Custom Clusters requires choosing Calico as the CNI.
### Launching Kubernetes on Existing Custom Nodes
RKE2 provisioning also allows you to install custom clusters on pre-provisioned VMs or bare-metal nodes.
RKE2 provisioning also allows you to install custom clusters on previously provisioned VMs or bare-metal nodes.
If you want to reuse a node from a previous custom cluster, clean the node before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail.
If you want to reuse a node from a previous custom cluster, [clean the node](../manage-clusters/clean-cluster-nodes.md#cleaning-up-nodes) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail.
### Programmatically Creating RKE2 Clusters
The most common way to programmatically deploy RKE2 clusters through Rancher is by using the Rancher2 Terraform provider. The documentation for creating clusters with Terraform is [here.](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2)
The most common way to programmatically deploy RKE2 clusters through Rancher is by using the [Rancher2 Terraform provider](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2).
@@ -73,7 +73,7 @@ CURRENT NAME CLUSTER AUTHINFO N
In this example, when you use `kubectl` with the first context, `my-cluster`, you will be authenticated through the Rancher server.
With the second context, `my-cluster-controlplane-1`, you would authenticate with the authorized cluster endpoint, communicating with an downstream RKE/K3s cluster directly.
With the second context, `my-cluster-controlplane-1`, you would authenticate with the authorized cluster endpoint, communicating with an downstream RKE2/K3s cluster directly.
We recommend using a load balancer with the authorized cluster endpoint. For details, refer to the [recommended architecture section.](../../../../reference-guides/rancher-manager-architecture/architecture-recommendations.md#architecture-for-an-authorized-cluster-endpoint-ace)
@@ -19,6 +19,7 @@ In order to deploy and run the adapter successfully, you need to ensure its vers
| Rancher Version | Adapter Version |
|-----------------|------------------|
| v2.12.1 | 107.0.0+up7.0.0 |
| v2.12.0 | 107.0.0+up7.0.0 |
### 1. Gain Access to the Local Cluster
@@ -59,7 +59,6 @@ The following table summarizes the sources where additional logs may be collecte
| Logging Source | Linux Nodes (including in Windows cluster) | Windows Nodes |
| --- | --- | ---|
| RKE | ✓ | ✓ |
| RKE2 | ✓ | |
| K3s | ✓ | |
| AKS | ✓ | |
@@ -216,8 +216,7 @@ The following Kubernetes components are directly scraped by Prometheus:
\* You can optionally use `hardenedKubelet.enabled` to use a PushProx, but that is not the default.
** For RKE and RKE2 clusters, ingress-nginx is deployed by default and treated as an internal Kubernetes component.
** For RKE2 clusters, ingress-nginx is deployed by default and treated as an internal Kubernetes component.
### Scraping Metrics Based on Kubernetes Distribution
@@ -225,18 +224,18 @@ Metrics are scraped differently based on the Kubernetes distribution. For help w
<figcaption>How Metrics are Exposed to Prometheus</figcaption>
| Kubernetes Component | RKE | RKE2 | KubeADM | K3s |
| Kubernetes Component | RKE2 | KubeADM | K3s |
|-----|-----|-----|-----|-----|
| kube-controller-manager | rkeControllerManager.enabled |rke2ControllerManager.enabled | kubeAdmControllerManager.enabled | k3sServer.enabled |
| kube-scheduler | rkeScheduler.enabled | rke2Scheduler.enabled |kubeAdmScheduler.enabled | k3sServer.enabled |
| etcd | rkeEtcd.enabled | rke2Etcd.enabled | kubeAdmEtcd.enabled | Not available |
| kube-proxy | rkeProxy.enabled | rke2Proxy.enabled | kubeAdmProxy.enabled | k3sServer.enabled |
| kubelet | Collects metrics directly exposed by kubelet | Collects metrics directly exposed by kubelet | Collects metrics directly exposed by kubelet | Collects metrics directly exposed by kubelet |
| ingress-nginx* | Collects metrics directly exposed by kubelet, exposed by rkeIngressNginx.enabled | Collects metrics directly exposed by kubelet, Exposed by rke2IngressNginx.enabled | Not available | Not available |
| coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns |
| kube-api-server | Collects metrics directly exposed by kube-api-server |Collects metrics directly exposed by kube-api-server | Collects metrics directly exposed by kube-appi-server | Collects metrics directly exposed by kube-api-server |
| kube-controller-manager | rke2ControllerManager.enabled | kubeAdmControllerManager.enabled | k3sServer.enabled |
| kube-scheduler | rke2Scheduler.enabled |kubeAdmScheduler.enabled | k3sServer.enabled |
| etcd | rke2Etcd.enabled | kubeAdmEtcd.enabled | Not available |
| kube-proxy | rke2Proxy.enabled | kubeAdmProxy.enabled | k3sServer.enabled |
| kubelet | Collects metrics directly exposed by kubelet | Collects metrics directly exposed by kubelet | Collects metrics directly exposed by kubelet |
| ingress-nginx* | Collects metrics directly exposed by kubelet, Exposed by rke2IngressNginx.enabled | Not available | Not available |
| coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns | Collects metrics directly exposed by coreDns/kubeDns |
| kube-api-server | Collects metrics directly exposed by kube-api-server | Collects metrics directly exposed by kube-appi-server | Collects metrics directly exposed by kube-api-server |
\* For RKE and RKE2 clusters, ingress-nginx is deployed by default and treated as an internal Kubernetes component.
\* For RKE2 clusters, ingress-nginx is deployed by default and treated as an internal Kubernetes component.
### Terminology
@@ -91,8 +91,6 @@ For more information on `rancher-monitoring` chart options, including options to
## Windows Cluster Support
When deployed onto an RKE1 Windows cluster, Monitoring V2 will now automatically deploy a [windows-exporter](https://github.com/prometheus-community/windows_exporter) DaemonSet and set up a ServiceMonitor to collect metrics from each of the deployed Pods. This will populate Prometheus with `windows_` metrics that are akin to the `node_` metrics exported by [node_exporter](https://github.com/prometheus/node_exporter) for Linux hosts.
To be able to fully deploy Monitoring V2 for Windows, all of your Windows hosts must have a minimum [wins](https://github.com/rancher/wins) version of v0.1.0.
For more details on how to upgrade wins on existing Windows hosts, see [Windows cluster support for Monitoring V2.](windows-support.md).
@@ -12,8 +12,6 @@ Monitoring V2 can be deployed on a Windows cluster to scrape metrics from Window
Monitoring V2 for Windows can only scrape metrics from Windows hosts that have a minimum `wins` version of v0.1.0. To be able to fully deploy Monitoring V2 for Windows, all of your hosts must meet this requirement.
If you provision a fresh RKE1 cluster in Rancher 2.5.8, your cluster should already meet this requirement.
### Upgrading Existing Clusters to wins v0.1.0
If the cluster was provisioned before Rancher 2.5.8 (even if the current Rancher version is 2.5.8), you will not be able to successfully deploy Monitoring V2 for Windows until you upgrade the wins version on each host to at least v0.1.0.
@@ -21,6 +19,7 @@ If the cluster was provisioned before Rancher 2.5.8 (even if the current Rancher
To facilitate this upgrade, Rancher 2.5.8 has released a brand new Helm chart called `rancher-wins-upgrader`.
1. Deploy `rancher-wins-upgrader` with the following override:
```yaml
# Masquerading bootstraps the wins-upgrader installation via
# a previously whitelisted process path since the normal install path,
@@ -31,15 +30,9 @@ To facilitate this upgrade, Rancher 2.5.8 has released a brand new Helm chart ca
enabled: true
as: c:\\etc\wmi-exporter\wmi-exporter.exe
```
:::note Note for Non-Default Windows Prefix Path:
- If you set up the RKE cluster with a `cluster.yml` that has a non-default `win_prefix_path`, you will need to update the `masquerade.as` field with your prefix path in place of `c:\\`.
- For example, if you have `win_prefix_path: 'c:\host\opt\'`, then you will need to set `as: c:\host\opt\etc\wmi-exporter\wmi-exporter.exe`.
:::
2. Once all your hosts have been successfully upgraded, please ensure that you deploy the Helm chart once again with default values to avoid conflicts with the following settings:
```yaml
masquerade:
enabled: false
@@ -23,17 +23,16 @@ The Harvester Helm Chart is used to manage access to the NeuVector UI in Rancher
Some examples are as follows:
- RKE1: `docker`
- K3s and RKE2: `k3scontainerd`
- AKS: `containerd` for v1.19 and up
- EKS: `docker` for v1.22 and below; `containerd` for v1.23 and up
- GKE: `containerd` (see the [Google docs](https://cloud.google.com/kubernetes-engine/docs/concepts/using-containerd) for more)
- K3s and RKE2: `k3scontainerd`
- AKS: `containerd` for v1.19 and up
- EKS: `docker` for v1.22 and below; `containerd` for v1.23 and up
- GKE: `containerd` (see the [Google docs](https://cloud.google.com/kubernetes-engine/docs/concepts/using-containerd) for more)
:::note
:::note
Only one container runtime engine may be selected at a time during installation.
Only one container runtime engine may be selected at a time during installation.
:::
:::
**To navigate to and install the NeuVector chart through Cluster Tools:**
@@ -102,63 +101,36 @@ Below are the minimum recommended computing resources for the NeuVector chart in
\* Minimum 1GB of memory total required for Controller, Manager, and Scanner containers combined.
## Hardened Cluster Support - Calico and Canal
<Tabs>
<TabItem value="RKE1">
NeuVector components Controller and Enforcer are deployable if PSP is set to true.
- All NeuVector components are deployable if PSP is set to true.
**Applicable to NeuVector chart version 100.0.0+up2.2.0 only:**
You will need to set additional configuration for your hardened cluster environment as follows:
For Manager, Scanner, and Updater components, additional configuration is required as shown below:
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps**.
1. Install (or upgrade to) NeuVector version `100.0.1+up2.2.2`.
```sh
kubectl patch deploy neuvector-manager-pod -n cattle-neuvector-system --patch '{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}'
kubectl patch deploy neuvector-scanner-pod -n cattle-neuvector-system --patch '{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}'
kubectl patch cronjob neuvector-updater-pod -n cattle-neuvector-system --patch '{"spec":{"jobTemplate":{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}}}'
```
- Under **Edit Options** > **Other Configuration**, enable **Pod Security Policy** by checking the box (no other config needed):
You will need to set additional configuration for your hardened cluster environment.
![Enable PSP for RKE1 Hardened Cluster](/img/psp-nv-rke.png)
:::note
You must update your config in both RKE2 and K3s hardened clusters as shown below.
:::
1. Click **Install** at the bottom-right to complete.
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps**.
1. Install (or upgrade to) NeuVector version `100.0.1+up2.2.2`.
- Under **Edit Options** > **Other Configuration**, enable **Pod Security Policy** by checking the box. Note that you must also enter a value greater than `zero` for `Manager runAsUser ID`, `Scanner runAsUser ID`, and `Updater runAsUser ID`:
</TabItem>
<TabItem value="RKE2">
- NeuVector components Controller and Enforcer are deployable if PSP is set to true.
**Applicable to NeuVector chart version 100.0.0+up2.2.0 only:**
- For Manager, Scanner, and Updater components, additional configuration is required as shown below:
```
kubectl patch deploy neuvector-manager-pod -n cattle-neuvector-system --patch '{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}'
kubectl patch deploy neuvector-scanner-pod -n cattle-neuvector-system --patch '{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}'
kubectl patch cronjob neuvector-updater-pod -n cattle-neuvector-system --patch '{"spec":{"jobTemplate":{"spec":{"template":{"spec":{"securityContext":{"runAsUser": 5400}}}}}}}'
```
<br/>
You will need to set additional configuration for your hardened cluster environment.
>**Note:** You must update your config in both RKE2 and K3s hardened clusters as shown below.
1. Click **☰ > Cluster Management**.
1. Go to the cluster that you created and click **Explore**.
1. In the left navigation bar, click **Apps**.
1. Install (or upgrade to) NeuVector version `100.0.1+up2.2.2`.
- Under **Edit Options** > **Other Configuration**, enable **Pod Security Policy** by checking the box. Note that you must also enter a value greater than `zero` for `Manager runAsUser ID`, `Scanner runAsUser ID`, and `Updater runAsUser ID`:
![Enable PSP for RKE2 and K3s Hardened Clusters](/img/psp-nv-rke2.png)
1. Click **Install** at the bottom-right to complete.
</TabItem>
</Tabs>
![Enable PSP for RKE2 and K3s Hardened Clusters](/img/psp-nv-rke2.png)
1. Click **Install** at the bottom-right to complete.
## SELinux-enabled Cluster Support - Calico and Canal
@@ -193,6 +193,12 @@ Rancher can dynamically provision nodes in a provider such as Amazon EC2, Digita
Rancher provisions this type of cluster using [docker-machine.](https://github.com/rancher/machine)
### Rancher Launched Kubernetes for Custom Nodes
When setting up this type of cluster, Rancher installs Kubernetes on existing nodes, which creates a custom cluster.
Rancher provisions this type of cluster using https://github.com/rancher/rke2[RKE2] or https://github.com/rancher/k3s[K3s].
### Hosted Kubernetes Providers
When setting up this type of cluster, Kubernetes is installed by providers such as Google Kubernetes Engine, Amazon Elastic Container Service for Kubernetes, or Azure Kubernetes Service.
+1
View File
@@ -20,6 +20,7 @@ Each Rancher version is designed to be compatible with a single version of the w
| Rancher Version | Webhook Version | Availability in Prime | Availability in Community |
|-----------------|-----------------|-----------------------|---------------------------|
| v2.12.1 | v0.8.1 | &check; | &check; |
| v2.12.0 | v0.8.0 | &cross; | &check; |
## Why Do We Need It?
@@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/
| Patch 版本 | 发布时间 |
| ----------------------------------------------------------------- | ------------------ |
| [2.12.1](https://github.com/rancher/rancher/releases/tag/v2.12.1) | 2025 年 8 月 28 日 |
| [2.12.0](https://github.com/rancher/rancher/releases/tag/v2.12.0) | 2025 年 7 月 30 日 |
## 当一个功能被标记为弃用我可以得到什么样的预期?
@@ -20,7 +20,6 @@ Rancher 可以安装在任何 Kubernetes 集群上。这个集群可以使用上
你可参考以下教程,以获得设置 Kubernetes 集群的帮助:
- **RKE**:[安装 RKE Kubernetes 集群的教程](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher.md);[为高可用 RKE 集群设置基础设施的教程](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md)。
- **K3s**:[安装 K3s Kubernetes 集群的教程](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md);[设置高可用 K3s 集群的基础设施的教程](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md)。
- **RKE2:** :[安装 RKE2 Kubernetes 集群的教程](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md);[设置高可用 RKE2 集群的基础设施的教程](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md)。
- **Amazon EKS**:[在 Amazon EKS 上安装 Rancher 以及如何安装 Ingress Controller 以访问 Rancher Server](rancher-on-amazon-eks.md)。
@@ -32,7 +31,7 @@ Rancher 可以安装在任何 Kubernetes 集群上。这个集群可以使用上
Rancher UI 和 API 通过 Ingress 公开。换言之,安装 Rancher 的 Kubernetes 集群必须包含一个 Ingress Controller。
对于 RKE、RKE2 和 K3s,你不需要手动安装 Ingress Controller,因为它是默认安装的。
对于 RKE2 和 K3s,你不需要手动安装 Ingress Controller,因为它是默认安装的。
对于默认不包含 Ingress Controller 的发行版(例如 EKS、GKE 或 AKS 等托管 Kubernetes 集群),你必须先部署 Ingress Controller。请注意,Rancher Helm Chart 默认情况下不会在 Ingress 上设置 `ingressClassName`。因此,你必须将 Ingress Controller 配置为在没有 `ingressClassName` 的情况下也可以监视 Ingress。
@@ -171,18 +171,10 @@ $ nc xxx.xxx.xxx.xxx 22
SSH-2.0-OpenSSH_6.6.1p1 Ubuntu-2ubuntu2.10
```
## Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: Error configuring SSH: ssh: no key found
`ssh_key_path` 密钥文件无法访问:请确保你已经指定了私钥文件(不是公钥 `.pub`),而且运行 `rke` 命令的用户可以访问该私钥文件。
## Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey], no supported methods remain
`ssh_key_path` 密钥文件不是访问节点的正确文件:请仔细检查,确保你已为节点指定了正确的 `ssh_key_path` 和连接用户。
## Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: Error configuring SSH: ssh: cannot decode encrypted private keys
如需使用加密的私钥,请使用 `ssh-agent` 来使用密码来加载密钥。如果在运行 `rke` 命令的环境中找到 `SSH_AUTH_SOCK` 环境变量,它将自动用于连接到节点。
## Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
节点无法通过配置的 `address` 和 `port` 访问。
@@ -6,18 +6,15 @@ title: 升级
有关使用 Docker 安装的 Rancher 的升级说明,请参见[本页。](../other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md)
如需升级 Kubernetes 集群中的组件,或 [Kubernetes services](https://rancher.com/docs/rke/latest/en/config-options/services/) 或 [附加组件(add-on)](https://rancher.com/docs/rke/latest/en/config-options/add-ons/)的定义,请参见 [RKE 升级文档](https://rancher.com/docs/rke/latest/en/upgrades/)的 Rancher Kubernetes 引擎。
## 先决条件
### 访问 kubeconfig
### 访问 Kubeconfig
Helm 的运行位置,应该与你的 kubeconfig 文件,或你运行 kubectl 命令的位置相同。
Helm 的运行位置,应该与你的 Kubeconfig 文件,或你运行 kubectl 命令的位置相同。
如果你在安装 Kubernetes 时使用了 RKE,那么 config 将会在你运行 `rke up` 的目录下创建。
If you installed Kubernetes with RKE2/K3s, the Kubeconfig is stored in the `/etc/rancher/rke2/rke2.yaml` or `/etc/rancher/k3s/k3s.yaml` directory depending on your chosen distribution.
kubeconfig 也可以通过 `--kubeconfig` 标签(详情请参见 https://helm.sh/docs/helm/helm/ )来手动指定所需的集群。
Kubeconfig 也可以通过 `--kubeconfig` 标签(详情请参见 https://helm.sh/docs/helm/helm/ )来手动指定所需的集群。
### 查看已知问题
@@ -21,7 +21,6 @@ title: 功能开关
- `istio-virtual-service-ui`:启用[可视界面](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md)来创建、读取、更新和删除 Istio 虚拟服务和目标规则,这些都是 Istio 流量管理功能。
- `legacy`:启用 2.5.x 及更早版本的一组功能,这些功能正逐渐被新的实现淘汰。它们是已弃用以及后续可用于新版本的功能组合。新的 Rancher 安装会默认禁用此标志。如果你从以前版本的 Rancher 升级,此标志会启用。
- `multi-cluster-management`:允许配置和管理多个 Kubernetes 集群。此标志只能在安装时设置。后续无法启用或禁用它。
- `rke1-custom-node-cleanup`:清除已删除的 RKE1 自定义节点。建议你启用此标志,以防止已删除的节点尝试重新加入集群。
- `rke2`:启用配置 RKE2 集群。此标志默认启用。
- `token-hashing`:启用令牌哈希。启用后,会使用 SHA256 算法对现有 Token 和所有新 Token 进行哈希处理。一旦对 Token 进行哈希处理,就无法撤消操作。此标志在启用后无法禁用。有关详细信息,请参阅 [API 令牌](../../../api/api-tokens.md#令牌哈希)。
- `uiextension`: Enables UI extensions. This flag is enabled by default. Enabling or disabling the flag forces the Rancher pod to restart. The first time this flag is set to `true`, it creates a CRD and enables the controllers and endpoints necessary for the feature to work. If set to `false`, it disables the previously mentioned controllers and endpoints. Setting `uiextension` to `false` has no effect on the CRD -- it does not create a CRD if it does not yet exist, nor does it delete the CRD if it already exists.
@@ -38,7 +37,6 @@ title: 功能开关
| `fleet` | `true` | GA | v2.5.0 |
| `harvester` | `true` | 实验功能 | v2.6.1 |
| `legacy` | 新安装:`false`;升级:`true` | GA | v2.6.0 |
| `rke1-custom-node-cleanup` | `true` | GA | v2.6.0 |
| `rke2` | `true` | 实验功能 | v2.6.0 |
| `token-hashing` | 新安装:`false`;升级:`true` | GA | v2.6.0 |
| `uiextension` | `true` | GA | v2.9.0 | |
@@ -8,7 +8,7 @@ title: TLS 设置
当你在 Kubernetes 集群内安装 Rancher 时,TLS 会在集群的 Ingress Controller 上卸载。可用的 TLS 设置取决于使用的 Ingress Controller:
* nginx-ingress-controller(RKE1 和 RKE2 默认):[默认的 TLS 版本和密码](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-tls-version-and-ciphers)。
* nginx-ingress-controller(default RKE2 默认):[默认的 TLS 版本和密码](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-tls-version-and-ciphers)。
* traefik(K3s 默认):[TLS 选项](https://doc.traefik.io/traefik/https/tls/#tls-options)。
## 在单个 Docker 容器中运行 Rancher
@@ -6,7 +6,7 @@ Rancher 是一个为使用容器的公司打造的容器管理平台。Rancher
## Run Kubernetes Everywhere
Kubernetes 已经成为容器编排标准。现在,大多数云和虚拟化提供商都提供容器编排服务。Rancher 用户可以选择使用 Rancher Kubernetes Engine(RKE)或云 Kubernetes 服务(例如 GKE、AKS 和 EKS)创建 Kubernetes 集群,还可以导入和管理使用任何 Kubernetes 发行版或安装程序创建的现有 Kubernetes 集群。
Kubernetes 已经成为容器编排标准。现在,大多数云和虚拟化提供商都提供容器编排服务。Rancher 用户可以选择使用 Rancher Kubernetes distributions(RKE2/K3s)或云 Kubernetes 服务(例如 GKE、AKS 和 EKS)创建 Kubernetes 集群,还可以导入和管理使用任何 Kubernetes 发行版或安装程序创建的现有 Kubernetes 集群。
## 满足 IT 需求规范
@@ -54,7 +54,7 @@ Rancher API Server 是基于嵌入式 Kubernetes API Server 和 etcd 数据库
## 使用 Rancher 编辑下游集群
对于已有集群而言,可提供的选项和设置取决于你配置集群的方法。例如,只有[通过 RKE 启动](../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md)的集群才有可编辑的**集群选项**。
对于已有集群而言,可提供的选项和设置取决于你配置集群的方法。
使用 Rancher 创建集群后,集群管理员可以管理集群成员,管理节点池,或进行[其他操作](../reference-guides/cluster-configuration/cluster-configuration.md)。
@@ -27,12 +27,6 @@ Rancher 中有两种类型的驱动:
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
还有几个托管的 Kubernetes 云提供商是默认禁用的,但也打包在 Rancher 中:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
## 主机驱动
主机驱动用于配置主机,Rancher 使用这些主机启动和管理 Kubernetes 集群。主机驱动与 [Docker Machine 驱动](https://github.com/docker/docs/blob/vnext-engine/machine/drivers/index.md)相同。创建主机模板时可以显示的主机驱动,是由主机驱动的状态定义的。只有 `active` 主机驱动将显示为创建节点模板的选项。默认情况下,Rancher 与许多现有的 Docker Machine 驱动打包在一起,但你也可以创建自定义主机驱动并添加到 Rancher。
@@ -7,57 +7,6 @@ title: Pod 安全标准 (PSS) 和 Pod 安全准入 (PSA)
PSS 定义了工作负载的安全级别。PSA 描述了 Pod 安全上下文和相关字段的要求。PSA 参考 PSS 级别来定义安全限制。
#### 安装 `helm-mapkubeapis`
1. 在打算使用 `helm-mapkubeapis` 的机器上打开你的终端并安装插件:
```shell
helm plugin install https://github.com/helm/helm-mapkubeapis
```
你将看到类似于以下的输出:
```console
Downloading and installing helm-mapkubeapis v0.4.1 ...
https://github.com/helm/helm-mapkubeapis/releases/download/v0.4.1/helm-mapkubeapis_0.4.1_darwin_amd64.tar.gz
Installed plugin: mapkubeapis
```
:::info 重要提示
确保 `helm-mapkubeapis` 插件至少为 v0.4.1,因为旧版本_不_支持资源删除。
:::
1. 验证插件是否已正确安装:
```shell
helm mapkubeapis --help
```
你将看到类似于以下的输出:
```console
Map release deprecated or removed Kubernetes APIs in-place
Usage:
mapkubeapis [flags] RELEASE
Flags:
--dry-run simulate a command
-h, --help help for mapkubeapis
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--mapfile string path to the API mapping file
--namespace string namespace scope of the release
```
#### 清理损坏的版本
安装 `helm-mapkubeapis` 插件后,清理升级到 Kubernetes v1.25 后损坏的版本。
1. 打开你的首选终端并通过运行 `kubectl cluster-info` 确保终端已连接到所需集群。
1. 运行 `helm list --all-namespaces` 列出你在集群中安装的所有版本。
1. 通过运行 `helm mapkubeapis --dry-run <release-name> --namespace <release-namespace>` 为要清理的每个版本执行试运行。你可以通过此命令的结果了解要替换或删除哪些资源。
1. 最后,在查看更改后,使用 `helm mapkubeapis <release-name> --namespace <release-namespace>` 执行完整运行。
## Pod 安全准入配置模板
Rancher 提供了 PSA 配置模板。它们是可以应用到集群的预定义安全配置。Rancher 管理员(或具有权限的人员)可以[创建、管理和编辑](./psa-config-templates.md) PSA 模板。
@@ -1,59 +0,0 @@
---
title: 创建阿里云 ACK 集群
---
你可以使用 Rancher 创建托管在阿里云 Alibaba Cloud Kubernetes (ACK) 中的集群。Rancher 已经为 ACK 实现并打包了针对 ACK 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 ACK 集群,你需要[启用 ACK 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 ACK 集群。
## Rancher 之外的先决条件
:::caution
部署到 ACK 会产生费用。
:::
1. 在阿里云中,在对应的控制台中激活以下服务。
- [容器服务](https://cs.console.aliyun.com)
- [资源编排服务](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. 确保你用于创建 ACK 集群的账号具有适当的权限。详见阿里云[角色授权](https://www.alibabacloud.com/help/doc-detail/86483.htm)和[使用容器服务控制台作为 RAM 用户](https://www.alibabacloud.com/help/doc-detail/86484.htm)官方文档。
3. 在阿里云中,创建[访问密钥](https://www.alibabacloud.com/help/doc-detail/53045.html)。
4. 在阿里云中,创建 [SSH 密钥对](https://www.alibabacloud.com/help/doc-detail/51793.html)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用阿里云 ACK 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Alibaba ACK** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建阿里云 ACK 集群了。
## 创建 ACK 集群
1. 点击 **☰ > 集群管理**。
1. 在**集群**页面,点击**创建**。
1. 单击 **Alibaba ACK**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 为 ACK 集群配置**账号访问**。选择要在其中构建集群的地理区域,并输入在先决条件步骤中创建的访问密钥。
1. 点击**下一步:配置集群**,然后选择集群类型、Kubernetes 版本和可用区。
1. 如果选择 **Kubernetes** 作为集群类型,请单击**下一步:配置 master 节点**,然后填写 **master 节点**表单。
1. 单击**下一步:配置 Worker 节点**,然后填写 **Worker 节点**表单。
1. 检查并确认你的选项。然后单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -1,100 +0,0 @@
---
title: 创建华为 CCE 集群
---
你可以使用 Rancher 创建托管在华为云容器引擎 (CCE) 中的集群。Rancher 已经为 CCE 实现并打包了针对 CCE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 CCE 集群,你需要[启用 CCE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 CCE 集群。
## 华为先决条件
:::caution
部署到 CCE 会产生费用。
:::
1. 在华为 CCE 门户中找到你的项目 ID。请参阅 CCE 文档以了解如何[管理你的项目](https://doc.hcs.huawei.com/api/cce/cce_02_0341.html#cce_02_0341__section17571944123214)。
2. 创建一个[访问密钥 ID 和密文访问密钥](https://support.huaweicloud.com/en-us/usermanual-iam/en-us_topic_0079477318.html)。
## Rancher 先决条件
你需要启用华为 CCE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Huawei CCE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建华为 CCE 集群了。
## 限制
华为 CCE 服务不支持通过其 API 创建具有公共访问权限的集群。你需要在要配置的 CCE 集群的相同 VPC 中运行 Rancher。
## 创建 CCE 集群
1. 在**集群**页面,点击**创建**。
1. 单击 **Huawei CCE**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 输入**项目 ID**,访问密钥 ID,**Access Key**,和密文访问密钥 **Secret Key**。然后点击**下一步:配置集群**。填写集群配置。有关填写表单的帮助,请参阅[华为 CCE 配置](#华为-cce-配置)。
1. 填写集群的以下节点配置。有关填写表单的帮助,请参阅[节点配置](#节点配置)。
1. 点击**创建**来创建 CCE 集群。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
## 华为 CCE 配置
| 设置 | 描述 |
|---|---|
| 集群类型 | 要包含到集群的节点类型,可以是 `VirtualMachine` 或 `BareMetal`。 |
| 描述 | 集群的描述。 |
| 主版本 | Kubernetes 版本。 |
| 管理规模数量 | 集群的最大节点数。选项为 50、200 和 1000。规模计数越大,成本越高。 |
| 高可用性 | 启用 master 节点的高可用性。启用高可用性的集群成本会更高。 |
| 容器网络模式 | 集群中使用的网络模式。`VirtualMachine` 支持 `overlay_l2` 和 `vpc-router`,而 `BareMetal` 支持 `underlay_ipvlan`。 |
| 容器网络 CIDR | 集群的网络 CIDR。 |
| VPC 名称 | 要部署集群的 VPC 名称。如果留空,Rancher 将创建一个。 |
| 子网名称 | 要部署集群的子网名称。如果留空,Rancher 将创建一个。 |
| 外部服务器 | 预留选项,用于通过 API 启用 CCE 集群的公共访问。这个选项暂时是一直禁用的。 |
| 集群标签 | 集群的标签。 |
| 高速子网 | 只有 `BareMetal` 支持该选项。裸机要求选择网速高的 VPC。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅[配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
## 节点配置
| 设置 | 描述 |
|---|---|
| 地区 | 部署集群节点的可用区域。 |
| 计费方式 | 集群节点的计费模式。`VirtualMachine` 仅支持 `Pay-per-use`。`BareMetal` 支持 `Pay-per-use` 或 `Yearly/Monthly`。 |
| 有效期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示支付集群节点费用的时间。 |
| 自动续期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示是否为集群节点自动续期 `Yearly/Monthly` 计费。 |
| 数据卷类型 | 集群节点的数据卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 数据量大小 | 集群节点的数据卷大小。 |
| 根卷类型 | 集群节点的根卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 根卷大小 | 集群节点的根卷大小。 |
| 节点风格 | 集群节点的节点风格。Rancher UI 中的风格列表取自华为云。其中包括所有支持的节点风格。 |
| 节点数 | 集群的节点数 |
| 节点操作系统 | 集群节点的操作系统。目前仅支持 `EulerOS 2.2` 和 `CentOS 7.4`。 |
| SSH 密钥名称 | 集群节点的 SSH 密钥 |
| EIP | 集群节点的公共 IP 选项。`已禁用`表示集群节点不会绑定公共 IP。`创建 EIP`表示集群节点在配置后将绑定一个或多个新创建的 EIP,UI 中将显示更多用来创建 EIP 参数的选项。`选择现有 EIP` 表示节点将绑定到你选择的 EIP。 |
| EIP 数量 | 此选项仅在选择`创建 EIP`时显示。表示你要为节点创建的 EIP 数量。 |
| EIP 类型 | 此选项仅在选择`创建 EIP`时显示。可选 `5_bgp` 和 `5_sbgp`。 |
| EIP 共享类型 | 此选项仅在选择`创建 EIP`时显示。仅可选 `PER`。 |
| EIP 收费模式 | 此选项仅在选择`创建 EIP`时显示。选择按照`带宽`或`流量`计费。 |
| EIP 带宽大小 | 此选项仅在选择`创建 EIP`时显示。EIP 的带宽。 |
| 身份验证模式 | 表示启用 `RBAC`,或同时启用`认证代理`。如果选择`认证代理`,则还需要用于验证代理的证书。 |
| 节点标签 | 集群节点的标签。无效标签会阻止升级,或阻止 Rancher 启动。有关标签语法的详细信息,请参阅 [Kubernetes 文档](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。 |
@@ -17,9 +17,6 @@ Rancher 支持以下 Kubernetes 提供商:
- [Google GKE (Google Kubernetes Engine)](https://cloud.google.com/kubernetes-engine/)
- [Amazon EKS (Amazon Elastic Container Service for Kubernetes)](https://aws.amazon.com/eks/)
- [Microsoft AKS (Azure Kubernetes Service)](https://azure.microsoft.com/en-us/services/kubernetes-service/)
- [Alibaba ACK (Alibaba Cloud Container Service for Kubernetes)](https://www.alibabacloud.com/product/kubernetes)
- [Tencent TKE (Tencent Kubernetes Engine)](https://intl.cloud.tencent.com/product/tke)
- [Huawei CCE (Huawei Cloud Container Engine)](https://www.huaweicloud.com/en-us/product/cce.html)
## 托管 Kubernetes 提供商的认证
@@ -28,6 +25,3 @@ Rancher 支持以下 Kubernetes 提供商:
- [创建 GKE 集群](gke.md)
- [创建 EKS 集群](eks.md)
- [创建 AKS 集群](aks.md)
- [创建 ACK 集群](alibaba.md)
- [创建 TKE 集群](tencent.md)
- [创建 CCE 集群](huawei.md)
@@ -1,99 +0,0 @@
---
title: 创建腾讯 TKE 集群
---
你可以使用 Rancher 创建托管在腾讯 Tencent Kubernetes Engine (TKE) 中的集群。Rancher 已经为 TKE 实现并打包了针对 TKE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 TKE 集群,你需要[启用 TKE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 TKE 集群。
## 腾讯先决条件
:::caution
部署到 TKE 会产生费用。
:::
1. 参见[云访问管理](https://intl.cloud.tencent.com/document/product/598/10600)文档,确保用于创建 TKE 集群的账号具有适当的权限。
2. 创建[云 API 密钥 ID 和密钥](https://console.cloud.tencent.com/capi)。
3. 在要部署 Kubernetes 集群的区域中创建[私有网络和子网](https://intl.cloud.tencent.com/document/product/215/4927)。
4. 创建 [SSH 密钥对](https://intl.cloud.tencent.com/document/product/213/6092)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用腾讯 TKE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Tencent TKE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建腾讯 TKE 集群了。
## 创建 TKE 集群
1. 在**集群**页面,点击**创建**。
2. 选择 **Tencent TKE**。
3. 输入**集群名称**。
4. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
5. 为 TKE 集群配置**账号访问**。使用[先决条件](#腾讯先决条件)中获得的信息完成每个下拉列表和字段。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 区域 | 从下拉列表中选择构建集群的地理区域。 |
| 密文 ID | 输入从腾讯云控制台获取的密文 ID。 |
| 密文密钥 | 输入从腾讯云控制台获取的密文密钥。 |
6. 然后,单击`下一步:配置集群`来配置 TKE 集群。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Kubernetes 版本 | TKE 目前只支持 Kubernetes 1.10.5。 |
| 节点数 | 输入要为 Kubernetes 集群购买的 worker 节点数,最大值是 100。 |
| VPC | 选择在腾讯云控制台中创建的 VPC 名称。 |
| 容器网络 CIDR | 输入 Kubernetes 集群的 CIDR 范围。你可以在腾讯云控制台的 VPC 服务中查看该 CIDR 的可用范围。默认为 172.16.0.0/16。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅 [Rancher 2.3.0+ 配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
7. 点击`下一步:选择实例类型`,然后选择将用于 TKE 集群的实例类型。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 可用区 | 选择 VPC 区域的可用区。 |
| 子网 | 选择你在 VPC 中创建的子网。如果在所选可用区中没有该子网,请添加一个新子网。 |
| 实例类型 | 从下拉列表中选择要用于 TKE 集群的 VM 实例类型,默认为 S2.MEDIUM4(CPU 2;内存 4 GiB)。 |
8. 点击`下一步:配置实例`,配置用于 TKE 集群的 VM 实例。
| 选项 | 描述 |
-------|------------
| 操作系统 | 操作系统名称,目前支持 Centos7.2x86_64 或 ubuntu16.04.1 LTSx86_64。 |
| 安全组 | 安全组 ID,默认不绑定任何安全组。 |
| 根磁盘类型 | 系统盘类型。系统盘类型限制详见 [CVM 实例配置](https://cloud.tencent.com/document/product/213/11518)。 |
| 根磁盘大小 | 系统盘大小。Linux 系统调整范围为 20-50 GB,步长为 1。 |
| 数据盘类型 | 数据盘类型,默认为 SSD 云盘。 |
| 数据磁盘大小 | 数据盘大小(GB),步长为 10。 |
| 带宽类型 | 带宽收费类型,PayByTraffic 或 PayByHour。 |
| 带宽 | 公网带宽 (Mbps) |
| 密钥对 | 密钥 ID,关联后可以用来登录 VM 节点。 |
9. 单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -3,82 +3,58 @@ title: 使用 Rancher 启动 Kubernetes
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/zh/how-to-guides/new-user-guides/launch-kubernetes-with-rancher"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher"/>
</head>
Rancher 可以使用任意节点启动 Kubernetes 集群。在 Rancher 中将 Kubernetes 部署到这些节点上时,你可以选择 [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) 或 [RKE2](https://docs.rke2.io) 发行版。Rancher 可以在任何计算机上启动 Kubernetes,包括:
Rancher allows you to launch a Kubernetes cluster on different types of nodes, including bare-metal servers, on-premise virtual machines, and virtual machines from an infrastructure provider. When deploying Kubernetes to these nodes, Rancher gives you the option to use [RKE2](https://docs.rke2.io).
- 裸金属服务器
- 本地虚拟机
- 由云厂商托管的虚拟机
Rancher can install Kubernetes on existing nodes, or it can dynamically provision nodes in an infrastructure provider and install Kubernetes on them.
Rancher 可以在现有节点上安装 Kubernetes,也可以在云厂商中动态配置节点并安装 Kubernetes。
Rancher 还可以创建节点池。在托管在云厂商的节点池上安装 Kubernetes 的一个好处是,如果一个节点与集群断开连接,Rancher 可以自动创建另一个节点并将其加入集群,从而确保节点池的数量符合要求。
## RKE
### 要求
如果你使用 RKE 建立集群,节点必须满足下游集群的[节点要求](../kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md)。
### 在云厂商的新节点上启动 Kubernetes
使用 Rancher,你可以基于[节点模板](use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)创建节点池。此节点模板定义了要用于在云厂商中启动节点的参数。
在托管在云厂商的节点池上安装 Kubernetes 的一个好处是,如果一个节点与集群断开连接,Rancher 可以自动创建另一个节点并将其加入集群,从而确保节点池的数量符合要求。
有关详细信息,请参阅[在新节点上启动 Kubernetes](use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)。
### 在现有自定义节点上启动 Kubernetes
在这种情况下,你希望将 Kubernetes 安装到裸机服务器、本地虚拟机或云厂商中已存在的虚拟机上。使用此选项,你将在主机上运行 Rancher Agent Docker 容器。
如果要重复使用之前的自定义集群中的节点,请在复用之前[清理节点](../manage-clusters/clean-cluster-nodes.md)。如果你重复使用尚未清理的节点,则集群配置可能会失败。
有关详细信息,请参阅[自定义节点](../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md)。
### 以编程方式创建 RKE 集群
通过 Rancher 以编程方式部署 RKE 集群的最常见方法是使用 Rancher 2 Terraform Provider。详情请参见[使用 Terraform 创建集群](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster)。
Rancher can also create pools of machines. One benefit of installing Kubernetes on machine pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the machine pool is as expected.
## RKE2
Rancher 2.6 支持直接使用 Rancher UI 配置 [RKE2](https://docs.rke2.io/) 集群。RKE2,也称为 RKE Government,是一个完全符合标准的 Kubernetes 发行版,它专注于安全性和合规性。在 Rancher 2.6.4 及更早版本中,RKE2 配置还处于技术预览阶段。
Rancher v2.6 introduced provisioning for [RKE2](https://docs.rke2.io/) clusters directly from the Rancher UI. RKE2, also known as RKE Government, is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector. In Rancher v.2.6.4 and earlier, RKE2 provisioning was in tech preview.
在 Rancher 2.6.5 中,RKE2 已经 GA。
Note that in Rancher v2.6.5, RKE2 provisioning became GA.
### 要求
### Requirements
如果你使用 RKE2 建立集群,节点必须满足下游集群的[节点要求](https://docs.rke2.io/install/requirements)。
If you use RKE2 to set up a cluster, your nodes must meet the [requirements](https://docs.rke2.io/install/requirements) for nodes in downstream user clusters.
### 在云厂商的新节点上启动 Kubernetes
### Launching Kubernetes on New Nodes in an Infrastructure Provider
RKE2 基于使用上游[集群 API](https://github.com/kubernetes-sigs/cluster-api) 项目的新配置框架。这个新配置框架支持:
RKE2 provisioning is built on top of a new provisioning framework that leverages the upstream [Cluster API (CAPI)](https://github.com/kubernetes-sigs/cluster-api) project. With this new provisioning framework, you can:
- 将 RKE2 集群配置到 Rancher 具有主机驱动的任何提供商上
- 完全在 Rancher 中配置 RKE2 集群
- 除了 Canal 之外,还可以选择 CNI 选项, Calico、Cilium 和 Multus
- Provision RKE2 clusters onto any provider for which Rancher has a node driver.
- Fully configure RKE2 clusters within Rancher.
- Choose CNI options Calico, Cilium, and Multus in addition to Canal.
RKE2 配置还包括在具有 Windows 节点的集群上安装 RKE2。
When you make changes to your cluster configuration in RKE2, this may result in nodes reprovisioning. This is controlled by CAPI controllers and not by Rancher itself. Note that for etcd nodes, the same behavior does not apply.
RKE2 的 Windows 功能包括:
The following are some specific example configuration changes that may cause the described behavior:
- Windows 支持 vSphere 主机驱动
- 用于 Windows RKE2 自定义集群的 Calico CNI
- Calico 的项目网络隔离 (PNI)
- 由 containerd 提供支持的使用 RKE2 的 Windows 容器
- 通过 Terraform 配置 Windows RKE2 集群
- 直接从 Rancher UI 配置 Windows RKE2 自定义集群
- When editing the cluster and enabling drain before delete, the existing control plane nodes and worker are deleted and new nodes are created.
要使 Windows 支持 RKE2 自定义集群,请选择 Calico 作为 CNI。
RKE2 provisioning also includes installing RKE2 on clusters with Windows nodes.
### 在现有自定义节点上启动 Kubernetes
Windows features for RKE2 include:
RKE2 还支持在预配置的虚拟机或裸机节点上安装自定义集群。
- Windows supports the vSphere node driver
- Calico and Flannel CNI for Windows RKE2 custom clusters
- Project Network Isolation (PNI) for Calico
- Windows Containers with RKE2 powered by containerd
- Provisioning of Windows RKE2 clusters through Terraform
- Provisioning of Windows RKE2 custom clusters directly from the Rancher UI
如果要重复使用之前的自定义集群中的节点,请在复用之前清理节点。如果你重复使用尚未清理的节点,则集群配置可能会失败。
Windows Support for RKE2 Custom Clusters requires choosing Calico as the CNI.
### 以编程方式创建 RKE2 集群
### Launching Kubernetes on Existing Custom Nodes
通过 Rancher 以编程方式部署 RKE2 集群的最常见方法是使用 Rancher 2 Terraform Provider。详情请参见[使用 Terraform 创建集群](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2)。
RKE2 provisioning also allows you to install custom clusters on previously provisioned VMs or bare-metal nodes.
If you want to reuse a node from a previous custom cluster, [clean the node](../manage-clusters/clean-cluster-nodes.md#cleaning-up-nodes) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail.
### Programmatically Creating RKE2 Clusters
The most common way to programmatically deploy RKE2 clusters through Rancher is by using the [Rancher2 Terraform provider](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2).
@@ -15,6 +15,7 @@ title: 安装 Adapter
| Rancher 版本 | Adapter 版本 |
|-----------------|:----------------:|
| v2.12.1 | 107.0.0+up7.0.0 |
| v2.12.0 | 107.0.0+up7.0.0 |
## 1. 获取对 Local 集群的访问权限
@@ -55,7 +55,6 @@ Logging v2 已在 RHEL/CentOS 7 和 8 上使用 SELinux 进行了测试。
| 日志来源 | Linux 节点(包括在 Windows 集群中) | Windows 节点 |
| --- | --- | ---|
| RKE | ✓ | ✓ |
| RKE2 | ✓ | |
| K3s | ✓ | |
| AKS | ✓ | |
@@ -211,7 +211,7 @@ Prometheus 直接抓取以下 Kubernetes 组件:
\* 你可以选择通过 `hardenedKubelet.enabled` 来使用 PushProx,但这不是默认设置。
\*\* RKE 和 RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
\*\* RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
### 基于 Kubernetes 发行版抓取指标
@@ -220,18 +220,18 @@ Prometheus 直接抓取以下 Kubernetes 组件:
<figcaption>指标如何暴露给 Prometheus</figcaption>
| Kubernetes 组件 | RKE | RKE2 | KubeADM | K3s |
| Kubernetes 组件 | RKE2 | KubeADM | K3s |
|-----|-----|-----|-----|-----|
| kube-controller-manager | rkeControllerManager.enabled | rke2ControllerManager.enabled | kubeAdmControllerManager.enabled | k3sServer.enabled |
| kube-scheduler | rkeScheduler.enabled | rke2Scheduler.enabled | kubeAdmScheduler.enabled | k3sServer.enabled |
| etcd | rkeEtcd.enabled | rke2Etcd.enabled | kubeAdmEtcd.enabled | 不可用 |
| kube-proxy | rkeProxy.enabled | rke2Proxy.enabled | kubeAdmProxy.enabled | k3sServer.enabled |
| kubelet | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 |
| ingress-nginx* | 收集 kubelet 直接公开的指标,由 rkeIngressNginx.enabled 公开 | 收集 kubelet 直接公开的指标,由 rke2IngressNginx.enabled 公开 | 不可用 | 不可用 |
| coreDns/kubeDns | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 |
| kube-api-server | 收集 kube-api-server 直接公开的指标 | 收集 kube-api-server 直接公开的指标 | 收集 kube-appi-server 直接公开的指标 | 收集 kube-api-server 直接公开的指标 |
| kube-controller-manager | rke2ControllerManager.enabled | kubeAdmControllerManager.enabled | k3sServer.enabled |
| kube-scheduler | rke2Scheduler.enabled | kubeAdmScheduler.enabled | k3sServer.enabled |
| etcd | rke2Etcd.enabled | kubeAdmEtcd.enabled | 不可用 |
| kube-proxy | rke2Proxy.enabled | kubeAdmProxy.enabled | k3sServer.enabled |
| kubelet | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 |
| ingress-nginx* | 收集 kubelet 直接公开的指标,由 rke2IngressNginx.enabled 公开 | 不可用 | 不可用 |
| coreDns/kubeDns | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 |
| kube-api-server | 收集 kube-api-server 直接公开的指标 | 收集 kube-appi-server 直接公开的指标 | 收集 kube-api-server 直接公开的指标 |
\* RKE 和 RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
\* RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
### 名词解释
@@ -92,8 +92,6 @@ Rancher 和 Project 的读取权限并不一定适用于监控相关资源. 查
## Windows 集群支持
如果 Monitoring 部署到 RKE1 Windows 集群,Monitoring V2 将自动部署 [windows-exporter](https://github.com/prometheus-community/windows_exporter) DaemonSet 并设置 ServiceMonitor,以从每个部署的 Pod 中收集指标。这将使用 `windows_` 指标填充 Prometheus,这些指标与 [node_exporter](https://github.com/prometheus/node_exporter) 为 Linux 主机导出的 `node_` 指标类似。
为了能够为 Windows 完全部署 Monitoring V2,你的所有 Windows 主机都必须至少具有 v0.1.0 的 [wins](https://github.com/rancher/wins) 版本。
有关如何在现有 Windows 主机上升级 wins 版本的更多信息,请参阅 [Windows 集群对 Monitoring V2 的支持](windows-support.md)。
@@ -10,8 +10,6 @@ _从 v2.5.8 起可用_
Monitoring V2 for Windows 只能从最低是 `wins` v0.1.0 的 Windows 主机中抓取指标。要完全部署 Monitoring V2 for Windows,你的所有主机都必须满足此要求。
如果你在 Rancher 2.5.8 中配置新的 RKE1 集群,你的集群应该已经满足此要求。
### 将现有集群升级到 wins v0.1.0
如果集群是在 Rancher 2.5.8 之前配置的(即使当前 Rancher 版本是 2.5.8),你将无法成功部署 Monitoring V2 for Windows,除非你将每台主机的 wins 版本升级到 v0.1.0 或以上版本。
@@ -19,6 +17,7 @@ Monitoring V2 for Windows 只能从最低是 `wins` v0.1.0 的 Windows 主机中
为了方便此次升级,Rancher 2.5.8 发布了一个全新的 Helm Chart,名为 `rancher-wins-upgrader`。
1. 使用以下覆盖部署 `rancher-wins-upgrader`:
```yaml
# 通过先前已列入白名单的进程路径
# 来引导 win-upgrader 安装,这是因为正常安装路径
@@ -29,15 +28,9 @@ Monitoring V2 for Windows 只能从最低是 `wins` v0.1.0 的 Windows 主机中
enabled: true
as: c:\\etc\wmi-exporter\wmi-exporter.exe
```
:::note 非默认 Windows 前缀路径的注意事项:
- 如果你使用具有非默认 `win_prefix_path` 的 `cluster.yml` 来设置 RKE 集群,你需要将 `c:\\` 替换为你的前缀路径字段的值来修改 `masquerade.as`。
- 例如,如果你使用 `win_prefix_path: 'c:\host\opt\'`,则需要设置为 `as: c:\host\opt\etc\wmi-exporter\wmi-exporter.exe`。
:::
2. 成功升级所有主机后,请再次使用默认值部署 Helm Chart,以避免与以下设置发生冲突:
```yaml
masquerade:
enabled: false
@@ -25,7 +25,6 @@ Harvester Helm Chart 用于管理 Rancher 中 NeuVector UI 的访问,用户可
以下是一些例子:
- RKE1:`docker`
- K3s 和 RKE2:`k3scontainerd`
- AKS:`containerd` 适用于 v1.19 及更高版本
- EKS:`docker` 适用于 v1.22 及以下版本;`containerd` 适用于 v1.23 及更高版本
@@ -96,6 +96,12 @@ Rancher 可以动态启动云上(如 Amazon EC2、DigitalOcean、Azure 或 vSp
Rancher 使用 [docker-machine](https://github.com/rancher/machine) 来配置这类型的集群。
### Rancher Launched Kubernetes for Custom Nodes
When setting up this type of cluster, Rancher installs Kubernetes on existing nodes, which creates a custom cluster.
Rancher provisions this type of cluster using https://github.com/rancher/rke2[RKE2] or https://github.com/rancher/k3s[K3s].
### 托管的 Kubernetes 提供商
配置此类集群时,Kubernetes 由云提供商安装,如 GKE、ECS 或 AKS 等。
@@ -20,6 +20,7 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local
| Rancher Version | Webhook Version | Availability in Prime | Availability in Community |
|-----------------|-----------------|-----------------------|---------------------------|
| v2.12.1 | v0.8.1 | &check; | &check; |
| v2.12.0 | v0.8.0 | &cross; | &check; |
## 为什么我们需要它?
@@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/
| Patch 版本 | 发布时间 |
| --------------------------------------------------------------- | -------------------- |
| [2.10.9](https://github.com/rancher/rancher/releases/tag/v2.10.9) | 2025 年 8 月 27 日 |
| [2.10.8](https://github.com/rancher/rancher/releases/tag/v2.10.8) | 2025 年 7 月 30 日 |
| [2.10.7](https://github.com/rancher/rancher/releases/tag/v2.10.7) | 2025 年 6 月 25 日 |
| [2.10.6](https://github.com/rancher/rancher/releases/tag/v2.10.6) | 2025 年 5 月 22 日 |
@@ -27,12 +27,6 @@ Rancher 中有两种类型的驱动:
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
还有几个托管的 Kubernetes 云提供商是默认禁用的,但也打包在 Rancher 中:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
## 主机驱动
主机驱动用于配置主机,Rancher 使用这些主机启动和管理 Kubernetes 集群。主机驱动与 [Docker Machine 驱动](https://docs.docker.com/machine/drivers/)相同。创建主机模板时可以显示的主机驱动,是由主机驱动的状态定义的。只有 `active` 主机驱动将显示为创建节点模板的选项。默认情况下,Rancher 与许多现有的 Docker Machine 驱动打包在一起,但你也可以创建自定义主机驱动并添加到 Rancher。
@@ -15,57 +15,6 @@ PSS 定义了工作负载的安全级别。PSA 描述了 Pod 安全上下文和
必须在删除 PodSecurityPolicy 对象_之前_添加新的策略执行机制。否则,你可能会为集群内的特权升级攻击创造机会。
:::
#### 安装 `helm-mapkubeapis`
1. 在打算使用 `helm-mapkubeapis` 的机器上打开你的终端并安装插件:
```shell
helm plugin install https://github.com/helm/helm-mapkubeapis
```
你将看到类似于以下的输出:
```console
Downloading and installing helm-mapkubeapis v0.4.1 ...
https://github.com/helm/helm-mapkubeapis/releases/download/v0.4.1/helm-mapkubeapis_0.4.1_darwin_amd64.tar.gz
Installed plugin: mapkubeapis
```
:::info 重要提示
确保 `helm-mapkubeapis` 插件至少为 v0.4.1,因为旧版本_不_支持资源删除。
:::
1. 验证插件是否已正确安装:
```shell
helm mapkubeapis --help
```
你将看到类似于以下的输出:
```console
Map release deprecated or removed Kubernetes APIs in-place
Usage:
mapkubeapis [flags] RELEASE
Flags:
--dry-run simulate a command
-h, --help help for mapkubeapis
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--mapfile string path to the API mapping file
--namespace string namespace scope of the release
```
#### 清理损坏的版本
安装 `helm-mapkubeapis` 插件后,清理升级到 Kubernetes v1.25 后损坏的版本。
1. 打开你的首选终端并通过运行 `kubectl cluster-info` 确保终端已连接到所需集群。
1. 运行 `helm list --all-namespaces` 列出你在集群中安装的所有版本。
1. 通过运行 `helm mapkubeapis --dry-run <release-name> --namespace <release-namespace>` 为要清理的每个版本执行试运行。你可以通过此命令的结果了解要替换或删除哪些资源。
1. 最后,在查看更改后,使用 `helm mapkubeapis <release-name> --namespace <release-namespace>` 执行完整运行。
## Pod 安全准入配置模板
Rancher 提供了 PSA 配置模板。它们是可以应用到集群的预定义安全配置。Rancher 管理员(或具有权限的人员)可以[创建、管理和编辑](./psa-config-templates.md) PSA 模板。
@@ -1,59 +0,0 @@
---
title: 创建阿里云 ACK 集群
---
你可以使用 Rancher 创建托管在阿里云 Alibaba Cloud Kubernetes (ACK) 中的集群。Rancher 已经为 ACK 实现并打包了针对 ACK 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 ACK 集群,你需要[启用 ACK 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 ACK 集群。
## Rancher 之外的先决条件
:::caution
部署到 ACK 会产生费用。
:::
1. 在阿里云中,在对应的控制台中激活以下服务。
- [容器服务](https://cs.console.aliyun.com)
- [资源编排服务](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. 确保你用于创建 ACK 集群的账号具有适当的权限。详见阿里云[角色授权](https://www.alibabacloud.com/help/doc-detail/86483.htm)和[使用容器服务控制台作为 RAM 用户](https://www.alibabacloud.com/help/doc-detail/86484.htm)官方文档。
3. 在阿里云中,创建[访问密钥](https://www.alibabacloud.com/help/doc-detail/53045.html)。
4. 在阿里云中,创建 [SSH 密钥对](https://www.alibabacloud.com/help/doc-detail/51793.html)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用阿里云 ACK 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Alibaba ACK** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建阿里云 ACK 集群了。
## 创建 ACK 集群
1. 点击 **☰ > 集群管理**。
1. 在**集群**页面,点击**创建**。
1. 单击 **Alibaba ACK**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 为 ACK 集群配置**账号访问**。选择要在其中构建集群的地理区域,并输入在先决条件步骤中创建的访问密钥。
1. 点击**下一步:配置集群**,然后选择集群类型、Kubernetes 版本和可用区。
1. 如果选择 **Kubernetes** 作为集群类型,请单击**下一步:配置 master 节点**,然后填写 **master 节点**表单。
1. 单击**下一步:配置 Worker 节点**,然后填写 **Worker 节点**表单。
1. 检查并确认你的选项。然后单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -1,100 +0,0 @@
---
title: 创建华为 CCE 集群
---
你可以使用 Rancher 创建托管在华为云容器引擎 (CCE) 中的集群。Rancher 已经为 CCE 实现并打包了针对 CCE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 CCE 集群,你需要[启用 CCE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 CCE 集群。
## 华为先决条件
:::caution
部署到 CCE 会产生费用。
:::
1. 在华为 CCE 门户中找到你的项目 ID。请参阅 CCE 文档以了解如何[管理你的项目](https://doc.hcs.huawei.com/api/cce/cce_02_0341.html#cce_02_0341__section17571944123214)。
2. 创建一个[访问密钥 ID 和密文访问密钥](https://support.huaweicloud.com/en-us/usermanual-iam/en-us_topic_0079477318.html)。
## Rancher 先决条件
你需要启用华为 CCE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Huawei CCE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建华为 CCE 集群了。
## 限制
华为 CCE 服务不支持通过其 API 创建具有公共访问权限的集群。你需要在要配置的 CCE 集群的相同 VPC 中运行 Rancher。
## 创建 CCE 集群
1. 在**集群**页面,点击**创建**。
1. 单击 **Huawei CCE**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 输入**项目 ID**,访问密钥 ID,**Access Key**,和密文访问密钥 **Secret Key**。然后点击**下一步:配置集群**。填写集群配置。有关填写表单的帮助,请参阅[华为 CCE 配置](#华为-cce-配置)。
1. 填写集群的以下节点配置。有关填写表单的帮助,请参阅[节点配置](#节点配置)。
1. 点击**创建**来创建 CCE 集群。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
## 华为 CCE 配置
| 设置 | 描述 |
|---|---|
| 集群类型 | 要包含到集群的节点类型,可以是 `VirtualMachine` 或 `BareMetal`。 |
| 描述 | 集群的描述。 |
| 主版本 | Kubernetes 版本。 |
| 管理规模数量 | 集群的最大节点数。选项为 50、200 和 1000。规模计数越大,成本越高。 |
| 高可用性 | 启用 master 节点的高可用性。启用高可用性的集群成本会更高。 |
| 容器网络模式 | 集群中使用的网络模式。`VirtualMachine` 支持 `overlay_l2` 和 `vpc-router`,而 `BareMetal` 支持 `underlay_ipvlan`。 |
| 容器网络 CIDR | 集群的网络 CIDR。 |
| VPC 名称 | 要部署集群的 VPC 名称。如果留空,Rancher 将创建一个。 |
| 子网名称 | 要部署集群的子网名称。如果留空,Rancher 将创建一个。 |
| 外部服务器 | 预留选项,用于通过 API 启用 CCE 集群的公共访问。这个选项暂时是一直禁用的。 |
| 集群标签 | 集群的标签。 |
| 高速子网 | 只有 `BareMetal` 支持该选项。裸机要求选择网速高的 VPC。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅[配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
## 节点配置
| 设置 | 描述 |
|---|---|
| 地区 | 部署集群节点的可用区域。 |
| 计费方式 | 集群节点的计费模式。`VirtualMachine` 仅支持 `Pay-per-use`。`BareMetal` 支持 `Pay-per-use` 或 `Yearly/Monthly`。 |
| 有效期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示支付集群节点费用的时间。 |
| 自动续期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示是否为集群节点自动续期 `Yearly/Monthly` 计费。 |
| 数据卷类型 | 集群节点的数据卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 数据量大小 | 集群节点的数据卷大小。 |
| 根卷类型 | 集群节点的根卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 根卷大小 | 集群节点的根卷大小。 |
| 节点风格 | 集群节点的节点风格。Rancher UI 中的风格列表取自华为云。其中包括所有支持的节点风格。 |
| 节点数 | 集群的节点数 |
| 节点操作系统 | 集群节点的操作系统。目前仅支持 `EulerOS 2.2` 和 `CentOS 7.4`。 |
| SSH 密钥名称 | 集群节点的 SSH 密钥 |
| EIP | 集群节点的公共 IP 选项。`已禁用`表示集群节点不会绑定公共 IP。`创建 EIP`表示集群节点在配置后将绑定一个或多个新创建的 EIP,UI 中将显示更多用来创建 EIP 参数的选项。`选择现有 EIP` 表示节点将绑定到你选择的 EIP。 |
| EIP 数量 | 此选项仅在选择`创建 EIP`时显示。表示你要为节点创建的 EIP 数量。 |
| EIP 类型 | 此选项仅在选择`创建 EIP`时显示。可选 `5_bgp` 和 `5_sbgp`。 |
| EIP 共享类型 | 此选项仅在选择`创建 EIP`时显示。仅可选 `PER`。 |
| EIP 收费模式 | 此选项仅在选择`创建 EIP`时显示。选择按照`带宽`或`流量`计费。 |
| EIP 带宽大小 | 此选项仅在选择`创建 EIP`时显示。EIP 的带宽。 |
| 身份验证模式 | 表示启用 `RBAC`,或同时启用`认证代理`。如果选择`认证代理`,则还需要用于验证代理的证书。 |
| 节点标签 | 集群节点的标签。无效标签会阻止升级,或阻止 Rancher 启动。有关标签语法的详细信息,请参阅 [Kubernetes 文档](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。 |
@@ -17,9 +17,6 @@ Rancher 支持以下 Kubernetes 提供商:
- [Google GKE (Google Kubernetes Engine)](https://cloud.google.com/kubernetes-engine/)
- [Amazon EKS (Amazon Elastic Container Service for Kubernetes)](https://aws.amazon.com/eks/)
- [Microsoft AKS (Azure Kubernetes Service)](https://azure.microsoft.com/en-us/services/kubernetes-service/)
- [Alibaba ACK (Alibaba Cloud Container Service for Kubernetes)](https://www.alibabacloud.com/product/kubernetes)
- [Tencent TKE (Tencent Kubernetes Engine)](https://intl.cloud.tencent.com/product/tke)
- [Huawei CCE (Huawei Cloud Container Engine)](https://www.huaweicloud.com/en-us/product/cce.html)
## 托管 Kubernetes 提供商的认证
@@ -28,6 +25,4 @@ Rancher 支持以下 Kubernetes 提供商:
- [创建 GKE 集群](gke.md)
- [创建 EKS 集群](eks.md)
- [创建 AKS 集群](aks.md)
- [创建 ACK 集群](alibaba.md)
- [创建 TKE 集群](tencent.md)
- [创建 CCE 集群](huawei.md)
@@ -1,99 +0,0 @@
---
title: 创建腾讯 TKE 集群
---
你可以使用 Rancher 创建托管在腾讯 Tencent Kubernetes Engine (TKE) 中的集群。Rancher 已经为 TKE 实现并打包了针对 TKE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 TKE 集群,你需要[启用 TKE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 TKE 集群。
## 腾讯先决条件
:::caution
部署到 TKE 会产生费用。
:::
1. 参见[云访问管理](https://intl.cloud.tencent.com/document/product/598/10600)文档,确保用于创建 TKE 集群的账号具有适当的权限。
2. 创建[云 API 密钥 ID 和密钥](https://console.cloud.tencent.com/capi)。
3. 在要部署 Kubernetes 集群的区域中创建[私有网络和子网](https://intl.cloud.tencent.com/document/product/215/4927)。
4. 创建 [SSH 密钥对](https://intl.cloud.tencent.com/document/product/213/6092)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用腾讯 TKE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Tencent TKE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建腾讯 TKE 集群了。
## 创建 TKE 集群
1. 在**集群**页面,点击**创建**。
2. 选择 **Tencent TKE**。
3. 输入**集群名称**。
4. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
5. 为 TKE 集群配置**账号访问**。使用[先决条件](#腾讯先决条件)中获得的信息完成每个下拉列表和字段。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 区域 | 从下拉列表中选择构建集群的地理区域。 |
| 密文 ID | 输入从腾讯云控制台获取的密文 ID。 |
| 密文密钥 | 输入从腾讯云控制台获取的密文密钥。 |
6. 然后,单击`下一步:配置集群`来配置 TKE 集群。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Kubernetes 版本 | TKE 目前只支持 Kubernetes 1.10.5。 |
| 节点数 | 输入要为 Kubernetes 集群购买的 worker 节点数,最大值是 100。 |
| VPC | 选择在腾讯云控制台中创建的 VPC 名称。 |
| 容器网络 CIDR | 输入 Kubernetes 集群的 CIDR 范围。你可以在腾讯云控制台的 VPC 服务中查看该 CIDR 的可用范围。默认为 172.16.0.0/16。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅 [Rancher 2.3.0+ 配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
7. 点击`下一步:选择实例类型`,然后选择将用于 TKE 集群的实例类型。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 可用区 | 选择 VPC 区域的可用区。 |
| 子网 | 选择你在 VPC 中创建的子网。如果在所选可用区中没有该子网,请添加一个新子网。 |
| 实例类型 | 从下拉列表中选择要用于 TKE 集群的 VM 实例类型,默认为 S2.MEDIUM4(CPU 2;内存 4 GiB)。 |
8. 点击`下一步:配置实例`,配置用于 TKE 集群的 VM 实例。
| 选项 | 描述 |
-------|------------
| 操作系统 | 操作系统名称,目前支持 Centos7.2x86_64 或 ubuntu16.04.1 LTSx86_64。 |
| 安全组 | 安全组 ID,默认不绑定任何安全组。 |
| 根磁盘类型 | 系统盘类型。系统盘类型限制详见 [CVM 实例配置](https://cloud.tencent.com/document/product/213/11518)。 |
| 根磁盘大小 | 系统盘大小。Linux 系统调整范围为 20-50 GB,步长为 1。 |
| 数据盘类型 | 数据盘类型,默认为 SSD 云盘。 |
| 数据磁盘大小 | 数据盘大小(GB),步长为 10。 |
| 带宽类型 | 带宽收费类型,PayByTraffic 或 PayByHour。 |
| 带宽 | 公网带宽 (Mbps) |
| 密钥对 | 密钥 ID,关联后可以用来登录 VM 节点。 |
9. 单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -15,6 +15,7 @@ title: 安装 Adapter
| Rancher 版本 | Adapter 版本 |
|-----------------|:---------------:|
| v2.10.9 | v105.0.0+up5.0.1 |
| v2.10.8 | v105.0.0+up5.0.1 |
| v2.10.7 | v105.0.0+up5.0.1 |
| v2.10.6 | v105.0.0+up5.0.1 |
@@ -20,6 +20,7 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local
| Rancher Version | Webhook Version | Availability in Prime | Availability in Community |
| --------------- | --------------- | --------------------- | ------------------------- |
| v2.10.9 | v0.6.10 | &check; | &cross; |
| v2.10.8 | v0.6.9 | &check; | &cross; |
| v2.10.7 | v0.6.8 | &check; | &cross; |
| v2.10.6 | v0.6.7 | &check; | &cross; |
@@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/
| Patch 版本 | 发布时间 |
| --------------------------------------------------------------- | ------------------ |
| [2.11.5](https://github.com/rancher/rancher/releases/tag/v2.11.5) | 2025 年 8 月 28 日 |
| [2.11.4](https://github.com/rancher/rancher/releases/tag/v2.11.4) | 2025 年 7 月 30 日 |
| [2.11.3](https://github.com/rancher/rancher/releases/tag/v2.11.3) | 2025 年 6 月 25 日 |
| [2.11.2](https://github.com/rancher/rancher/releases/tag/v2.11.2) | 2025 年 5 月 22 日 |
@@ -27,12 +27,6 @@ Rancher 中有两种类型的驱动:
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
还有几个托管的 Kubernetes 云提供商是默认禁用的,但也打包在 Rancher 中:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
## 主机驱动
主机驱动用于配置主机,Rancher 使用这些主机启动和管理 Kubernetes 集群。主机驱动与 [Docker Machine 驱动](https://github.com/docker/docs/blob/vnext-engine/machine/drivers/index.md)相同。创建主机模板时可以显示的主机驱动,是由主机驱动的状态定义的。只有 `active` 主机驱动将显示为创建节点模板的选项。默认情况下,Rancher 与许多现有的 Docker Machine 驱动打包在一起,但你也可以创建自定义主机驱动并添加到 Rancher。
@@ -7,57 +7,6 @@ title: Pod 安全标准 (PSS) 和 Pod 安全准入 (PSA)
PSS 定义了工作负载的安全级别。PSA 描述了 Pod 安全上下文和相关字段的要求。PSA 参考 PSS 级别来定义安全限制。
#### 安装 `helm-mapkubeapis`
1. 在打算使用 `helm-mapkubeapis` 的机器上打开你的终端并安装插件:
```shell
helm plugin install https://github.com/helm/helm-mapkubeapis
```
你将看到类似于以下的输出:
```console
Downloading and installing helm-mapkubeapis v0.4.1 ...
https://github.com/helm/helm-mapkubeapis/releases/download/v0.4.1/helm-mapkubeapis_0.4.1_darwin_amd64.tar.gz
Installed plugin: mapkubeapis
```
:::info 重要提示
确保 `helm-mapkubeapis` 插件至少为 v0.4.1,因为旧版本_不_支持资源删除。
:::
1. 验证插件是否已正确安装:
```shell
helm mapkubeapis --help
```
你将看到类似于以下的输出:
```console
Map release deprecated or removed Kubernetes APIs in-place
Usage:
mapkubeapis [flags] RELEASE
Flags:
--dry-run simulate a command
-h, --help help for mapkubeapis
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--mapfile string path to the API mapping file
--namespace string namespace scope of the release
```
#### 清理损坏的版本
安装 `helm-mapkubeapis` 插件后,清理升级到 Kubernetes v1.25 后损坏的版本。
1. 打开你的首选终端并通过运行 `kubectl cluster-info` 确保终端已连接到所需集群。
1. 运行 `helm list --all-namespaces` 列出你在集群中安装的所有版本。
1. 通过运行 `helm mapkubeapis --dry-run <release-name> --namespace <release-namespace>` 为要清理的每个版本执行试运行。你可以通过此命令的结果了解要替换或删除哪些资源。
1. 最后,在查看更改后,使用 `helm mapkubeapis <release-name> --namespace <release-namespace>` 执行完整运行。
## Pod 安全准入配置模板
Rancher 提供了 PSA 配置模板。它们是可以应用到集群的预定义安全配置。Rancher 管理员(或具有权限的人员)可以[创建、管理和编辑](./psa-config-templates.md) PSA 模板。
@@ -1,59 +0,0 @@
---
title: 创建阿里云 ACK 集群
---
你可以使用 Rancher 创建托管在阿里云 Alibaba Cloud Kubernetes (ACK) 中的集群。Rancher 已经为 ACK 实现并打包了针对 ACK 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 ACK 集群,你需要[启用 ACK 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 ACK 集群。
## Rancher 之外的先决条件
:::caution
部署到 ACK 会产生费用。
:::
1. 在阿里云中,在对应的控制台中激活以下服务。
- [容器服务](https://cs.console.aliyun.com)
- [资源编排服务](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. 确保你用于创建 ACK 集群的账号具有适当的权限。详见阿里云[角色授权](https://www.alibabacloud.com/help/doc-detail/86483.htm)和[使用容器服务控制台作为 RAM 用户](https://www.alibabacloud.com/help/doc-detail/86484.htm)官方文档。
3. 在阿里云中,创建[访问密钥](https://www.alibabacloud.com/help/doc-detail/53045.html)。
4. 在阿里云中,创建 [SSH 密钥对](https://www.alibabacloud.com/help/doc-detail/51793.html)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用阿里云 ACK 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Alibaba ACK** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建阿里云 ACK 集群了。
## 创建 ACK 集群
1. 点击 **☰ > 集群管理**。
1. 在**集群**页面,点击**创建**。
1. 单击 **Alibaba ACK**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 为 ACK 集群配置**账号访问**。选择要在其中构建集群的地理区域,并输入在先决条件步骤中创建的访问密钥。
1. 点击**下一步:配置集群**,然后选择集群类型、Kubernetes 版本和可用区。
1. 如果选择 **Kubernetes** 作为集群类型,请单击**下一步:配置 master 节点**,然后填写 **master 节点**表单。
1. 单击**下一步:配置 Worker 节点**,然后填写 **Worker 节点**表单。
1. 检查并确认你的选项。然后单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -1,100 +0,0 @@
---
title: 创建华为 CCE 集群
---
你可以使用 Rancher 创建托管在华为云容器引擎 (CCE) 中的集群。Rancher 已经为 CCE 实现并打包了针对 CCE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 CCE 集群,你需要[启用 CCE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 CCE 集群。
## 华为先决条件
:::caution
部署到 CCE 会产生费用。
:::
1. 在华为 CCE 门户中找到你的项目 ID。请参阅 CCE 文档以了解如何[管理你的项目](https://doc.hcs.huawei.com/api/cce/cce_02_0341.html#cce_02_0341__section17571944123214)。
2. 创建一个[访问密钥 ID 和密文访问密钥](https://support.huaweicloud.com/en-us/usermanual-iam/en-us_topic_0079477318.html)。
## Rancher 先决条件
你需要启用华为 CCE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Huawei CCE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建华为 CCE 集群了。
## 限制
华为 CCE 服务不支持通过其 API 创建具有公共访问权限的集群。你需要在要配置的 CCE 集群的相同 VPC 中运行 Rancher。
## 创建 CCE 集群
1. 在**集群**页面,点击**创建**。
1. 单击 **Huawei CCE**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 输入**项目 ID**,访问密钥 ID,**Access Key**,和密文访问密钥 **Secret Key**。然后点击**下一步:配置集群**。填写集群配置。有关填写表单的帮助,请参阅[华为 CCE 配置](#华为-cce-配置)。
1. 填写集群的以下节点配置。有关填写表单的帮助,请参阅[节点配置](#节点配置)。
1. 点击**创建**来创建 CCE 集群。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
## 华为 CCE 配置
| 设置 | 描述 |
|---|---|
| 集群类型 | 要包含到集群的节点类型,可以是 `VirtualMachine` 或 `BareMetal`。 |
| 描述 | 集群的描述。 |
| 主版本 | Kubernetes 版本。 |
| 管理规模数量 | 集群的最大节点数。选项为 50、200 和 1000。规模计数越大,成本越高。 |
| 高可用性 | 启用 master 节点的高可用性。启用高可用性的集群成本会更高。 |
| 容器网络模式 | 集群中使用的网络模式。`VirtualMachine` 支持 `overlay_l2` 和 `vpc-router`,而 `BareMetal` 支持 `underlay_ipvlan`。 |
| 容器网络 CIDR | 集群的网络 CIDR。 |
| VPC 名称 | 要部署集群的 VPC 名称。如果留空,Rancher 将创建一个。 |
| 子网名称 | 要部署集群的子网名称。如果留空,Rancher 将创建一个。 |
| 外部服务器 | 预留选项,用于通过 API 启用 CCE 集群的公共访问。这个选项暂时是一直禁用的。 |
| 集群标签 | 集群的标签。 |
| 高速子网 | 只有 `BareMetal` 支持该选项。裸机要求选择网速高的 VPC。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅[配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
## 节点配置
| 设置 | 描述 |
|---|---|
| 地区 | 部署集群节点的可用区域。 |
| 计费方式 | 集群节点的计费模式。`VirtualMachine` 仅支持 `Pay-per-use`。`BareMetal` 支持 `Pay-per-use` 或 `Yearly/Monthly`。 |
| 有效期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示支付集群节点费用的时间。 |
| 自动续期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示是否为集群节点自动续期 `Yearly/Monthly` 计费。 |
| 数据卷类型 | 集群节点的数据卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 数据量大小 | 集群节点的数据卷大小。 |
| 根卷类型 | 集群节点的根卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 根卷大小 | 集群节点的根卷大小。 |
| 节点风格 | 集群节点的节点风格。Rancher UI 中的风格列表取自华为云。其中包括所有支持的节点风格。 |
| 节点数 | 集群的节点数 |
| 节点操作系统 | 集群节点的操作系统。目前仅支持 `EulerOS 2.2` 和 `CentOS 7.4`。 |
| SSH 密钥名称 | 集群节点的 SSH 密钥 |
| EIP | 集群节点的公共 IP 选项。`已禁用`表示集群节点不会绑定公共 IP。`创建 EIP`表示集群节点在配置后将绑定一个或多个新创建的 EIP,UI 中将显示更多用来创建 EIP 参数的选项。`选择现有 EIP` 表示节点将绑定到你选择的 EIP。 |
| EIP 数量 | 此选项仅在选择`创建 EIP`时显示。表示你要为节点创建的 EIP 数量。 |
| EIP 类型 | 此选项仅在选择`创建 EIP`时显示。可选 `5_bgp` 和 `5_sbgp`。 |
| EIP 共享类型 | 此选项仅在选择`创建 EIP`时显示。仅可选 `PER`。 |
| EIP 收费模式 | 此选项仅在选择`创建 EIP`时显示。选择按照`带宽`或`流量`计费。 |
| EIP 带宽大小 | 此选项仅在选择`创建 EIP`时显示。EIP 的带宽。 |
| 身份验证模式 | 表示启用 `RBAC`,或同时启用`认证代理`。如果选择`认证代理`,则还需要用于验证代理的证书。 |
| 节点标签 | 集群节点的标签。无效标签会阻止升级,或阻止 Rancher 启动。有关标签语法的详细信息,请参阅 [Kubernetes 文档](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。 |
@@ -17,9 +17,6 @@ Rancher 支持以下 Kubernetes 提供商:
- [Google GKE (Google Kubernetes Engine)](https://cloud.google.com/kubernetes-engine/)
- [Amazon EKS (Amazon Elastic Container Service for Kubernetes)](https://aws.amazon.com/eks/)
- [Microsoft AKS (Azure Kubernetes Service)](https://azure.microsoft.com/en-us/services/kubernetes-service/)
- [Alibaba ACK (Alibaba Cloud Container Service for Kubernetes)](https://www.alibabacloud.com/product/kubernetes)
- [Tencent TKE (Tencent Kubernetes Engine)](https://intl.cloud.tencent.com/product/tke)
- [Huawei CCE (Huawei Cloud Container Engine)](https://www.huaweicloud.com/en-us/product/cce.html)
## 托管 Kubernetes 提供商的认证
@@ -28,6 +25,4 @@ Rancher 支持以下 Kubernetes 提供商:
- [创建 GKE 集群](gke.md)
- [创建 EKS 集群](eks.md)
- [创建 AKS 集群](aks.md)
- [创建 ACK 集群](alibaba.md)
- [创建 TKE 集群](tencent.md)
- [创建 CCE 集群](huawei.md)
@@ -1,99 +0,0 @@
---
title: 创建腾讯 TKE 集群
---
你可以使用 Rancher 创建托管在腾讯 Tencent Kubernetes Engine (TKE) 中的集群。Rancher 已经为 TKE 实现并打包了针对 TKE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 TKE 集群,你需要[启用 TKE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 TKE 集群。
## 腾讯先决条件
:::caution
部署到 TKE 会产生费用。
:::
1. 参见[云访问管理](https://intl.cloud.tencent.com/document/product/598/10600)文档,确保用于创建 TKE 集群的账号具有适当的权限。
2. 创建[云 API 密钥 ID 和密钥](https://console.cloud.tencent.com/capi)。
3. 在要部署 Kubernetes 集群的区域中创建[私有网络和子网](https://intl.cloud.tencent.com/document/product/215/4927)。
4. 创建 [SSH 密钥对](https://intl.cloud.tencent.com/document/product/213/6092)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用腾讯 TKE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Tencent TKE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建腾讯 TKE 集群了。
## 创建 TKE 集群
1. 在**集群**页面,点击**创建**。
2. 选择 **Tencent TKE**。
3. 输入**集群名称**。
4. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
5. 为 TKE 集群配置**账号访问**。使用[先决条件](#腾讯先决条件)中获得的信息完成每个下拉列表和字段。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 区域 | 从下拉列表中选择构建集群的地理区域。 |
| 密文 ID | 输入从腾讯云控制台获取的密文 ID。 |
| 密文密钥 | 输入从腾讯云控制台获取的密文密钥。 |
6. 然后,单击`下一步:配置集群`来配置 TKE 集群。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Kubernetes 版本 | TKE 目前只支持 Kubernetes 1.10.5。 |
| 节点数 | 输入要为 Kubernetes 集群购买的 worker 节点数,最大值是 100。 |
| VPC | 选择在腾讯云控制台中创建的 VPC 名称。 |
| 容器网络 CIDR | 输入 Kubernetes 集群的 CIDR 范围。你可以在腾讯云控制台的 VPC 服务中查看该 CIDR 的可用范围。默认为 172.16.0.0/16。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅 [Rancher 2.3.0+ 配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
7. 点击`下一步:选择实例类型`,然后选择将用于 TKE 集群的实例类型。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 可用区 | 选择 VPC 区域的可用区。 |
| 子网 | 选择你在 VPC 中创建的子网。如果在所选可用区中没有该子网,请添加一个新子网。 |
| 实例类型 | 从下拉列表中选择要用于 TKE 集群的 VM 实例类型,默认为 S2.MEDIUM4(CPU 2;内存 4 GiB)。 |
8. 点击`下一步:配置实例`,配置用于 TKE 集群的 VM 实例。
| 选项 | 描述 |
-------|------------
| 操作系统 | 操作系统名称,目前支持 Centos7.2x86_64 或 ubuntu16.04.1 LTSx86_64。 |
| 安全组 | 安全组 ID,默认不绑定任何安全组。 |
| 根磁盘类型 | 系统盘类型。系统盘类型限制详见 [CVM 实例配置](https://cloud.tencent.com/document/product/213/11518)。 |
| 根磁盘大小 | 系统盘大小。Linux 系统调整范围为 20-50 GB,步长为 1。 |
| 数据盘类型 | 数据盘类型,默认为 SSD 云盘。 |
| 数据磁盘大小 | 数据盘大小(GB),步长为 10。 |
| 带宽类型 | 带宽收费类型,PayByTraffic 或 PayByHour。 |
| 带宽 | 公网带宽 (Mbps) |
| 密钥对 | 密钥 ID,关联后可以用来登录 VM 节点。 |
9. 单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -15,6 +15,7 @@ title: 安装 Adapter
| Rancher 版本 | Adapter 版本 |
|-----------------|:----------------:|
| v2.11.5 | v106.0.0+up6.0.0 |
| v2.11.4 | v106.0.0+up6.0.0 |
| v2.11.3 | v106.0.0+up6.0.0 |
| v2.11.2 | v106.0.0+up6.0.0 |
@@ -20,7 +20,8 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local
| Rancher Version | Webhook Version | Availability in Prime | Availability in Community |
|-----------------|-----------------|-----------------------|---------------------------|
| v2.11.4 | v0.7.4 | &check; | &cross; |
| v2.11.5 | v0.7.5 | &check; | &cross; |
| v2.11.4 | v0.7.4 | &check; | &cross; |
| v2.11.3 | v0.7.3 | &check; | &check; |
| v2.11.2 | v0.7.2 | &check; | &check; |
| v2.11.1 | v0.7.1 | &check; | &check; |
@@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/
| Patch 版本 | 发布时间 |
| ----------------------------------------------------------------- | ------------------ |
| [2.12.1](https://github.com/rancher/rancher/releases/tag/v2.12.1) | 2025 年 8 月 28 日 |
| [2.12.0](https://github.com/rancher/rancher/releases/tag/v2.12.0) | 2025 年 7 月 30 日 |
## 当一个功能被标记为弃用我可以得到什么样的预期?
@@ -20,7 +20,6 @@ Rancher 可以安装在任何 Kubernetes 集群上。这个集群可以使用上
你可参考以下教程,以获得设置 Kubernetes 集群的帮助:
- **RKE**:[安装 RKE Kubernetes 集群的教程](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke1-for-rancher.md);[为高可用 RKE 集群设置基础设施的教程](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-rke1-kubernetes-cluster.md)。
- **K3s**:[安装 K3s Kubernetes 集群的教程](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/k3s-for-rancher.md);[设置高可用 K3s 集群的基础设施的教程](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-k3s-kubernetes-cluster.md)。
- **RKE2:** :[安装 RKE2 Kubernetes 集群的教程](../../../how-to-guides/new-user-guides/kubernetes-cluster-setup/rke2-for-rancher.md);[设置高可用 RKE2 集群的基础设施的教程](../../../how-to-guides/new-user-guides/infrastructure-setup/ha-rke2-kubernetes-cluster.md)。
- **Amazon EKS**:[在 Amazon EKS 上安装 Rancher 以及如何安装 Ingress Controller 以访问 Rancher Server](rancher-on-amazon-eks.md)。
@@ -32,7 +31,7 @@ Rancher 可以安装在任何 Kubernetes 集群上。这个集群可以使用上
Rancher UI 和 API 通过 Ingress 公开。换言之,安装 Rancher 的 Kubernetes 集群必须包含一个 Ingress Controller。
对于 RKE、RKE2 和 K3s,你不需要手动安装 Ingress Controller,因为它是默认安装的。
对于 RKE2 和 K3s,你不需要手动安装 Ingress Controller,因为它是默认安装的。
对于默认不包含 Ingress Controller 的发行版(例如 EKS、GKE 或 AKS 等托管 Kubernetes 集群),你必须先部署 Ingress Controller。请注意,Rancher Helm Chart 默认情况下不会在 Ingress 上设置 `ingressClassName`。因此,你必须将 Ingress Controller 配置为在没有 `ingressClassName` 的情况下也可以监视 Ingress。
@@ -171,18 +171,10 @@ $ nc xxx.xxx.xxx.xxx 22
SSH-2.0-OpenSSH_6.6.1p1 Ubuntu-2ubuntu2.10
```
## Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: Error configuring SSH: ssh: no key found
`ssh_key_path` 密钥文件无法访问:请确保你已经指定了私钥文件(不是公钥 `.pub`),而且运行 `rke` 命令的用户可以访问该私钥文件。
## Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: ssh: handshake failed: ssh: unable to authenticate, attempted methods [none publickey], no supported methods remain
`ssh_key_path` 密钥文件不是访问节点的正确文件:请仔细检查,确保你已为节点指定了正确的 `ssh_key_path` 和连接用户。
## Failed to dial ssh using address [xxx.xxx.xxx.xxx:xx]: Error configuring SSH: ssh: cannot decode encrypted private keys
如需使用加密的私钥,请使用 `ssh-agent` 来使用密码来加载密钥。如果在运行 `rke` 命令的环境中找到 `SSH_AUTH_SOCK` 环境变量,它将自动用于连接到节点。
## Cannot connect to the Docker daemon at unix:///var/run/docker.sock. Is the docker daemon running?
节点无法通过配置的 `address` 和 `port` 访问。
@@ -6,18 +6,15 @@ title: 升级
有关使用 Docker 安装的 Rancher 的升级说明,请参见[本页。](../other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md)
如需升级 Kubernetes 集群中的组件,或 [Kubernetes services](https://rancher.com/docs/rke/latest/en/config-options/services/) 或 [附加组件(add-on)](https://rancher.com/docs/rke/latest/en/config-options/add-ons/)的定义,请参见 [RKE 升级文档](https://rancher.com/docs/rke/latest/en/upgrades/)的 Rancher Kubernetes 引擎。
## 先决条件
### 访问 kubeconfig
### 访问 Kubeconfig
Helm 的运行位置,应该与你的 kubeconfig 文件,或你运行 kubectl 命令的位置相同。
Helm 的运行位置,应该与你的 Kubeconfig 文件,或你运行 kubectl 命令的位置相同。
如果你在安装 Kubernetes 时使用了 RKE,那么 config 将会在你运行 `rke up` 的目录下创建。
If you installed Kubernetes with RKE2/K3s, the Kubeconfig is stored in the `/etc/rancher/rke2/rke2.yaml` or `/etc/rancher/k3s/k3s.yaml` directory depending on your chosen distribution.
kubeconfig 也可以通过 `--kubeconfig` 标签(详情请参见 https://helm.sh/docs/helm/helm/ )来手动指定所需的集群。
Kubeconfig 也可以通过 `--kubeconfig` 标签(详情请参见 https://helm.sh/docs/helm/helm/ )来手动指定所需的集群。
### 查看已知问题
@@ -21,7 +21,6 @@ title: 功能开关
- `istio-virtual-service-ui`:启用[可视界面](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md)来创建、读取、更新和删除 Istio 虚拟服务和目标规则,这些都是 Istio 流量管理功能。
- `legacy`:启用 2.5.x 及更早版本的一组功能,这些功能正逐渐被新的实现淘汰。它们是已弃用以及后续可用于新版本的功能组合。新的 Rancher 安装会默认禁用此标志。如果你从以前版本的 Rancher 升级,此标志会启用。
- `multi-cluster-management`:允许配置和管理多个 Kubernetes 集群。此标志只能在安装时设置。后续无法启用或禁用它。
- `rke1-custom-node-cleanup`:清除已删除的 RKE1 自定义节点。建议你启用此标志,以防止已删除的节点尝试重新加入集群。
- `rke2`:启用配置 RKE2 集群。此标志默认启用。
- `token-hashing`:启用令牌哈希。启用后,会使用 SHA256 算法对现有 Token 和所有新 Token 进行哈希处理。一旦对 Token 进行哈希处理,就无法撤消操作。此标志在启用后无法禁用。有关详细信息,请参阅 [API 令牌](../../../api/api-tokens.md#令牌哈希)。
- `uiextension`: Enables UI extensions. This flag is enabled by default. Enabling or disabling the flag forces the Rancher pod to restart. The first time this flag is set to `true`, it creates a CRD and enables the controllers and endpoints necessary for the feature to work. If set to `false`, it disables the previously mentioned controllers and endpoints. Setting `uiextension` to `false` has no effect on the CRD -- it does not create a CRD if it does not yet exist, nor does it delete the CRD if it already exists.
@@ -38,7 +37,6 @@ title: 功能开关
| `fleet` | `true` | GA | v2.5.0 |
| `harvester` | `true` | 实验功能 | v2.6.1 |
| `legacy` | 新安装:`false`;升级:`true` | GA | v2.6.0 |
| `rke1-custom-node-cleanup` | `true` | GA | v2.6.0 |
| `rke2` | `true` | 实验功能 | v2.6.0 |
| `token-hashing` | 新安装:`false`;升级:`true` | GA | v2.6.0 |
| `uiextension` | `true` | GA | v2.9.0 | |
@@ -8,7 +8,7 @@ title: TLS 设置
当你在 Kubernetes 集群内安装 Rancher 时,TLS 会在集群的 Ingress Controller 上卸载。可用的 TLS 设置取决于使用的 Ingress Controller:
* nginx-ingress-controller(RKE1 和 RKE2 默认):[默认的 TLS 版本和密码](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-tls-version-and-ciphers)。
* nginx-ingress-controller(default RKE2 默认):[默认的 TLS 版本和密码](https://kubernetes.github.io/ingress-nginx/user-guide/tls/#default-tls-version-and-ciphers)。
* traefik(K3s 默认):[TLS 选项](https://doc.traefik.io/traefik/https/tls/#tls-options)。
## 在单个 Docker 容器中运行 Rancher
@@ -6,7 +6,7 @@ Rancher 是一个为使用容器的公司打造的容器管理平台。Rancher
## Run Kubernetes Everywhere
Kubernetes 已经成为容器编排标准。现在,大多数云和虚拟化提供商都提供容器编排服务。Rancher 用户可以选择使用 Rancher Kubernetes Engine(RKE)或云 Kubernetes 服务(例如 GKE、AKS 和 EKS)创建 Kubernetes 集群,还可以导入和管理使用任何 Kubernetes 发行版或安装程序创建的现有 Kubernetes 集群。
Kubernetes 已经成为容器编排标准。现在,大多数云和虚拟化提供商都提供容器编排服务。Rancher 用户可以选择使用 Rancher Kubernetes distributions(RKE2/K3s)或云 Kubernetes 服务(例如 GKE、AKS 和 EKS)创建 Kubernetes 集群,还可以导入和管理使用任何 Kubernetes 发行版或安装程序创建的现有 Kubernetes 集群。
## 满足 IT 需求规范
@@ -54,7 +54,7 @@ Rancher API Server 是基于嵌入式 Kubernetes API Server 和 etcd 数据库
## 使用 Rancher 编辑下游集群
对于已有集群而言,可提供的选项和设置取决于你配置集群的方法。例如,只有[通过 RKE 启动](../how-to-guides/new-user-guides/launch-kubernetes-with-rancher/launch-kubernetes-with-rancher.md)的集群才有可编辑的**集群选项**。
对于已有集群而言,可提供的选项和设置取决于你配置集群的方法。
使用 Rancher 创建集群后,集群管理员可以管理集群成员,管理节点池,或进行[其他操作](../reference-guides/cluster-configuration/cluster-configuration.md)。
@@ -27,12 +27,6 @@ Rancher 中有两种类型的驱动:
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
还有几个托管的 Kubernetes 云提供商是默认禁用的,但也打包在 Rancher 中:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
## 主机驱动
主机驱动用于配置主机,Rancher 使用这些主机启动和管理 Kubernetes 集群。主机驱动与 [Docker Machine 驱动](https://github.com/docker/docs/blob/vnext-engine/machine/drivers/index.md)相同。创建主机模板时可以显示的主机驱动,是由主机驱动的状态定义的。只有 `active` 主机驱动将显示为创建节点模板的选项。默认情况下,Rancher 与许多现有的 Docker Machine 驱动打包在一起,但你也可以创建自定义主机驱动并添加到 Rancher。
@@ -7,57 +7,6 @@ title: Pod 安全标准 (PSS) 和 Pod 安全准入 (PSA)
PSS 定义了工作负载的安全级别。PSA 描述了 Pod 安全上下文和相关字段的要求。PSA 参考 PSS 级别来定义安全限制。
#### 安装 `helm-mapkubeapis`
1. 在打算使用 `helm-mapkubeapis` 的机器上打开你的终端并安装插件:
```shell
helm plugin install https://github.com/helm/helm-mapkubeapis
```
你将看到类似于以下的输出:
```console
Downloading and installing helm-mapkubeapis v0.4.1 ...
https://github.com/helm/helm-mapkubeapis/releases/download/v0.4.1/helm-mapkubeapis_0.4.1_darwin_amd64.tar.gz
Installed plugin: mapkubeapis
```
:::info 重要提示
确保 `helm-mapkubeapis` 插件至少为 v0.4.1,因为旧版本_不_支持资源删除。
:::
1. 验证插件是否已正确安装:
```shell
helm mapkubeapis --help
```
你将看到类似于以下的输出:
```console
Map release deprecated or removed Kubernetes APIs in-place
Usage:
mapkubeapis [flags] RELEASE
Flags:
--dry-run simulate a command
-h, --help help for mapkubeapis
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--mapfile string path to the API mapping file
--namespace string namespace scope of the release
```
#### 清理损坏的版本
安装 `helm-mapkubeapis` 插件后,清理升级到 Kubernetes v1.25 后损坏的版本。
1. 打开你的首选终端并通过运行 `kubectl cluster-info` 确保终端已连接到所需集群。
1. 运行 `helm list --all-namespaces` 列出你在集群中安装的所有版本。
1. 通过运行 `helm mapkubeapis --dry-run <release-name> --namespace <release-namespace>` 为要清理的每个版本执行试运行。你可以通过此命令的结果了解要替换或删除哪些资源。
1. 最后,在查看更改后,使用 `helm mapkubeapis <release-name> --namespace <release-namespace>` 执行完整运行。
## Pod 安全准入配置模板
Rancher 提供了 PSA 配置模板。它们是可以应用到集群的预定义安全配置。Rancher 管理员(或具有权限的人员)可以[创建、管理和编辑](./psa-config-templates.md) PSA 模板。
@@ -1,59 +0,0 @@
---
title: 创建阿里云 ACK 集群
---
你可以使用 Rancher 创建托管在阿里云 Alibaba Cloud Kubernetes (ACK) 中的集群。Rancher 已经为 ACK 实现并打包了针对 ACK 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 ACK 集群,你需要[启用 ACK 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 ACK 集群。
## Rancher 之外的先决条件
:::caution
部署到 ACK 会产生费用。
:::
1. 在阿里云中,在对应的控制台中激活以下服务。
- [容器服务](https://cs.console.aliyun.com)
- [资源编排服务](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. 确保你用于创建 ACK 集群的账号具有适当的权限。详见阿里云[角色授权](https://www.alibabacloud.com/help/doc-detail/86483.htm)和[使用容器服务控制台作为 RAM 用户](https://www.alibabacloud.com/help/doc-detail/86484.htm)官方文档。
3. 在阿里云中,创建[访问密钥](https://www.alibabacloud.com/help/doc-detail/53045.html)。
4. 在阿里云中,创建 [SSH 密钥对](https://www.alibabacloud.com/help/doc-detail/51793.html)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用阿里云 ACK 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Alibaba ACK** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建阿里云 ACK 集群了。
## 创建 ACK 集群
1. 点击 **☰ > 集群管理**。
1. 在**集群**页面,点击**创建**。
1. 单击 **Alibaba ACK**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 为 ACK 集群配置**账号访问**。选择要在其中构建集群的地理区域,并输入在先决条件步骤中创建的访问密钥。
1. 点击**下一步:配置集群**,然后选择集群类型、Kubernetes 版本和可用区。
1. 如果选择 **Kubernetes** 作为集群类型,请单击**下一步:配置 master 节点**,然后填写 **master 节点**表单。
1. 单击**下一步:配置 Worker 节点**,然后填写 **Worker 节点**表单。
1. 检查并确认你的选项。然后单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -1,100 +0,0 @@
---
title: 创建华为 CCE 集群
---
你可以使用 Rancher 创建托管在华为云容器引擎 (CCE) 中的集群。Rancher 已经为 CCE 实现并打包了针对 CCE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 CCE 集群,你需要[启用 CCE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 CCE 集群。
## 华为先决条件
:::caution
部署到 CCE 会产生费用。
:::
1. 在华为 CCE 门户中找到你的项目 ID。请参阅 CCE 文档以了解如何[管理你的项目](https://doc.hcs.huawei.com/api/cce/cce_02_0341.html#cce_02_0341__section17571944123214)。
2. 创建一个[访问密钥 ID 和密文访问密钥](https://support.huaweicloud.com/en-us/usermanual-iam/en-us_topic_0079477318.html)。
## Rancher 先决条件
你需要启用华为 CCE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Huawei CCE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建华为 CCE 集群了。
## 限制
华为 CCE 服务不支持通过其 API 创建具有公共访问权限的集群。你需要在要配置的 CCE 集群的相同 VPC 中运行 Rancher。
## 创建 CCE 集群
1. 在**集群**页面,点击**创建**。
1. 单击 **Huawei CCE**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 输入**项目 ID**,访问密钥 ID,**Access Key**,和密文访问密钥 **Secret Key**。然后点击**下一步:配置集群**。填写集群配置。有关填写表单的帮助,请参阅[华为 CCE 配置](#华为-cce-配置)。
1. 填写集群的以下节点配置。有关填写表单的帮助,请参阅[节点配置](#节点配置)。
1. 点击**创建**来创建 CCE 集群。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
## 华为 CCE 配置
| 设置 | 描述 |
|---|---|
| 集群类型 | 要包含到集群的节点类型,可以是 `VirtualMachine` 或 `BareMetal`。 |
| 描述 | 集群的描述。 |
| 主版本 | Kubernetes 版本。 |
| 管理规模数量 | 集群的最大节点数。选项为 50、200 和 1000。规模计数越大,成本越高。 |
| 高可用性 | 启用 master 节点的高可用性。启用高可用性的集群成本会更高。 |
| 容器网络模式 | 集群中使用的网络模式。`VirtualMachine` 支持 `overlay_l2` 和 `vpc-router`,而 `BareMetal` 支持 `underlay_ipvlan`。 |
| 容器网络 CIDR | 集群的网络 CIDR。 |
| VPC 名称 | 要部署集群的 VPC 名称。如果留空,Rancher 将创建一个。 |
| 子网名称 | 要部署集群的子网名称。如果留空,Rancher 将创建一个。 |
| 外部服务器 | 预留选项,用于通过 API 启用 CCE 集群的公共访问。这个选项暂时是一直禁用的。 |
| 集群标签 | 集群的标签。 |
| 高速子网 | 只有 `BareMetal` 支持该选项。裸机要求选择网速高的 VPC。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅[配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
## 节点配置
| 设置 | 描述 |
|---|---|
| 地区 | 部署集群节点的可用区域。 |
| 计费方式 | 集群节点的计费模式。`VirtualMachine` 仅支持 `Pay-per-use`。`BareMetal` 支持 `Pay-per-use` 或 `Yearly/Monthly`。 |
| 有效期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示支付集群节点费用的时间。 |
| 自动续期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示是否为集群节点自动续期 `Yearly/Monthly` 计费。 |
| 数据卷类型 | 集群节点的数据卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 数据量大小 | 集群节点的数据卷大小。 |
| 根卷类型 | 集群节点的根卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 根卷大小 | 集群节点的根卷大小。 |
| 节点风格 | 集群节点的节点风格。Rancher UI 中的风格列表取自华为云。其中包括所有支持的节点风格。 |
| 节点数 | 集群的节点数 |
| 节点操作系统 | 集群节点的操作系统。目前仅支持 `EulerOS 2.2` 和 `CentOS 7.4`。 |
| SSH 密钥名称 | 集群节点的 SSH 密钥 |
| EIP | 集群节点的公共 IP 选项。`已禁用`表示集群节点不会绑定公共 IP。`创建 EIP`表示集群节点在配置后将绑定一个或多个新创建的 EIP,UI 中将显示更多用来创建 EIP 参数的选项。`选择现有 EIP` 表示节点将绑定到你选择的 EIP。 |
| EIP 数量 | 此选项仅在选择`创建 EIP`时显示。表示你要为节点创建的 EIP 数量。 |
| EIP 类型 | 此选项仅在选择`创建 EIP`时显示。可选 `5_bgp` 和 `5_sbgp`。 |
| EIP 共享类型 | 此选项仅在选择`创建 EIP`时显示。仅可选 `PER`。 |
| EIP 收费模式 | 此选项仅在选择`创建 EIP`时显示。选择按照`带宽`或`流量`计费。 |
| EIP 带宽大小 | 此选项仅在选择`创建 EIP`时显示。EIP 的带宽。 |
| 身份验证模式 | 表示启用 `RBAC`,或同时启用`认证代理`。如果选择`认证代理`,则还需要用于验证代理的证书。 |
| 节点标签 | 集群节点的标签。无效标签会阻止升级,或阻止 Rancher 启动。有关标签语法的详细信息,请参阅 [Kubernetes 文档](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。 |
@@ -17,9 +17,6 @@ Rancher 支持以下 Kubernetes 提供商:
- [Google GKE (Google Kubernetes Engine)](https://cloud.google.com/kubernetes-engine/)
- [Amazon EKS (Amazon Elastic Container Service for Kubernetes)](https://aws.amazon.com/eks/)
- [Microsoft AKS (Azure Kubernetes Service)](https://azure.microsoft.com/en-us/services/kubernetes-service/)
- [Alibaba ACK (Alibaba Cloud Container Service for Kubernetes)](https://www.alibabacloud.com/product/kubernetes)
- [Tencent TKE (Tencent Kubernetes Engine)](https://intl.cloud.tencent.com/product/tke)
- [Huawei CCE (Huawei Cloud Container Engine)](https://www.huaweicloud.com/en-us/product/cce.html)
## 托管 Kubernetes 提供商的认证
@@ -28,6 +25,3 @@ Rancher 支持以下 Kubernetes 提供商:
- [创建 GKE 集群](gke.md)
- [创建 EKS 集群](eks.md)
- [创建 AKS 集群](aks.md)
- [创建 ACK 集群](alibaba.md)
- [创建 TKE 集群](tencent.md)
- [创建 CCE 集群](huawei.md)
@@ -1,99 +0,0 @@
---
title: 创建腾讯 TKE 集群
---
你可以使用 Rancher 创建托管在腾讯 Tencent Kubernetes Engine (TKE) 中的集群。Rancher 已经为 TKE 实现并打包了针对 TKE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 TKE 集群,你需要[启用 TKE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 TKE 集群。
## 腾讯先决条件
:::caution
部署到 TKE 会产生费用。
:::
1. 参见[云访问管理](https://intl.cloud.tencent.com/document/product/598/10600)文档,确保用于创建 TKE 集群的账号具有适当的权限。
2. 创建[云 API 密钥 ID 和密钥](https://console.cloud.tencent.com/capi)。
3. 在要部署 Kubernetes 集群的区域中创建[私有网络和子网](https://intl.cloud.tencent.com/document/product/215/4927)。
4. 创建 [SSH 密钥对](https://intl.cloud.tencent.com/document/product/213/6092)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用腾讯 TKE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Tencent TKE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建腾讯 TKE 集群了。
## 创建 TKE 集群
1. 在**集群**页面,点击**创建**。
2. 选择 **Tencent TKE**。
3. 输入**集群名称**。
4. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
5. 为 TKE 集群配置**账号访问**。使用[先决条件](#腾讯先决条件)中获得的信息完成每个下拉列表和字段。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 区域 | 从下拉列表中选择构建集群的地理区域。 |
| 密文 ID | 输入从腾讯云控制台获取的密文 ID。 |
| 密文密钥 | 输入从腾讯云控制台获取的密文密钥。 |
6. 然后,单击`下一步:配置集群`来配置 TKE 集群。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Kubernetes 版本 | TKE 目前只支持 Kubernetes 1.10.5。 |
| 节点数 | 输入要为 Kubernetes 集群购买的 worker 节点数,最大值是 100。 |
| VPC | 选择在腾讯云控制台中创建的 VPC 名称。 |
| 容器网络 CIDR | 输入 Kubernetes 集群的 CIDR 范围。你可以在腾讯云控制台的 VPC 服务中查看该 CIDR 的可用范围。默认为 172.16.0.0/16。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅 [Rancher 2.3.0+ 配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
7. 点击`下一步:选择实例类型`,然后选择将用于 TKE 集群的实例类型。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 可用区 | 选择 VPC 区域的可用区。 |
| 子网 | 选择你在 VPC 中创建的子网。如果在所选可用区中没有该子网,请添加一个新子网。 |
| 实例类型 | 从下拉列表中选择要用于 TKE 集群的 VM 实例类型,默认为 S2.MEDIUM4(CPU 2;内存 4 GiB)。 |
8. 点击`下一步:配置实例`,配置用于 TKE 集群的 VM 实例。
| 选项 | 描述 |
-------|------------
| 操作系统 | 操作系统名称,目前支持 Centos7.2x86_64 或 ubuntu16.04.1 LTSx86_64。 |
| 安全组 | 安全组 ID,默认不绑定任何安全组。 |
| 根磁盘类型 | 系统盘类型。系统盘类型限制详见 [CVM 实例配置](https://cloud.tencent.com/document/product/213/11518)。 |
| 根磁盘大小 | 系统盘大小。Linux 系统调整范围为 20-50 GB,步长为 1。 |
| 数据盘类型 | 数据盘类型,默认为 SSD 云盘。 |
| 数据磁盘大小 | 数据盘大小(GB),步长为 10。 |
| 带宽类型 | 带宽收费类型,PayByTraffic 或 PayByHour。 |
| 带宽 | 公网带宽 (Mbps) |
| 密钥对 | 密钥 ID,关联后可以用来登录 VM 节点。 |
9. 单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -3,82 +3,58 @@ title: 使用 Rancher 启动 Kubernetes
---
<head>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/zh/how-to-guides/new-user-guides/launch-kubernetes-with-rancher"/>
<link rel="canonical" href="https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/launch-kubernetes-with-rancher"/>
</head>
Rancher 可以使用任意节点启动 Kubernetes 集群。在 Rancher 中将 Kubernetes 部署到这些节点上时,你可以选择 [Rancher Kubernetes Engine](https://rancher.com/docs/rke/latest/en/) (RKE) 或 [RKE2](https://docs.rke2.io) 发行版。Rancher 可以在任何计算机上启动 Kubernetes,包括:
Rancher allows you to launch a Kubernetes cluster on different types of nodes, including bare-metal servers, on-premise virtual machines, and virtual machines from an infrastructure provider. When deploying Kubernetes to these nodes, Rancher gives you the option to use [RKE2](https://docs.rke2.io).
- 裸金属服务器
- 本地虚拟机
- 由云厂商托管的虚拟机
Rancher can install Kubernetes on existing nodes, or it can dynamically provision nodes in an infrastructure provider and install Kubernetes on them.
Rancher 可以在现有节点上安装 Kubernetes,也可以在云厂商中动态配置节点并安装 Kubernetes。
Rancher 还可以创建节点池。在托管在云厂商的节点池上安装 Kubernetes 的一个好处是,如果一个节点与集群断开连接,Rancher 可以自动创建另一个节点并将其加入集群,从而确保节点池的数量符合要求。
## RKE
### 要求
如果你使用 RKE 建立集群,节点必须满足下游集群的[节点要求](../kubernetes-clusters-in-rancher-setup/node-requirements-for-rancher-managed-clusters.md)。
### 在云厂商的新节点上启动 Kubernetes
使用 Rancher,你可以基于[节点模板](use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md#节点模板)创建节点池。此节点模板定义了要用于在云厂商中启动节点的参数。
在托管在云厂商的节点池上安装 Kubernetes 的一个好处是,如果一个节点与集群断开连接,Rancher 可以自动创建另一个节点并将其加入集群,从而确保节点池的数量符合要求。
有关详细信息,请参阅[在新节点上启动 Kubernetes](use-new-nodes-in-an-infra-provider/use-new-nodes-in-an-infra-provider.md)。
### 在现有自定义节点上启动 Kubernetes
在这种情况下,你希望将 Kubernetes 安装到裸机服务器、本地虚拟机或云厂商中已存在的虚拟机上。使用此选项,你将在主机上运行 Rancher Agent Docker 容器。
如果要重复使用之前的自定义集群中的节点,请在复用之前[清理节点](../manage-clusters/clean-cluster-nodes.md)。如果你重复使用尚未清理的节点,则集群配置可能会失败。
有关详细信息,请参阅[自定义节点](../../../reference-guides/cluster-configuration/rancher-server-configuration/use-existing-nodes/use-existing-nodes.md)。
### 以编程方式创建 RKE 集群
通过 Rancher 以编程方式部署 RKE 集群的最常见方法是使用 Rancher 2 Terraform Provider。详情请参见[使用 Terraform 创建集群](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster)。
Rancher can also create pools of machines. One benefit of installing Kubernetes on machine pools hosted by an infrastructure provider is that if a node loses connectivity with the cluster, Rancher can automatically create another node to join the cluster to ensure that the count of the machine pool is as expected.
## RKE2
Rancher 2.6 支持直接使用 Rancher UI 配置 [RKE2](https://docs.rke2.io/) 集群。RKE2,也称为 RKE Government,是一个完全符合标准的 Kubernetes 发行版,它专注于安全性和合规性。在 Rancher 2.6.4 及更早版本中,RKE2 配置还处于技术预览阶段。
Rancher v2.6 introduced provisioning for [RKE2](https://docs.rke2.io/) clusters directly from the Rancher UI. RKE2, also known as RKE Government, is a fully conformant Kubernetes distribution that focuses on security and compliance within the U.S. Federal Government sector. In Rancher v.2.6.4 and earlier, RKE2 provisioning was in tech preview.
在 Rancher 2.6.5 中,RKE2 已经 GA。
Note that in Rancher v2.6.5, RKE2 provisioning became GA.
### 要求
### Requirements
如果你使用 RKE2 建立集群,节点必须满足下游集群的[节点要求](https://docs.rke2.io/install/requirements)。
If you use RKE2 to set up a cluster, your nodes must meet the [requirements](https://docs.rke2.io/install/requirements) for nodes in downstream user clusters.
### 在云厂商的新节点上启动 Kubernetes
### Launching Kubernetes on New Nodes in an Infrastructure Provider
RKE2 基于使用上游[集群 API](https://github.com/kubernetes-sigs/cluster-api) 项目的新配置框架。这个新配置框架支持:
RKE2 provisioning is built on top of a new provisioning framework that leverages the upstream [Cluster API (CAPI)](https://github.com/kubernetes-sigs/cluster-api) project. With this new provisioning framework, you can:
- 将 RKE2 集群配置到 Rancher 具有主机驱动的任何提供商上
- 完全在 Rancher 中配置 RKE2 集群
- 除了 Canal 之外,还可以选择 CNI 选项, Calico、Cilium 和 Multus
- Provision RKE2 clusters onto any provider for which Rancher has a node driver.
- Fully configure RKE2 clusters within Rancher.
- Choose CNI options Calico, Cilium, and Multus in addition to Canal.
RKE2 配置还包括在具有 Windows 节点的集群上安装 RKE2。
When you make changes to your cluster configuration in RKE2, this may result in nodes reprovisioning. This is controlled by CAPI controllers and not by Rancher itself. Note that for etcd nodes, the same behavior does not apply.
RKE2 的 Windows 功能包括:
The following are some specific example configuration changes that may cause the described behavior:
- Windows 支持 vSphere 主机驱动
- 用于 Windows RKE2 自定义集群的 Calico CNI
- Calico 的项目网络隔离 (PNI)
- 由 containerd 提供支持的使用 RKE2 的 Windows 容器
- 通过 Terraform 配置 Windows RKE2 集群
- 直接从 Rancher UI 配置 Windows RKE2 自定义集群
- When editing the cluster and enabling drain before delete, the existing control plane nodes and worker are deleted and new nodes are created.
要使 Windows 支持 RKE2 自定义集群,请选择 Calico 作为 CNI。
RKE2 provisioning also includes installing RKE2 on clusters with Windows nodes.
### 在现有自定义节点上启动 Kubernetes
Windows features for RKE2 include:
RKE2 还支持在预配置的虚拟机或裸机节点上安装自定义集群。
- Windows supports the vSphere node driver
- Calico and Flannel CNI for Windows RKE2 custom clusters
- Project Network Isolation (PNI) for Calico
- Windows Containers with RKE2 powered by containerd
- Provisioning of Windows RKE2 clusters through Terraform
- Provisioning of Windows RKE2 custom clusters directly from the Rancher UI
如果要重复使用之前的自定义集群中的节点,请在复用之前清理节点。如果你重复使用尚未清理的节点,则集群配置可能会失败。
Windows Support for RKE2 Custom Clusters requires choosing Calico as the CNI.
### 以编程方式创建 RKE2 集群
### Launching Kubernetes on Existing Custom Nodes
通过 Rancher 以编程方式部署 RKE2 集群的最常见方法是使用 Rancher 2 Terraform Provider。详情请参见[使用 Terraform 创建集群](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2)。
RKE2 provisioning also allows you to install custom clusters on previously provisioned VMs or bare-metal nodes.
If you want to reuse a node from a previous custom cluster, [clean the node](../manage-clusters/clean-cluster-nodes.md#cleaning-up-nodes) before using it in a cluster again. If you reuse a node that hasn't been cleaned, cluster provisioning may fail.
### Programmatically Creating RKE2 Clusters
The most common way to programmatically deploy RKE2 clusters through Rancher is by using the [Rancher2 Terraform provider](https://registry.terraform.io/providers/rancher/rancher2/latest/docs/resources/cluster_v2).
@@ -15,6 +15,7 @@ title: 安装 Adapter
| Rancher 版本 | Adapter 版本 |
|-----------------|:----------------:|
| v2.12.1 | 107.0.0+up7.0.0 |
| v2.12.0 | 107.0.0+up7.0.0 |
## 1. 获取对 Local 集群的访问权限
@@ -55,7 +55,6 @@ Logging v2 已在 RHEL/CentOS 7 和 8 上使用 SELinux 进行了测试。
| 日志来源 | Linux 节点(包括在 Windows 集群中) | Windows 节点 |
| --- | --- | ---|
| RKE | ✓ | ✓ |
| RKE2 | ✓ | |
| K3s | ✓ | |
| AKS | ✓ | |
@@ -211,7 +211,7 @@ Prometheus 直接抓取以下 Kubernetes 组件:
\* 你可以选择通过 `hardenedKubelet.enabled` 来使用 PushProx,但这不是默认设置。
\*\* RKE 和 RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
\*\* RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
### 基于 Kubernetes 发行版抓取指标
@@ -220,18 +220,18 @@ Prometheus 直接抓取以下 Kubernetes 组件:
<figcaption>指标如何暴露给 Prometheus</figcaption>
| Kubernetes 组件 | RKE | RKE2 | KubeADM | K3s |
| Kubernetes 组件 | RKE2 | KubeADM | K3s |
|-----|-----|-----|-----|-----|
| kube-controller-manager | rkeControllerManager.enabled | rke2ControllerManager.enabled | kubeAdmControllerManager.enabled | k3sServer.enabled |
| kube-scheduler | rkeScheduler.enabled | rke2Scheduler.enabled | kubeAdmScheduler.enabled | k3sServer.enabled |
| etcd | rkeEtcd.enabled | rke2Etcd.enabled | kubeAdmEtcd.enabled | 不可用 |
| kube-proxy | rkeProxy.enabled | rke2Proxy.enabled | kubeAdmProxy.enabled | k3sServer.enabled |
| kubelet | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 |
| ingress-nginx* | 收集 kubelet 直接公开的指标,由 rkeIngressNginx.enabled 公开 | 收集 kubelet 直接公开的指标,由 rke2IngressNginx.enabled 公开 | 不可用 | 不可用 |
| coreDns/kubeDns | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 |
| kube-api-server | 收集 kube-api-server 直接公开的指标 | 收集 kube-api-server 直接公开的指标 | 收集 kube-appi-server 直接公开的指标 | 收集 kube-api-server 直接公开的指标 |
| kube-controller-manager | rke2ControllerManager.enabled | kubeAdmControllerManager.enabled | k3sServer.enabled |
| kube-scheduler | rke2Scheduler.enabled | kubeAdmScheduler.enabled | k3sServer.enabled |
| etcd | rke2Etcd.enabled | kubeAdmEtcd.enabled | 不可用 |
| kube-proxy | rke2Proxy.enabled | kubeAdmProxy.enabled | k3sServer.enabled |
| kubelet | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 | 收集 kubelet 直接公开的指标 |
| ingress-nginx* | 收集 kubelet 直接公开的指标,由 rke2IngressNginx.enabled 公开 | 不可用 | 不可用 |
| coreDns/kubeDns | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 | 收集 coreDns/kubeDns 直接公开的指标 |
| kube-api-server | 收集 kube-api-server 直接公开的指标 | 收集 kube-appi-server 直接公开的指标 | 收集 kube-api-server 直接公开的指标 |
\* RKE 和 RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
\* RKE2 集群默认部署 ingress-nginx,并将其视为内部 Kubernetes 组件。
### 名词解释
@@ -92,8 +92,6 @@ Rancher 和 Project 的读取权限并不一定适用于监控相关资源. 查
## Windows 集群支持
如果 Monitoring 部署到 RKE1 Windows 集群,Monitoring V2 将自动部署 [windows-exporter](https://github.com/prometheus-community/windows_exporter) DaemonSet 并设置 ServiceMonitor,以从每个部署的 Pod 中收集指标。这将使用 `windows_` 指标填充 Prometheus,这些指标与 [node_exporter](https://github.com/prometheus/node_exporter) 为 Linux 主机导出的 `node_` 指标类似。
为了能够为 Windows 完全部署 Monitoring V2,你的所有 Windows 主机都必须至少具有 v0.1.0 的 [wins](https://github.com/rancher/wins) 版本。
有关如何在现有 Windows 主机上升级 wins 版本的更多信息,请参阅 [Windows 集群对 Monitoring V2 的支持](windows-support.md)。
@@ -10,8 +10,6 @@ _从 v2.5.8 起可用_
Monitoring V2 for Windows 只能从最低是 `wins` v0.1.0 的 Windows 主机中抓取指标。要完全部署 Monitoring V2 for Windows,你的所有主机都必须满足此要求。
如果你在 Rancher 2.5.8 中配置新的 RKE1 集群,你的集群应该已经满足此要求。
### 将现有集群升级到 wins v0.1.0
如果集群是在 Rancher 2.5.8 之前配置的(即使当前 Rancher 版本是 2.5.8),你将无法成功部署 Monitoring V2 for Windows,除非你将每台主机的 wins 版本升级到 v0.1.0 或以上版本。
@@ -19,6 +17,7 @@ Monitoring V2 for Windows 只能从最低是 `wins` v0.1.0 的 Windows 主机中
为了方便此次升级,Rancher 2.5.8 发布了一个全新的 Helm Chart,名为 `rancher-wins-upgrader`。
1. 使用以下覆盖部署 `rancher-wins-upgrader`:
```yaml
# 通过先前已列入白名单的进程路径
# 来引导 win-upgrader 安装,这是因为正常安装路径
@@ -29,15 +28,9 @@ Monitoring V2 for Windows 只能从最低是 `wins` v0.1.0 的 Windows 主机中
enabled: true
as: c:\\etc\wmi-exporter\wmi-exporter.exe
```
:::note 非默认 Windows 前缀路径的注意事项:
- 如果你使用具有非默认 `win_prefix_path` 的 `cluster.yml` 来设置 RKE 集群,你需要将 `c:\\` 替换为你的前缀路径字段的值来修改 `masquerade.as`。
- 例如,如果你使用 `win_prefix_path: 'c:\host\opt\'`,则需要设置为 `as: c:\host\opt\etc\wmi-exporter\wmi-exporter.exe`。
:::
2. 成功升级所有主机后,请再次使用默认值部署 Helm Chart,以避免与以下设置发生冲突:
```yaml
masquerade:
enabled: false
@@ -25,7 +25,6 @@ Harvester Helm Chart 用于管理 Rancher 中 NeuVector UI 的访问,用户可
以下是一些例子:
- RKE1:`docker`
- K3s 和 RKE2:`k3scontainerd`
- AKS:`containerd` 适用于 v1.19 及更高版本
- EKS:`docker` 适用于 v1.22 及以下版本;`containerd` 适用于 v1.23 及更高版本
@@ -97,6 +97,12 @@ Rancher 可以动态启动云上(如 Amazon EC2、DigitalOcean、Azure 或 vSp
Rancher 使用 [docker-machine](https://github.com/rancher/machine) 来配置这类型的集群。
### Rancher Launched Kubernetes for Custom Nodes
When setting up this type of cluster, Rancher installs Kubernetes on existing nodes, which creates a custom cluster.
Rancher provisions this type of cluster using https://github.com/rancher/rke2[RKE2] or https://github.com/rancher/k3s[K3s].
### 托管的 Kubernetes 提供商
配置此类集群时,Kubernetes 由云提供商安装,如 GKE、ECS 或 AKS 等。
@@ -20,6 +20,7 @@ Rancher 将 Rancher-Webhook 作为单独的 deployment 和服务部署在 local
| Rancher Version | Webhook Version | Availability in Prime | Availability in Community |
|-----------------|-----------------|-----------------------|---------------------------|
| v2.12.1 | v0.8.1 | &check; | &check; |
| v2.12.0 | v0.8.0 | &cross; | &check; |
## 为什么我们需要它?
@@ -27,12 +27,6 @@ Rancher 中有两种类型的驱动:
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
还有几个托管的 Kubernetes 云提供商是默认禁用的,但也打包在 Rancher 中:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
## 主机驱动
主机驱动用于配置主机,Rancher 使用这些主机启动和管理 Kubernetes 集群。主机驱动与 [Docker Machine 驱动](https://github.com/docker/docs/blob/vnext-engine/machine/drivers/index.md)相同。创建主机模板时可以显示的主机驱动,是由主机驱动的状态定义的。只有 `active` 主机驱动将显示为创建节点模板的选项。默认情况下,Rancher 与许多现有的 Docker Machine 驱动打包在一起,但你也可以创建自定义主机驱动并添加到 Rancher。
@@ -1,59 +0,0 @@
---
title: 创建阿里云 ACK 集群
---
你可以使用 Rancher 创建托管在阿里云 Alibaba Cloud Kubernetes (ACK) 中的集群。Rancher 已经为 ACK 实现并打包了针对 ACK 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 ACK 集群,你需要[启用 ACK 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 ACK 集群。
## Rancher 之外的先决条件
:::caution
部署到 ACK 会产生费用。
:::
1. 在阿里云中,在对应的控制台中激活以下服务。
- [容器服务](https://cs.console.aliyun.com)
- [资源编排服务](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. 确保你用于创建 ACK 集群的账号具有适当的权限。详见阿里云[角色授权](https://www.alibabacloud.com/help/doc-detail/86483.htm)和[使用容器服务控制台作为 RAM 用户](https://www.alibabacloud.com/help/doc-detail/86484.htm)官方文档。
3. 在阿里云中,创建[访问密钥](https://www.alibabacloud.com/help/doc-detail/53045.html)。
4. 在阿里云中,创建 [SSH 密钥对](https://www.alibabacloud.com/help/doc-detail/51793.html)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用阿里云 ACK 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Alibaba ACK** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建阿里云 ACK 集群了。
## 创建 ACK 集群
1. 点击 **☰ > 集群管理**。
1. 在**集群**页面,点击**创建**。
1. 单击 **Alibaba ACK**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 为 ACK 集群配置**账号访问**。选择要在其中构建集群的地理区域,并输入在先决条件步骤中创建的访问密钥。
1. 点击**下一步:配置集群**,然后选择集群类型、Kubernetes 版本和可用区。
1. 如果选择 **Kubernetes** 作为集群类型,请单击**下一步:配置 master 节点**,然后填写 **master 节点**表单。
1. 单击**下一步:配置 Worker 节点**,然后填写 **Worker 节点**表单。
1. 检查并确认你的选项。然后单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -1,100 +0,0 @@
---
title: 创建华为 CCE 集群
---
你可以使用 Rancher 创建托管在华为云容器引擎 (CCE) 中的集群。Rancher 已经为 CCE 实现并打包了针对 CCE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 CCE 集群,你需要[启用 CCE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 CCE 集群。
## 华为先决条件
:::caution
部署到 CCE 会产生费用。
:::
1. 在华为 CCE 门户中找到你的项目 ID。请参阅 CCE 文档以了解如何[管理你的项目](https://doc.hcs.huawei.com/api/cce/cce_02_0341.html#cce_02_0341__section17571944123214)。
2. 创建一个[访问密钥 ID 和密文访问密钥](https://support.huaweicloud.com/en-us/usermanual-iam/en-us_topic_0079477318.html)。
## Rancher 先决条件
你需要启用华为 CCE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Huawei CCE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建华为 CCE 集群了。
## 限制
华为 CCE 服务不支持通过其 API 创建具有公共访问权限的集群。你需要在要配置的 CCE 集群的相同 VPC 中运行 Rancher。
## 创建 CCE 集群
1. 在**集群**页面,点击**创建**。
1. 单击 **Huawei CCE**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 输入**项目 ID**,访问密钥 ID,**Access Key**,和密文访问密钥 **Secret Key**。然后点击**下一步:配置集群**。填写集群配置。有关填写表单的帮助,请参阅[华为 CCE 配置](#华为-cce-配置)。
1. 填写集群的以下节点配置。有关填写表单的帮助,请参阅[节点配置](#节点配置)。
1. 点击**创建**来创建 CCE 集群。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
## 华为 CCE 配置
| 设置 | 描述 |
|---|---|
| 集群类型 | 要包含到集群的节点类型,可以是 `VirtualMachine` 或 `BareMetal`。 |
| 描述 | 集群的描述。 |
| 主版本 | Kubernetes 版本。 |
| 管理规模数量 | 集群的最大节点数。选项为 50、200 和 1000。规模计数越大,成本越高。 |
| 高可用性 | 启用 master 节点的高可用性。启用高可用性的集群成本会更高。 |
| 容器网络模式 | 集群中使用的网络模式。`VirtualMachine` 支持 `overlay_l2` 和 `vpc-router`,而 `BareMetal` 支持 `underlay_ipvlan`。 |
| 容器网络 CIDR | 集群的网络 CIDR。 |
| VPC 名称 | 要部署集群的 VPC 名称。如果留空,Rancher 将创建一个。 |
| 子网名称 | 要部署集群的子网名称。如果留空,Rancher 将创建一个。 |
| 外部服务器 | 预留选项,用于通过 API 启用 CCE 集群的公共访问。这个选项暂时是一直禁用的。 |
| 集群标签 | 集群的标签。 |
| 高速子网 | 只有 `BareMetal` 支持该选项。裸机要求选择网速高的 VPC。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅[配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
## 节点配置
| 设置 | 描述 |
|---|---|
| 地区 | 部署集群节点的可用区域。 |
| 计费方式 | 集群节点的计费模式。`VirtualMachine` 仅支持 `Pay-per-use`。`BareMetal` 支持 `Pay-per-use` 或 `Yearly/Monthly`。 |
| 有效期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示支付集群节点费用的时间。 |
| 自动续期 | 该选项仅在 `Yearly/Monthly` 计费模式中显示。表示是否为集群节点自动续期 `Yearly/Monthly` 计费。 |
| 数据卷类型 | 集群节点的数据卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 数据量大小 | 集群节点的数据卷大小。 |
| 根卷类型 | 集群节点的根卷类型。可选 `SATA`,`SSD` 或 `SAS`。 |
| 根卷大小 | 集群节点的根卷大小。 |
| 节点风格 | 集群节点的节点风格。Rancher UI 中的风格列表取自华为云。其中包括所有支持的节点风格。 |
| 节点数 | 集群的节点数 |
| 节点操作系统 | 集群节点的操作系统。目前仅支持 `EulerOS 2.2` 和 `CentOS 7.4`。 |
| SSH 密钥名称 | 集群节点的 SSH 密钥 |
| EIP | 集群节点的公共 IP 选项。`已禁用`表示集群节点不会绑定公共 IP。`创建 EIP`表示集群节点在配置后将绑定一个或多个新创建的 EIP,UI 中将显示更多用来创建 EIP 参数的选项。`选择现有 EIP` 表示节点将绑定到你选择的 EIP。 |
| EIP 数量 | 此选项仅在选择`创建 EIP`时显示。表示你要为节点创建的 EIP 数量。 |
| EIP 类型 | 此选项仅在选择`创建 EIP`时显示。可选 `5_bgp` 和 `5_sbgp`。 |
| EIP 共享类型 | 此选项仅在选择`创建 EIP`时显示。仅可选 `PER`。 |
| EIP 收费模式 | 此选项仅在选择`创建 EIP`时显示。选择按照`带宽`或`流量`计费。 |
| EIP 带宽大小 | 此选项仅在选择`创建 EIP`时显示。EIP 的带宽。 |
| 身份验证模式 | 表示启用 `RBAC`,或同时启用`认证代理`。如果选择`认证代理`,则还需要用于验证代理的证书。 |
| 节点标签 | 集群节点的标签。无效标签会阻止升级,或阻止 Rancher 启动。有关标签语法的详细信息,请参阅 [Kubernetes 文档](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#syntax-and-character-set)。 |
@@ -17,9 +17,6 @@ Rancher 支持以下 Kubernetes 提供商:
- [Google GKE (Google Kubernetes Engine)](https://cloud.google.com/kubernetes-engine/)
- [Amazon EKS (Amazon Elastic Container Service for Kubernetes)](https://aws.amazon.com/eks/)
- [Microsoft AKS (Azure Kubernetes Service)](https://azure.microsoft.com/en-us/services/kubernetes-service/)
- [Alibaba ACK (Alibaba Cloud Container Service for Kubernetes)](https://www.alibabacloud.com/product/kubernetes)
- [Tencent TKE (Tencent Kubernetes Engine)](https://intl.cloud.tencent.com/product/tke)
- [Huawei CCE (Huawei Cloud Container Engine)](https://www.huaweicloud.com/en-us/product/cce.html)
## 托管 Kubernetes 提供商的认证
@@ -28,6 +25,4 @@ Rancher 支持以下 Kubernetes 提供商:
- [创建 GKE 集群](gke.md)
- [创建 EKS 集群](eks.md)
- [创建 AKS 集群](aks.md)
- [创建 ACK 集群](alibaba.md)
- [创建 TKE 集群](tencent.md)
- [创建 CCE 集群](huawei.md)
@@ -1,99 +0,0 @@
---
title: 创建腾讯 TKE 集群
---
你可以使用 Rancher 创建托管在腾讯 Tencent Kubernetes Engine (TKE) 中的集群。Rancher 已经为 TKE 实现并打包了针对 TKE 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 TKE 集群,你需要[启用 TKE 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 TKE 集群。
## 腾讯先决条件
:::caution
部署到 TKE 会产生费用。
:::
1. 参见[云访问管理](https://intl.cloud.tencent.com/document/product/598/10600)文档,确保用于创建 TKE 集群的账号具有适当的权限。
2. 创建[云 API 密钥 ID 和密钥](https://console.cloud.tencent.com/capi)。
3. 在要部署 Kubernetes 集群的区域中创建[私有网络和子网](https://intl.cloud.tencent.com/document/product/215/4927)。
4. 创建 [SSH 密钥对](https://intl.cloud.tencent.com/document/product/213/6092)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用腾讯 TKE 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Tencent TKE** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建腾讯 TKE 集群了。
## 创建 TKE 集群
1. 在**集群**页面,点击**创建**。
2. 选择 **Tencent TKE**。
3. 输入**集群名称**。
4. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
5. 为 TKE 集群配置**账号访问**。使用[先决条件](#腾讯先决条件)中获得的信息完成每个下拉列表和字段。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 区域 | 从下拉列表中选择构建集群的地理区域。 |
| 密文 ID | 输入从腾讯云控制台获取的密文 ID。 |
| 密文密钥 | 输入从腾讯云控制台获取的密文密钥。 |
6. 然后,单击`下一步:配置集群`来配置 TKE 集群。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| Kubernetes 版本 | TKE 目前只支持 Kubernetes 1.10.5。 |
| 节点数 | 输入要为 Kubernetes 集群购买的 worker 节点数,最大值是 100。 |
| VPC | 选择在腾讯云控制台中创建的 VPC 名称。 |
| 容器网络 CIDR | 输入 Kubernetes 集群的 CIDR 范围。你可以在腾讯云控制台的 VPC 服务中查看该 CIDR 的可用范围。默认为 172.16.0.0/16。 |
:::note
如果你在 `cluster.yml` 中编辑集群,而不是使用 Rancher UI,则集群配置参数必须嵌套在 `cluster.yml` 中的 `rancher_kubernetes_engine_config` 中。有关详细信息,请参阅 [Rancher 2.3.0+ 配置文件结构](../../../../reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md#rancher-中的配置文件结构)。
:::
7. 点击`下一步:选择实例类型`,然后选择将用于 TKE 集群的实例类型。
| 选项 | 描述 |
| ---------- | -------------------------------------------------------------------------------------------------------------------- |
| 可用区 | 选择 VPC 区域的可用区。 |
| 子网 | 选择你在 VPC 中创建的子网。如果在所选可用区中没有该子网,请添加一个新子网。 |
| 实例类型 | 从下拉列表中选择要用于 TKE 集群的 VM 实例类型,默认为 S2.MEDIUM4(CPU 2;内存 4 GiB)。 |
8. 点击`下一步:配置实例`,配置用于 TKE 集群的 VM 实例。
| 选项 | 描述 |
-------|------------
| 操作系统 | 操作系统名称,目前支持 Centos7.2x86_64 或 ubuntu16.04.1 LTSx86_64。 |
| 安全组 | 安全组 ID,默认不绑定任何安全组。 |
| 根磁盘类型 | 系统盘类型。系统盘类型限制详见 [CVM 实例配置](https://cloud.tencent.com/document/product/213/11518)。 |
| 根磁盘大小 | 系统盘大小。Linux 系统调整范围为 20-50 GB,步长为 1。 |
| 数据盘类型 | 数据盘类型,默认为 SSD 云盘。 |
| 数据磁盘大小 | 数据盘大小(GB),步长为 10。 |
| 带宽类型 | 带宽收费类型,PayByTraffic 或 PayByHour。 |
| 带宽 | 公网带宽 (Mbps) |
| 密钥对 | 密钥 ID,关联后可以用来登录 VM 节点。 |
9. 单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。
@@ -16,6 +16,7 @@ Rancher 将在 GitHub 上发布的 Rancher 的[发版说明](https://github.com/
| Patch 版本 | 发布时间 |
| --------------------------------------------------------------- | -------------------|
| [2.9.11](https://github.com/rancher/rancher/releases/tag/v2.9.11)| 2025 年 8 月 27 日 |
| [2.9.10](https://github.com/rancher/rancher/releases/tag/v2.9.10)| 2025 年 5 月 22 日 |
| [2.9.9](https://github.com/rancher/rancher/releases/tag/v2.9.9) | 2025 年 4 月 24 日 |
| [2.9.8](https://github.com/rancher/rancher/releases/tag/v2.9.8) | 2025 年 3 月 31 日 |
@@ -27,12 +27,6 @@ Rancher 中有两种类型的驱动:
* [Google GKE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/gke.md)
* [Azure AKS](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/aks.md)
还有几个托管的 Kubernetes 云提供商是默认禁用的,但也打包在 Rancher 中:
* [Alibaba ACK](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/alibaba.md)
* [Huawei CCE](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/huawei.md)
* [Tencent](../../kubernetes-clusters-in-rancher-setup/set-up-clusters-from-hosted-kubernetes-providers/tencent.md)
### 主机驱动
主机驱动用于配置主机,Rancher 使用这些主机启动和管理 Kubernetes 集群。主机驱动与 [Docker Machine 驱动](https://github.com/docker/docs/blob/vnext-engine/machine/drivers/index.md)相同。创建主机模板时可以显示的主机驱动,是由主机驱动的状态定义的。只有 `active` 主机驱动将显示为创建节点模板的选项。默认情况下,Rancher 与许多现有的 Docker Machine 驱动打包在一起,但你也可以创建自定义主机驱动并添加到 Rancher。
@@ -7,66 +7,6 @@ title: Pod 安全标准 (PSS) 和 Pod 安全准入 (PSA)
PSS 定义了工作负载的安全级别。PSA 描述了 Pod 安全上下文和相关字段的要求。PSA 参考 PSS 级别来定义安全限制。
#### 安装 `helm-mapkubeapis`
1. 在打算使用 `helm-mapkubeapis` 的机器上打开你的终端并安装插件:
```shell
helm plugin install https://github.com/helm/helm-mapkubeapis
```
你将看到类似于以下的输出:
```console
Downloading and installing helm-mapkubeapis v0.4.1 ...
https://github.com/helm/helm-mapkubeapis/releases/download/v0.4.1/helm-mapkubeapis_0.4.1_darwin_amd64.tar.gz
Installed plugin: mapkubeapis
```
:::info 重要提示
确保 `helm-mapkubeapis` 插件至少为 v0.4.1,因为旧版本_不_支持资源删除。
:::
1. 验证插件是否已正确安装:
```shell
helm mapkubeapis --help
```
你将看到类似于以下的输出:
```console
Map release deprecated or removed Kubernetes APIs in-place
Usage:
mapkubeapis [flags] RELEASE
Flags:
--dry-run simulate a command
-h, --help help for mapkubeapis
--kube-context string name of the kubeconfig context to use
--kubeconfig string path to the kubeconfig file
--mapfile string path to the API mapping file
--namespace string namespace scope of the release
```
#### 清理损坏的版本
安装 `helm-mapkubeapis` 插件后,清理升级到 Kubernetes v1.25 后损坏的版本。
1. 打开你的首选终端并通过运行 `kubectl cluster-info` 确保终端已连接到所需集群。
1. 运行 `helm list --all-namespaces` 列出你在集群中安装的所有版本。
1. 通过运行 `helm mapkubeapis --dry-run <release-name> --namespace <release-namespace>` 为要清理的每个版本执行试运行。你可以通过此命令的结果了解要替换或删除哪些资源。
1. 最后,在查看更改后,使用 `helm mapkubeapis <release-name> --namespace <release-namespace>` 执行完整运行。
#### 将 Chart 升级到支持 Kubernetes v1.25 的版本
清理了具有 PSP 的所有版本后,你就可以继续升级了。对于 Rancher 维护的工作负载,请按照本文档[从 Rancher 维护的应用程序和市场工作负载中删除 PodSecurityPolicies](#remove-psp-rancher-workloads) 部分中的步骤进行操作。
如果工作负载不是由 Rancher 维护的,请参阅对应的提供商的文档。
:::caution
不要跳过此步骤。与 Kubernetes v1.25 不兼容的应用程序不能保证在清理后正常工作。
:::
## Pod 安全准入配置模板 {#psa-config-templates}
Rancher 提供了 PSA 配置模板。它们是可以应用到集群的预定义安全配置。Rancher 管理员(或具有权限的人员)可以[创建、管理和编辑](./psa-config-templates.md) PSA 模板。
@@ -1,59 +0,0 @@
---
title: 创建阿里云 ACK 集群
---
你可以使用 Rancher 创建托管在阿里云 Alibaba Cloud Kubernetes (ACK) 中的集群。Rancher 已经为 ACK 实现并打包了针对 ACK 的[集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md),但是默认情况下,这个集群驱动的状态是 `inactive`。为了启动 ACK 集群,你需要[启用 ACK 集群驱动](../../authentication-permissions-and-global-configuration/about-provisioning-drivers/manage-cluster-drivers.md#激活停用集群驱动)。启用集群驱动后,你可以开始配置 ACK 集群。
## Rancher 之外的先决条件
:::caution
部署到 ACK 会产生费用。
:::
1. 在阿里云中,在对应的控制台中激活以下服务。
- [容器服务](https://cs.console.aliyun.com)
- [资源编排服务](https://ros.console.aliyun.com)
- [RAM](https://ram.console.aliyun.com)
2. 确保你用于创建 ACK 集群的账号具有适当的权限。详见阿里云[角色授权](https://www.alibabacloud.com/help/doc-detail/86483.htm)和[使用容器服务控制台作为 RAM 用户](https://www.alibabacloud.com/help/doc-detail/86484.htm)官方文档。
3. 在阿里云中,创建[访问密钥](https://www.alibabacloud.com/help/doc-detail/53045.html)。
4. 在阿里云中,创建 [SSH 密钥对](https://www.alibabacloud.com/help/doc-detail/51793.html)。该密钥用于访问 Kubernetes 集群中的节点。
## Rancher 先决条件
你需要启用阿里云 ACK 集群驱动:
1. 点击 **☰ > 集群管理**。
1. 点击**驱动**。
1. 在**集群驱动**选项卡中,转到 **Alibaba ACK** 集群驱动并单击 **⋮ > 激活**。
集群驱动下载完成后,就可以在 Rancher 中创建阿里云 ACK 集群了。
## 创建 ACK 集群
1. 点击 **☰ > 集群管理**。
1. 在**集群**页面,点击**创建**。
1. 单击 **Alibaba ACK**。
1. 输入**集群名称**。
1. 使用**成员角色**为集群配置用户授权。点击**添加成员**添加可以访问集群的用户。使用**角色**下拉菜单为每个用户设置权限。
1. 为 ACK 集群配置**账号访问**。选择要在其中构建集群的地理区域,并输入在先决条件步骤中创建的访问密钥。
1. 点击**下一步:配置集群**,然后选择集群类型、Kubernetes 版本和可用区。
1. 如果选择 **Kubernetes** 作为集群类型,请单击**下一步:配置 master 节点**,然后填写 **master 节点**表单。
1. 单击**下一步:配置 Worker 节点**,然后填写 **Worker 节点**表单。
1. 检查并确认你的选项。然后单击**创建**。
**结果**:
你已创建集群,集群的状态是**配置中**。Rancher 已在你的集群中。
当集群状态变为 **Active** 后,你可访问集群。
**Active** 状态的集群会分配到两个项目:
- `Default`:包含 `default` 命名空间
- `System`:包含 `cattle-system`,`ingress-nginx`,`kube-public` 和 `kube-system` 命名空间。

Some files were not shown because too many files have changed in this diff Show More