From 988b6d57316bf2845e06756d601630762faef83b Mon Sep 17 00:00:00 2001 From: Marty Hernandez Avedon Date: Mon, 26 Jun 2023 12:40:17 -0400 Subject: [PATCH] #600 Configuration of the Cluster agent and Fleet agent for scheduling (#670) * Fix links * Add action to apply updates in /docs to /versioned_docs/version-XYZ * 600 Configuration of the Cluster agent and Fleet agent for scheduling * Add version-2.7 docs * Update config * Update links * Remove dummy file and redirects to simulate 2.7 URLs * Apply 9f65c72d..ae741d3b to version-2.7 docs * Test increasing heap size to fix JS memory error * Fix links * rewording, note about other rules you shouldn't touch * Fix links * Sync files * Add case where versioned_docs is modified * Apply suggestions from code review Co-authored-by: Marty Hernandez Avedon * Remove manual TOC * Add 2.6.13 and 2.7.4 entries to versions table * Sync version-2.7 with PR #649 changes (broken links) * Increase memory (like c9270568) on deploy action too. * Use versioned URL for 2.7 docs link * Update test-deploy.yml (#8) * Revert "Update test-deploy.yml (#8)" (#10) This reverts commit 566ae4e4057958e9cc087ea16b5c25d7cdd6e33a. * canonicized configure-active-directory + made title consistent across versions * canonicized 2.7/configure-active-directory * canonicized configure-azure-ad + made titles consistent * canonicized 2.7/configure-azure-ad * canonicized configure-freeipa * canonicized 2.7/configure-freeipa * canonicized configure-github * canonicized 2.7/configure-github * added trailing slash to close tag * canonicized configure-keycloak-oidc * canonicized 2.7/configure-keycloak-oidc * canonicized configure-keycloak-saml * canonicized 2.7/configure-keycloak-saml * canonicized configure-okta-saml * canonicized 2.7/configure-okta-saml * canonicized configure-pingidentity * canonicized 2.7/configure-pingidentity * added trailing slash to close tag * canonicized configure-google-auth * canonicized 2.7/configure-google-auth * added trailing slash to google-oauth canonical refs * canonicized create-local-users * canonicized 2.7/create-local-users * canonicized manage-users-and-groups * canonicized 2.7/manage-users-and-groups * canonicized configure-ms-adfs-for-rancher * canonicized 2.7/configure-ms-adfs-for-rancher * canonicized configure-rancher-for-ms-adfs * canonicized 2.7/create-local users (updated) * canonicized 2.7/configure-rancher-for-ms-adfs * added trailing slash to close tag * canonicized global-permissions * canonicized locked-roles * canonicized create-pod-security-policies * canonicized custom-branding also reworded the first few sections * canonicized 2.7/custom-branding * canonicized 2.7/create-pod-security-policies * canonicized 2.7/locked-roles * canonicized 2.7/global-permissions * added trailing slash to close tag * canonicized global-default-private-registry * canonicized pod-security-standards there's no corresponding pages in versioned docs * canonicized psa-config-templates there's no corresponding pages in versioned docs * canonicized 2.7/psa-config-templates * canonicized 2.7/pod-security-standards * canonicized 2.7/global-default-private-registry * added trailing slash to close tag * Revert "Add action to apply updates in /docs to /versioned_docs/version-XYZ" * Update permissions table on create-credentials.md Update required vSphere permissions to cover vSphere versions 7.0.3+ & 8.0 * fix typo * Add Helm settings for ingress-nginx for AKS cluster running Rancher * Pin the Node version in the Docker example * Apply 2d408a82 (Update required vSphere permissions) to version-2.6 and version-2.7 * Update ZH docs * Update ZH sidebars * Fix broken links in ZH docs * Fix broken links in EN docs * update based on review suggestions * updated based on review * fixing trailing slash syntax * Apply suggestions from code review Co-authored-by: Billy Tat * [SEO] Use www in link * Update config.json * updated gitignore for ease of algolia index updating * corresponding updates to versioned pages --------- Co-authored-by: Billy Tat Co-authored-by: Frank Murphy Co-authored-by: vickyhella Co-authored-by: Max Sokolovsky --- .gitignore | 3 ++ dev-resources/algolia-search/config.json | 38 +++++++++---------- .../rke1-cluster-configuration.md | 19 +++++++++- docusaurus.config.js | 2 +- .../rke1-cluster-configuration.md | 4 ++ .../rke-clusters/options/options.md | 4 ++ .../rke1-cluster-configuration.md | 4 ++ .../rke1-cluster-configuration.md | 19 +++++++++- 8 files changed, 71 insertions(+), 22 deletions(-) diff --git a/.gitignore b/.gitignore index d64d0f4b1f5..7a424bbdf3b 100644 --- a/.gitignore +++ b/.gitignore @@ -20,3 +20,6 @@ yarn-debug.log* yarn-error.log* .idea/ + +/dev-resources/algolia-search/.env +/dev-resources/algolia-search/algolia-index.sh \ No newline at end of file diff --git a/dev-resources/algolia-search/config.json b/dev-resources/algolia-search/config.json index 6bbe7d33b7b..db628e87078 100644 --- a/dev-resources/algolia-search/config.json +++ b/dev-resources/algolia-search/config.json @@ -1,21 +1,21 @@ { - "index_name": "docs_ranchermanager_rancher_io", - "sitemap_urls": ["http://ranchermanager.docs.rancher.com/sitemap.xml"], - "start_urls": ["http://ranchermanager.docs.rancher.com/"], - "selectors": { - "lvl0": "", - "lvl1": "article h1", - "lvl2": "article h2", - "lvl3": "article h3", - "lvl4": "article h4", - "lvl5": "article h5" - }, - "custom_settings": { - "attributesForFaceting": [ - "language", - "version", - "type", - "docusaurus_tag" - ] - } + "index_name": "docs_ranchermanager_rancher_io", + "sitemap_urls": ["http://ranchermanager.docs.rancher.com/sitemap.xml"], + "start_urls": ["http://ranchermanager.docs.rancher.com/"], + "selectors": { + "lvl0": "", + "lvl1": "article h1", + "lvl2": "article h2", + "lvl3": "article h3", + "lvl4": "article h4", + "lvl5": "article h5" + }, + "custom_settings": { + "attributesForFaceting": [ + "language", + "version", + "type", + "docusaurus_tag" + ] } +} diff --git a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md index c995eea8a41..d502a2d50ca 100644 --- a/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md +++ b/docs/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md @@ -2,6 +2,10 @@ title: RKE Cluster Configuration Reference --- + + + + When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) or [RKE2](https://docs.rke2.io/) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. @@ -183,6 +187,19 @@ Clusters that were created before Kubernetes 1.16 will have an `ingress-nginx` ` If the `updateStrategy` of `ingress-nginx` is `OnDelete`, you will need to delete these pods to get the correct version for your deployment. +### Cluster Agent Configuration and Fleet Agent Configuration + +You can configure the scheduling fields and resource limits for the Cluster Agent and the cluster's Fleet Agent. You can use these fields to customize tolerations, affinity rules, and resource requirements. Additional tolerations are appended to a list of default tolerations and control plane node taints. If you define custom affinity rules, they override the global default affinity setting. Defining resource requirements sets requests or limits where there previously were none. + +:::note +With this option, it's possible to override or remove rules that are required for the functioning of the cluster. We strongly recommend against removing or overriding these and any other affinity rules, as this may cause unwanted side effects: + +- `affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution` for `cattle-cluster-agent` +- `cluster-agent-default-affinity` for `cattle-cluster-agent` +- `fleet-agent-default-affinity` for `fleet-agent` +::: + +If you downgrade Rancher to v2.7.4 or below, your changes will be lost and the agents will re-deploy without your customizations. The Fleet agent will fallback to using its built-in default values when it re-deploys. If the Fleet version doesn't change during the downgrade, the re-deploy won't be immediate. ## RKE Cluster Config File Reference @@ -343,4 +360,4 @@ There are two ways that you can specify an add-on: - [In-line Add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#in-line-add-ons) - [Referencing YAML Files for Add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#referencing-yaml-files-for-add-ons) -For an example of how to configure a custom network plug-in by editing the `cluster.yml`, refer to the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example) +For an example of how to configure a custom network plug-in by editing the `cluster.yml`, refer to the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example) \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index 10a092136e5..d9a7b0d97ec 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -96,7 +96,7 @@ module.exports = { className: 'navbar__github', }, { - href: 'https://rancher.com', + href: 'https://www.rancher.com', label: 'Rancher Home', position: 'right', }, diff --git a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md index 3fdc50d028c..2a7f56bebaa 100644 --- a/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md +++ b/versioned_docs/version-2.0-2.4/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md @@ -2,6 +2,10 @@ title: RKE Cluster Configuration Reference --- + + + + When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. diff --git a/versioned_docs/version-2.5/cluster-provisioning/rke-clusters/options/options.md b/versioned_docs/version-2.5/cluster-provisioning/rke-clusters/options/options.md index 7782a54c870..9fc981415b2 100644 --- a/versioned_docs/version-2.5/cluster-provisioning/rke-clusters/options/options.md +++ b/versioned_docs/version-2.5/cluster-provisioning/rke-clusters/options/options.md @@ -2,6 +2,10 @@ title: RKE Cluster Configuration Reference --- + + + + When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. diff --git a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md index bb399ae75e9..3e66b99e6f8 100644 --- a/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md +++ b/versioned_docs/version-2.6/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md @@ -2,6 +2,10 @@ title: RKE Cluster Configuration Reference --- + + + + When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) or [RKE2](https://docs.rke2.io/) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. diff --git a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md index c995eea8a41..d502a2d50ca 100644 --- a/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md +++ b/versioned_docs/version-2.7/reference-guides/cluster-configuration/rancher-server-configuration/rke1-cluster-configuration.md @@ -2,6 +2,10 @@ title: RKE Cluster Configuration Reference --- + + + + When Rancher installs Kubernetes, it uses [RKE](../../../pages-for-subheaders/launch-kubernetes-with-rancher.md) or [RKE2](https://docs.rke2.io/) as the Kubernetes distribution. This section covers the configuration options that are available in Rancher for a new or existing RKE Kubernetes cluster. @@ -183,6 +187,19 @@ Clusters that were created before Kubernetes 1.16 will have an `ingress-nginx` ` If the `updateStrategy` of `ingress-nginx` is `OnDelete`, you will need to delete these pods to get the correct version for your deployment. +### Cluster Agent Configuration and Fleet Agent Configuration + +You can configure the scheduling fields and resource limits for the Cluster Agent and the cluster's Fleet Agent. You can use these fields to customize tolerations, affinity rules, and resource requirements. Additional tolerations are appended to a list of default tolerations and control plane node taints. If you define custom affinity rules, they override the global default affinity setting. Defining resource requirements sets requests or limits where there previously were none. + +:::note +With this option, it's possible to override or remove rules that are required for the functioning of the cluster. We strongly recommend against removing or overriding these and any other affinity rules, as this may cause unwanted side effects: + +- `affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution` for `cattle-cluster-agent` +- `cluster-agent-default-affinity` for `cattle-cluster-agent` +- `fleet-agent-default-affinity` for `fleet-agent` +::: + +If you downgrade Rancher to v2.7.4 or below, your changes will be lost and the agents will re-deploy without your customizations. The Fleet agent will fallback to using its built-in default values when it re-deploys. If the Fleet version doesn't change during the downgrade, the re-deploy won't be immediate. ## RKE Cluster Config File Reference @@ -343,4 +360,4 @@ There are two ways that you can specify an add-on: - [In-line Add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#in-line-add-ons) - [Referencing YAML Files for Add-ons](https://rancher.com/docs/rke/latest/en/config-options/add-ons/user-defined-add-ons/#referencing-yaml-files-for-add-ons) -For an example of how to configure a custom network plug-in by editing the `cluster.yml`, refer to the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example) +For an example of how to configure a custom network plug-in by editing the `cluster.yml`, refer to the [RKE documentation.](https://rancher.com/docs/rke/latest/en/config-options/add-ons/network-plugins/custom-network-plugin-example) \ No newline at end of file