Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update azure.md #1494

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update azure.md #1494

wants to merge 1 commit into from

Conversation

celidon
Copy link
Contributor

@celidon celidon commented Oct 1, 2024

Added note about uninitialized taint

Corrected yaml indentation as existing indentation was wrong and breaking copy/paste of configs

Fixes #[issue_number]

Reminders

  • See the README for more details on how to work with the Rancher docs.

  • Verify if changes pertain to other versions of Rancher. If they do, finalize the edits on one version of the page, then apply the edits to the other versions.

  • If the pull request is dependent on an upcoming release, remember to add a "MERGE ON RELEASE" label and set the proper milestone.

Description

Comments

Added note about uninitialized taint

Corrected yaml indentation as existing indentation was wrong and breaking copy/paste of configs
Copy link
Contributor

@btat btat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix @celidon. I added one question and suggestion.

This also needs to be ported to other versions, which I can help with if you prefer.

@@ -100,7 +100,7 @@ This section is valid only for creating clusters with the in-tree cloud provider
<details id="v2.6.0-cloud-provider-config-file">
<summary>Example Cloud Provider Config</summary>

```yaml
```yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the expected rendered output here? This block doesn't seem to have the same missing indentation as the other blocks.

The build is also failing without the existing indentation.

Comment on lines +215 to +217
:::note
When setting **Cloud Provider** to **External**, all nodes will automatically be tainted with node.cloudprovider.kubernetes.io/uninitialized=true until the Cloud Provder is installed. It is recommended to deploy the CPI as an add-on job as described below.
:::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
:::note
When setting **Cloud Provider** to **External**, all nodes will automatically be tainted with node.cloudprovider.kubernetes.io/uninitialized=true until the Cloud Provder is installed. It is recommended to deploy the CPI as an add-on job as described below.
:::
:::note
When setting **Cloud Provider** to **External**, all nodes are automatically tainted with `node.cloudprovider.kubernetes.io/uninitialized=true` until the Cloud Provider is installed. It is recommended to deploy the CPI as an add-on job as described below.
:::

Suggestion updates the text to present tense and adds indentation so the note aligns with the text of step 1.

@celidon
Copy link
Contributor Author

celidon commented Oct 21, 2024

@btat That'd be great if you can port that across all versions of the docs. I totally spaced that I need to make any edits to each version of that page and just went in to edit the one page my customer was having issues with due to invalid yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants