Skip to content

Commit 49d3121

Browse files
authored
Merge pull request #193 from anmazzotti/clarify_embedded_cluster_api_handling
Clarify recommended way of disabling Rancher features
2 parents 178c8b5 + 54a18b2 commit 49d3121

File tree

4 files changed

+12
-13
lines changed

4 files changed

+12
-13
lines changed

docs/next/modules/en/pages/getting-started/install-rancher-turtles/using_helm.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ The Cluster API Operator is required for installing {product_name} and will be i
1212

1313
CAPI Operator allows handling the lifecycle of Cluster API Providers using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to https://cluster-api-operator.sigs.k8s.io/[Cluster API Operator book].
1414

15-
[IMPORTANT]
15+
[CAUTION]
1616
====
17-
Before <<_install_rancher_turtles_with_cluster_api_operator_as_a_helm_dependency,installing {product_name}>> in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
17+
Rancher's `embedded-cluster-api` functionality will be disabled when installing {product_name}. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
1818
19-
To simplify setting up Rancher for installing {product_name}, the official {product_name} Helm chart includes a `pre-install` hook that applies these changes, making it transparent to the end user:
19+
The recommended way to disable this feature and the Rancher-specific webhooks, is to use the official {product_name} Helm chart, that includes a `pre-install` hook to apply the following changes:
2020
2121
* Disable the `embedded-cluster-api` feature in Rancher.
2222
* Delete the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed.

docs/next/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ In case you need to review the list of prerequisites (including `cert-manager`),
1111
====
1212

1313

14-
[IMPORTANT]
14+
[CAUTION]
1515
====
16-
Before xref:./using_helm.adoc#_install_rancher_turtles_with_cluster_api_operator_as_a_helm_dependency[installing {product_name}] in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
16+
Rancher's `embedded-cluster-api` functionality will be disabled when installing {product_name}. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
1717
18-
To simplify setting up Rancher for installing {product_name}, the official {product_name} Helm chart includes a `pre-install` hook that applies these changes, making it transparent to the end user:
18+
The recommended way to disable this feature and the Rancher-specific webhooks, is to use the official {product_name} Helm chart, that includes a `pre-install` hook to apply the following changes:
1919
2020
* Disable the `embedded-cluster-api` feature in Rancher.
2121
* Delete the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed.

docs/v0.15/modules/en/pages/getting-started/install-rancher-turtles/using_helm.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ The Cluster API Operator is required for installing {product_name} and will be i
1212

1313
CAPI Operator allows handling the lifecycle of Cluster API Providers using a declarative approach, extending the capabilities of `clusterctl`. If you want to learn more about it, you can refer to https://cluster-api-operator.sigs.k8s.io/[Cluster API Operator book].
1414

15-
[IMPORTANT]
15+
[CAUTION]
1616
====
17-
Before <<_install_rancher_turtles_with_cluster_api_operator_as_a_helm_dependency,installing {product_name}>> in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
17+
Rancher's `embedded-cluster-api` functionality will be disabled when installing {product_name}. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
1818
19-
To simplify setting up Rancher for installing {product_name}, the official {product_name} Helm chart includes a `pre-install` hook that applies these changes, making it transparent to the end user:
19+
The recommended way to disable this feature and the Rancher-specific webhooks, is to use the official {product_name} Helm chart, that includes a `pre-install` hook to apply the following changes:
2020
2121
* Disable the `embedded-cluster-api` feature in Rancher.
2222
* Delete the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed.

docs/v0.15/modules/en/pages/getting-started/install-rancher-turtles/using_rancher_dashboard.adoc

+3-4
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,16 @@ In case you need to review the list of prerequisites (including `cert-manager`),
1111
====
1212

1313

14-
[IMPORTANT]
14+
[CAUTION]
1515
====
16-
Before xref:./using_helm.adoc#_install_rancher_turtles_with_cluster_api_operator_as_a_helm_dependency[installing {product_name}] in your Rancher environment, Rancher's `embedded-cluster-api` functionality must be disabled. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
16+
Rancher's `embedded-cluster-api` functionality will be disabled when installing {product_name}. This includes also cleaning up Rancher-specific webhooks that otherwise would conflict with CAPI ones.
1717
18-
To simplify setting up Rancher for installing {product_name}, the official {product_name} Helm chart includes a `pre-install` hook that applies these changes, making it transparent to the end user:
18+
The recommended way to disable this feature and the Rancher-specific webhooks, is to use the official {product_name} Helm chart, that includes a `pre-install` hook to apply the following changes:
1919
2020
* Disable the `embedded-cluster-api` feature in Rancher.
2121
* Delete the `mutating-webhook-configuration` and `validating-webhook-configuration` webhooks that are no longer needed.
2222
====
2323

24-
2524
If you would like to understand how {product_name} works and what the architecture looks like, you can refer to the xref:../../reference-guides/architecture/intro.adoc[Architecture] section.
2625

2726
[NOTE]

0 commit comments

Comments
 (0)