[SURE-9486] Adding Tuning/Config Material #455
Conversation
…, and added tune-etcd-large-installations.md in the Reference section. Based on ref material in Jira/Rancher Manager. Signed-off-by: Sunil Singh <[email protected]>
Signed-off-by: Sunil Singh <[email protected]>
Signed-off-by: Sunil Singh <[email protected]>
docs/install/configuration.md
Outdated
| </summary> | ||
|
|
||
| ```yaml | ||
| apiVersion: provisioning.cattle.io/v1 |
There was a problem hiding this comment.
The rke2-docs scope is limited to RKE2. This API is Rancher related and thus it should be part of the rancher docs not RKE2.
docs/install/configuration.md
Outdated
| key: value | ||
| ``` | ||
|
|
||
| ### machineGlobalConfig |
There was a problem hiding this comment.
It seems to me that everything below this point is rancher specific and thus will confuse RKE2 standalone users. Can't this be part of Rancher documentation?
docs/install/configuration.md
Outdated
| ### additionalManifest | ||
|
|
||
| Specify additional manifests to deliver to the control plane nodes. | ||
|
|
||
| The value is a String, and will be placed at the path `/var/lib/rancher/rke2/server/manifests/rancher/addons.yaml` on target nodes. | ||
|
|
||
| Example: | ||
|
|
||
| ```yaml | ||
| additionalManifest: |- | ||
| apiVersion: v1 | ||
| kind: Namespace | ||
| metadata: | ||
| name: name-xxxx | ||
| ``` | ||
|
|
||
| :::note | ||
|
|
||
| If you want to customize system charts, you should use the `chartValues` field as described below. | ||
|
|
||
| Alternatives, such as using a HelmChartConfig to customize the system charts via `additionalManifest`, can cause unexpected behavior, due to having multiple HelmChartConfigs for the same chart. | ||
|
|
||
| ::: |
There was a problem hiding this comment.
I believe this is also rancher specific
|
@manuelbuil Thank you for reviewing. The changes proposed here are part of a customer ask in [SURE-9486] where they wanted to see the material present here in Rancher Manager related to RKE2 in the RKE2 docs, but I do agree with your point that the RKE2 docs scope should only be limited to RKE2. I can remove the changes in configuration.md and keep the added file for etcd tuning if that makes sense? |
There was a problem hiding this comment.
part of a customer ask where they wanted to see the material present here in Rancher Manager related to RKE2 in the RKE2 doc.
We do not do that. That portion of the customer request should be rejected.
Rancher stuff goes in rancher docs. RKE2 docs should not mention performing steps in Rancher or other Rancher-specific items. Rancher already has docs that discuss cluster config for downstream provisioned clusters; these bits should go there.
If you want to share a version of these instructions that are specific to standalone RKE2 installs - using rke2 config.yaml or a config.yaml.d drop-in instead of cluster yaml - we could accept that.
Signed-off-by: Sunil Singh <[email protected]>
Signed-off-by: Sunil Singh <[email protected]>
|
@brandond Thank you for clarifying. I've removed the configuration.md material but for the etcd tuning page can you clarify if that material is useful here as the specific commands used are below and I believe they can be added to the standalone RKE2 config.yaml: etcd-arg:
- "quota-backend-bytes=5368709120"etcd-arg:
- "data-dir=/var/lib/etcd/data"
- "wal-dir=/var/lib/etcd/wal"Any clarification appreciated, thank you. |
|
|
@brandond Many thanks for clarifying. With the actions being unsupported and future restrictions for etcd-arg I'll go ahead and close out this PR and add a warning admonition to the Rancher docs page as well. |
3 participants
Added a "Configuration Options" section in configuration.md (reference), and added tune-etcd-large-installations.md (reference) in the Reference section. Tied to [SURE-9486].