Skip to content

Commit f4fcda3

Browse files
FrankYang0529innobead
authored andcommitted
Improve rancher-integration document
Signed-off-by: PoAn Yang <[email protected]>
1 parent c351674 commit f4fcda3

File tree

5 files changed

+30
-60
lines changed

5 files changed

+30
-60
lines changed

docs/rancher/rancher-integration.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ description: Rancher is an open source multi-cluster management platform. Harves
1717

1818
[Rancher](https://github.com/rancher/rancher) is an open-source multi-cluster management platform. Starting with Rancher v2.6.1, Rancher has integrated Harvester by default to centrally manage VMs and containers.
1919

20-
Users can import and manage multiple Harvester clusters using the Rancher [Virtualization Management](virtualization-management.md) feature. Leveraging the Rancher's [authentication](https://ranchermanager.docs.rancher.com/v2.7/pages-for-subheaders/authentication-config) feature and [RBAC control](https://ranchermanager.docs.rancher.com/v2.7/pages-for-subheaders/manage-role-based-access-control-rbac) for [multi-tenancy](virtualization-management.md#multi-tenancy) support.
20+
Users can import and manage multiple Harvester clusters using the Rancher [Virtualization Management](virtualization-management.md) feature. Leveraging the Rancher's [authentication](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/authentication-config) feature and [RBAC control](https://ranchermanager.docs.rancher.com/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac) for [multi-tenancy](virtualization-management.md#multi-tenancy) support.
2121

2222
For a comprehensive overview of the support matrix, please refer to the [Harvester & Rancher Support Matrix](https://www.suse.com/suse-harvester/support-matrix/all-supported-versions/).
2323

@@ -31,23 +31,13 @@ For the network requirements, please refer to the doc [here](../install/requirem
3131

3232
## Deploying Rancher server
3333

34-
To use Rancher with Harvester, please install Rancher on a separate server. If you want to try out the integration features, you can create a VM in Harvester and install the Rancher server by following the [Helm CLI quick start](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli).
34+
To use Rancher with Harvester, please install Rancher on a separate server. If you want to try out the integration features, you can create a VM in Harvester and install the Rancher server by following the [Helm CLI quick start](https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli).
3535

36-
For production setup, please use one of the following guides to deploy and provision Rancher and a Kubernetes cluster with the provider of your choice:
37-
38-
- [AWS](https://ranchermanager.docs.rancher.com/v2.7/pages-for-subheaders/deploy-rancher-manager) (uses Terraform)
39-
- [AWS Marketplace](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/aws-marketplace) (uses Amazon EKS)
40-
- [Azure](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/azure) (uses Terraform)
41-
- [DigitalOcean](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/digitalocean) (uses Terraform)
42-
- [GCP](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/gcp) (uses Terraform)
43-
- [Hetzner Cloud](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/hetzner-cloud) (uses Terraform)
44-
- [Vagrant](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/vagrant)
45-
- [Equinix Metal](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/equinix-metal)
46-
- [Outscale](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/outscale-qs) (uses Terraform)
36+
For production setup, please follow [Deploying Rancher Server document](https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager) to deploy and provision Rancher and a Kubernetes cluster with the provider of your choice.
4737

4838
If you prefer, the following guide will take you through the same process in individual steps. Use this if you want to run Rancher with a different provider, on prem, or if you want to see how easy it is.
4939

50-
- [Manual Install](https://ranchermanager.docs.rancher.com/v2.7/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli)
40+
- [Manual Install](https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager/helm-cli)
5141

5242
:::caution
5343

@@ -57,7 +47,7 @@ If you prefer, the following guide will take you through the same process in ind
5747

5848
## Virtualization management
5949

60-
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
50+
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
6151
Additionally, the virtualization management feature leverages Rancher's existing capabilities, such as authentication with various auth providers and multi-tenancy support.
6252

6353
For in-depth insights, please refer to the [virtualization management](./virtualization-management.md) page.
@@ -91,7 +81,7 @@ Starting with Rancher v2.7.6, Harvester introduces a new feature that enables yo
9181

9282
This guide will walk you through enabling and using this experimental feature, highlighting its capabilities and best practices.
9383

94-
To enable this new feature flag, follow these steps:
84+
To enable this new feature flag, follow these steps on Rancher UI:
9585

9686
1. Click the hamburger menu and choose the **Global Settings** tab.
9787
1. Click **Feature Flags** and locate the new feature flag `harvester-baremetal-container-workload`.
@@ -116,12 +106,6 @@ This feature lets you deploy custom container workloads directly to the bare-met
116106

117107
:::
118108

119-
:::note
120-
121-
With this feature enabled, your Harvester cluster does not appear on the **Continuous Delivery** page in the Rancher UI. Please check the issue [#4482](https://github.com/harvester/harvester/issues/4482) for further updates.
122-
123-
:::
124-
125109
## Fleet Support (Experimental)
126110

127111
_Available as of Harvester v1.3.0 + Rancher v2.7.9_
@@ -135,7 +119,7 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
135119

136120
![](/img/v1.3/rancher/continuous-delivery-overview.png)
137121

138-
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
122+
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
139123

140124
In this example, the label `location=private-dc` was added.
141125

@@ -158,12 +142,12 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
158142

159143
![](/img/v1.3/rancher/gitrepo-definition.png)
160144

161-
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
145+
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
162146

163147
In this example, the cluster group named `private-dc-clusters` is used.
164148

165-
![](/img/v1.3/rancher/gitrepo-targets.png)
149+
![](/img/v1.3/rancher/gitrepo-targets.png)
166150

167151
1. Click **Save**. It may take a few seconds for the resources to be rolled out to the target clusters.
168152

169-
![](/img/v1.3/rancher/gitrepo-synced.png)
153+
![](/img/v1.3/rancher/gitrepo-synced.png)

versioned_docs/version-v1.2/rancher/rancher-integration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If you prefer, the following guide will take you through the same process in ind
5858

5959
## Virtualization management
6060

61-
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
61+
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
6262
Additionally, the virtualization management feature leverages Rancher's existing capabilities, such as authentication with various auth providers and multi-tenancy support.
6363

6464
For in-depth insights, please refer to the [virtualization management](./virtualization-management.md) page.
@@ -86,7 +86,7 @@ Starting with Rancher v2.7.6, Harvester introduces a new feature that enables yo
8686

8787
This guide will walk you through enabling and using this experimental feature, highlighting its capabilities and best practices.
8888

89-
To enable this new feature flag, follow these steps:
89+
To enable this new feature flag, follow these steps on Rancher UI:
9090

9191
1. Click the hamburger menu and choose the **Global Settings** tab.
9292
1. Click **Feature Flags** and locate the new feature flag `harvester-baremetal-container-workload`.

versioned_docs/version-v1.3/rancher/rancher-integration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If you prefer, the following guide will take you through the same process in ind
5757

5858
## Virtualization management
5959

60-
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
60+
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
6161
Additionally, the virtualization management feature leverages Rancher's existing capabilities, such as authentication with various auth providers and multi-tenancy support.
6262

6363
For in-depth insights, please refer to the [virtualization management](./virtualization-management.md) page.
@@ -91,7 +91,7 @@ Starting with Rancher v2.7.6, Harvester introduces a new feature that enables yo
9191

9292
This guide will walk you through enabling and using this experimental feature, highlighting its capabilities and best practices.
9393

94-
To enable this new feature flag, follow these steps:
94+
To enable this new feature flag, follow these steps on Rancher UI:
9595

9696
1. Click the hamburger menu and choose the **Global Settings** tab.
9797
1. Click **Feature Flags** and locate the new feature flag `harvester-baremetal-container-workload`.
@@ -135,7 +135,7 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
135135

136136
![](/img/v1.3/rancher/continuous-delivery-overview.png)
137137

138-
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
138+
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
139139

140140
In this example, the label `location=private-dc` was added.
141141

@@ -158,12 +158,12 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
158158

159159
![](/img/v1.3/rancher/gitrepo-definition.png)
160160

161-
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
161+
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
162162

163163
In this example, the cluster group named `private-dc-clusters` is used.
164164

165-
![](/img/v1.3/rancher/gitrepo-targets.png)
165+
![](/img/v1.3/rancher/gitrepo-targets.png)
166166

167167
1. Click **Save**. It may take a few seconds for the resources to be rolled out to the target clusters.
168168

169-
![](/img/v1.3/rancher/gitrepo-synced.png)
169+
![](/img/v1.3/rancher/gitrepo-synced.png)

versioned_docs/version-v1.4/rancher/rancher-integration.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If you prefer, the following guide will take you through the same process in ind
5757

5858
## Virtualization management
5959

60-
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
60+
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
6161
Additionally, the virtualization management feature leverages Rancher's existing capabilities, such as authentication with various auth providers and multi-tenancy support.
6262

6363
For in-depth insights, please refer to the [virtualization management](./virtualization-management.md) page.
@@ -91,7 +91,7 @@ Starting with Rancher v2.7.6, Harvester introduces a new feature that enables yo
9191

9292
This guide will walk you through enabling and using this experimental feature, highlighting its capabilities and best practices.
9393

94-
To enable this new feature flag, follow these steps:
94+
To enable this new feature flag, follow these steps on Rancher UI:
9595

9696
1. Click the hamburger menu and choose the **Global Settings** tab.
9797
1. Click **Feature Flags** and locate the new feature flag `harvester-baremetal-container-workload`.
@@ -116,12 +116,6 @@ This feature lets you deploy custom container workloads directly to the bare-met
116116

117117
:::
118118

119-
:::note
120-
121-
With this feature enabled, your Harvester cluster does not appear on the **Continuous Delivery** page in the Rancher UI. Please check the issue [#4482](https://github.com/harvester/harvester/issues/4482) for further updates.
122-
123-
:::
124-
125119
## Fleet Support (Experimental)
126120

127121
_Available as of Harvester v1.3.0 + Rancher v2.7.9_
@@ -135,7 +129,7 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
135129

136130
![](/img/v1.3/rancher/continuous-delivery-overview.png)
137131

138-
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
132+
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
139133

140134
In this example, the label `location=private-dc` was added.
141135

@@ -158,12 +152,12 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
158152

159153
![](/img/v1.3/rancher/gitrepo-definition.png)
160154

161-
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
155+
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
162156

163157
In this example, the cluster group named `private-dc-clusters` is used.
164158

165-
![](/img/v1.3/rancher/gitrepo-targets.png)
159+
![](/img/v1.3/rancher/gitrepo-targets.png)
166160

167161
1. Click **Save**. It may take a few seconds for the resources to be rolled out to the target clusters.
168162

169-
![](/img/v1.3/rancher/gitrepo-synced.png)
163+
![](/img/v1.3/rancher/gitrepo-synced.png)

versioned_docs/version-v1.5/rancher/rancher-integration.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If you prefer, the following guide will take you through the same process in ind
5757

5858
## Virtualization management
5959

60-
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
60+
With Rancher's virtualization management feature, you can import and manage your Harvester cluster. By clicking one of the imported clusters, you can easily access and manage a range of Harvester cluster resources, including hosts, VMs, images, volumes, and more.
6161
Additionally, the virtualization management feature leverages Rancher's existing capabilities, such as authentication with various auth providers and multi-tenancy support.
6262

6363
For in-depth insights, please refer to the [virtualization management](./virtualization-management.md) page.
@@ -91,7 +91,7 @@ Starting with Rancher v2.7.6, Harvester introduces a new feature that enables yo
9191

9292
This guide will walk you through enabling and using this experimental feature, highlighting its capabilities and best practices.
9393

94-
To enable this new feature flag, follow these steps:
94+
To enable this new feature flag, follow these steps on Rancher UI:
9595

9696
1. Click the hamburger menu and choose the **Global Settings** tab.
9797
1. Click **Feature Flags** and locate the new feature flag `harvester-baremetal-container-workload`.
@@ -114,14 +114,6 @@ This feature lets you deploy custom container workloads directly to the bare-met
114114
- It is essential not to deploy any workloads to the system namespaces `cattle-system`, `harvester-system`, or `longhorn-system`. Keeping your workloads in separate namespaces is crucial to maintaining clarity and preserving the integrity of the system components.
115115
- For best practices, we recommend deploying container and VM workloads in separate namespaces.
116116

117-
:::
118-
119-
:::note
120-
121-
With this feature enabled, your Harvester cluster does not appear on the **Continuous Delivery** page in the Rancher UI. Please check the issue [#4482](https://github.com/harvester/harvester/issues/4482) for further updates.
122-
123-
:::
124-
125117
## Fleet Support (Experimental)
126118

127119
_Available as of Harvester v1.3.0 + Rancher v2.7.9_
@@ -135,7 +127,7 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
135127

136128
![](/img/v1.3/rancher/continuous-delivery-overview.png)
137129

138-
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
130+
1. (Optional) On the **Clusters** tab, edit the Fleet cluster config to add labels that can be used to group Harvester clusters.
139131

140132
In this example, the label `location=private-dc` was added.
141133

@@ -158,12 +150,12 @@ The Rancher feature `harvester-baremetal-container-workload` must be enabled.
158150

159151
![](/img/v1.3/rancher/gitrepo-definition.png)
160152

161-
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
153+
1. Click **Next**, and then define the Git repo targets. You can select all clusters, an individual cluster, or a group of clusters.
162154

163155
In this example, the cluster group named `private-dc-clusters` is used.
164156

165-
![](/img/v1.3/rancher/gitrepo-targets.png)
157+
![](/img/v1.3/rancher/gitrepo-targets.png)
166158

167159
1. Click **Save**. It may take a few seconds for the resources to be rolled out to the target clusters.
168160

169-
![](/img/v1.3/rancher/gitrepo-synced.png)
161+
![](/img/v1.3/rancher/gitrepo-synced.png)

0 commit comments

Comments
 (0)