Skip to content

Commit a0b9b9c

Browse files
Merge branch 'main' into v2.9.4
2 parents b2891f2 + 72f6a48 commit a0b9b9c

File tree

226 files changed

+1149
-593
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

226 files changed

+1149
-593
lines changed

CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @btat @LucasSaintarbor @martyav @sunilarjun
1+
* @btat @LucasSaintarbor @sunilarjun

docs/api/workflows/projects.md

Lines changed: 76 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ EOF
4949

5050
Setting the `field.cattle.io/creatorId` field allows the cluster member account to see project resources with the `get` command and view the project in the Rancher UI. Cluster owner and admin accounts don't need to set this annotation to perform these tasks.
5151

52+
Setting the `field.cattle.io/creator-principal-name` annotation to the user's principal preserves it in a projectroletemplatebinding automatically created for the project owner.
53+
54+
If you don't want the creator to be added as the owner member (e.g. if the creator is a cluster administrator) to the project you may set the `field.cattle.io/no-creator-rbac` annotation to `true`, which will prevent the corresponding projectroletemplatebinding from being created.
55+
5256
### Creating a Project With a Resource Quota
5357

5458
Refer to [Kubernetes Resource Quota](https://kubernetes.io/docs/concepts/policy/resource-quotas/).
@@ -91,6 +95,77 @@ spec:
9195
limitsMemory: 100Mi
9296
requestsCpu: 50m
9397
requestsMemory: 50Mi
98+
EOF
99+
```
100+
101+
## Adding a Member to a Project
102+
103+
Look up the project ID to specify the `metadata.namespace` field and `projectName` field values.
104+
105+
```bash
106+
kubectl --namespace c-m-abcde get projects
107+
```
108+
109+
Look up the role template ID to specify the `roleTemplateName` field value (e.g. `project-member` or `project-owner`).
110+
111+
```bash
112+
kubectl get roletemplates
113+
```
114+
115+
When adding a user member specify the `userPrincipalName` field:
116+
117+
```bash
118+
kubectl create -f - <<EOF
119+
apiVersion: management.cattle.io/v3
120+
kind: ProjectRoleTemplateBinding
121+
metadata:
122+
generateName: prtb-
123+
namespace: p-vwxyz
124+
projectName: c-m-abcde:p-vwxyz
125+
roleTemplateName: project-member
126+
userPrincipalName: keycloak_user://user
127+
EOF
128+
```
129+
130+
When adding a group member specify the `groupPrincipalName` field instead:
131+
132+
```bash
133+
kubectl create -f - <<EOF
134+
apiVersion: management.cattle.io/v3
135+
kind: ProjectRoleTemplateBinding
136+
metadata:
137+
generateName: prtb-
138+
namespace: p-vwxyz
139+
projectName: c-m-abcde:p-vwxyz
140+
roleTemplateName: project-member
141+
groupPrincipalName: keycloak_group://group
142+
EOF
143+
```
144+
145+
Create a projectroletemplatebinding for each role you want to assign to the project member.
146+
147+
## Listing Project Members
148+
149+
Look up the project ID:
150+
151+
```bash
152+
kubectl --namespace c-m-abcde get projects
153+
```
154+
155+
to list projectroletemplatebindings in the project's namespace:
156+
157+
```bash
158+
kubectl --namespace p-vwxyz get projectroletemplatebindings
159+
```
160+
161+
## Deleting a Member From a Project
162+
163+
Lookup the projectroletemplatebinding IDs containing the member in the project's namespace as decribed in the [Listing Project Members](#listing-project-members) section.
164+
165+
Delete the projectroletemplatebinding from the project's namespace:
166+
167+
```bash
168+
kubectl --namespace p-vwxyz delete projectroletemplatebindings prtb-qx874 prtb-7zw7s
94169
```
95170

96171
## Creating a Namespace in a Project
@@ -132,4 +207,4 @@ Delete the project under the cluster namespace:
132207
kubectl --namespace c-m-abcde delete project p-vwxyz
133208
```
134209

135-
Note that this command doesn't delete the namespaces and resources that formerly belonged to the project.
210+
Note that this command doesn't delete the namespaces and resources that formerly belonged to the project.

docs/faq/deprecated-features.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,7 @@ Rancher will publish deprecated features as part of the [release notes](https://
1616

1717
| Patch Version | Release Date |
1818
|---------------|---------------|
19-
| [2.9.3](https://github.com/rancher/rancher/releases/tag/v2.9.3) | Oct 24, 2024 |
20-
| [2.9.2](https://github.com/rancher/rancher/releases/tag/v2.9.2) | Sep 19, 2024 |
21-
| [2.9.1](https://github.com/rancher/rancher/releases/tag/v2.9.1) | Aug 26, 2024 |
22-
| [2.9.0](https://github.com/rancher/rancher/releases/tag/v2.9.0) | Jul 31, 2024 |
19+
| [2.10.0](https://github.com/rancher/rancher/releases/tag/v2.10.0) | Nov 18, 2024 |
2320

2421
## What can I expect when a feature is marked for deprecation?
2522

docs/faq/general-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Yes. Rancher supports [Istio](../integrations-in-rancher/istio/istio.md).
2424

2525
## Will Rancher v2.x support Hashicorp's Vault for storing secrets?
2626

27-
Secrets management is on our roadmap but we haven't assigned it to a specific release yet.
27+
As of Rancher v2.9, Rancher [supports authentication with service account tokens](../how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/jwt-authentication.md), which is used by Vault and other integrations.
2828

2929
## Does Rancher v2.x support RKT containers as well?
3030

docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/air-gapped-upgrades.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ Log into Rancher to confirm that the upgrade succeeded.
9292

9393
Having network issues following upgrade?
9494

95-
See [Restoring Cluster Networking](https://github.com/rancher/rancher-docs/tree/main/archived_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md).
95+
See [Restoring Cluster Networking](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md).
9696

9797
:::
9898

docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/rollbacks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ helm rollback rancher 3 -n cattle-system
142142

143143
## Rolling Back to Rancher v2.2-v2.4+
144144

145-
To roll back to Rancher before v2.5, follow the procedure detailed here: [Restoring Backups — Kubernetes installs](https://github.com/rancher/rancher-docs/tree/main/archived_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md) Restoring a snapshot of the Rancher server cluster will revert Rancher to the version and state at the time of the snapshot.
145+
To roll back to Rancher before v2.5, follow the procedure detailed here: [Restoring Backups — Kubernetes installs](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup.md) Restoring a snapshot of the Rancher server cluster will revert Rancher to the version and state at the time of the snapshot.
146146

147147
For information on how to roll back Rancher installed with Docker, refer to [this page.](../other-installation-methods/rancher-on-a-single-node-with-docker/roll-back-docker-installed-rancher.md)
148148

@@ -154,4 +154,4 @@ Managed clusters are authoritative for their state. This means restoring the Ran
154154

155155
## Rolling Back to Rancher v2.0-v2.1
156156

157-
Rolling back to Rancher v2.0-v2.1 is no longer supported. The instructions for rolling back to these versions are preserved [here](https://github.com/rancher/rancher-docs/tree/main/archived_docs/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup/roll-back-to-v2.0-v2.1.md) and are intended to be used only in cases where upgrading to Rancher v2.2+ is not feasible.
157+
Rolling back to Rancher v2.0-v2.1 is no longer supported. The instructions for rolling back to these versions are preserved [here](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/restore-rancher-launched-kubernetes-clusters-from-backup/roll-back-to-v2.0-v2.1.md) and are intended to be used only in cases where upgrading to Rancher v2.2+ is not feasible.

docs/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The upgrade instructions assume you are using Helm 3.
3535

3636
<DeprecationHelm2 />
3737

38-
For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here](https://github.com/rancher/rancher-docs/tree/main/archived_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
38+
For migration of installs started with Helm 2, refer to the official [Helm 2 to 3 migration docs.](https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/) The [Helm 2 upgrade page here](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/helm2.md)provides a copy of the older upgrade instructions that used Helm 2, and it is intended to be used if upgrading to Helm 3 is not feasible.
3939

4040
### For air-gapped installs: Populate private registry
4141

@@ -203,7 +203,7 @@ Log into Rancher to confirm that the upgrade succeeded.
203203
204204
Having network issues following upgrade?
205205
206-
See [Restoring Cluster Networking](https://github.com/rancher/rancher-docs/tree/main/archived_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md).
206+
See [Restoring Cluster Networking](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md).
207207
208208
:::
209209

docs/getting-started/installation-and-upgrade/installation-references/feature-flags.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ The following is a list of feature flags available in Rancher. If you've upgrade
2323
- `harvester`: Manages access to the Virtualization Management page, where users can navigate directly to Harvester clusters and access the Harvester UI. See [Harvester Integration Overview](../../../integrations-in-rancher/harvester/overview.md) for more information.
2424
- `istio-virtual-service-ui`: Enables a [visual interface](../../../how-to-guides/advanced-user-guides/enable-experimental-features/istio-traffic-management-features.md) to create, read, update, and delete Istio virtual services and destination rules, which are Istio traffic management features.
2525
- `legacy`: Enables a set of features from 2.5.x and earlier, that are slowly being phased out in favor of newer implementations. These are a mix of deprecated features as well as features that will eventually be available to newer versions. This flag is disabled by default on new Rancher installations. If you're upgrading from a previous version of Rancher, this flag is enabled.
26+
- `managed-system-upgrade-controller`: Enables the installation of the system-upgrade-controller app in downstream RKE2/K3s clusters, currently limited to imported clusters and the local cluster, with plans to expand support to node-driver clusters.
2627
- `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.
2728
- `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.
2829
- `rke2`: Enables provisioning RKE2 clusters. This flag is enabled by default.
@@ -42,8 +43,9 @@ The following table shows the availability and default values for some feature f
4243
| `fleet` | `true` | GA | v2.5.0 | |
4344
| `harvester` | `true` | Experimental | v2.6.1 | |
4445
| `legacy` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | |
46+
| `managed-system-upgrade-controller` | `true` | GA | v2.10.0 | |
4547
| `rke1-custom-node-cleanup`| `true` | GA | v2.6.0 | |
4648
| `rke2` | `true` | Experimental | v2.6.0 | |
4749
| `token-hashing` | `false` for new installs, `true` for upgrades | GA | v2.6.0 | |
48-
| `uiextension` | `true` | GA | v2.9.0 |
49-
| `ui-sql-cache` | `false` | Highly experimental | v2.9.0 |
50+
| `uiextension` | `true` | GA | v2.9.0 | |
51+
| `ui-sql-cache` | `false` | Highly experimental | v2.9.0 | |

docs/getting-started/installation-and-upgrade/other-installation-methods/rancher-on-a-single-node-with-docker/upgrade-docker-installed-rancher.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@ Log into Rancher. Confirm that the upgrade succeeded by checking the version dis
380380
381381
:::note Having network issues in your user clusters following upgrade?
382382
383-
See [Restoring Cluster Networking](https://github.com/rancher/rancher-docs/tree/main/archived_docs/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md).
383+
See [Restoring Cluster Networking](https://github.com/rancher/rancher-docs/tree/main/archived_docs/en/version-2.0-2.4/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster/upgrades/namespace-migration.md).
384384
385385
:::
386386

0 commit comments

Comments
 (0)