-
Notifications
You must be signed in to change notification settings - Fork 55
fix (platform): update configure section #1499
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
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for vcluster-docs-site ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This comment was marked as duplicate.
This comment was marked as duplicate.
|
Claude finished @guowenatk's task in 2m 5s —— View job PR Review SummaryRemaining Issues to FixAfter reviewing the latest commit (4425903), most of the previously identified issues have been addressed. However, a few items still need attention:
What's Been Fixed Since Last Review
What's Good
I've added inline comments with specific suggestions for each remaining issue. |
|
Claude finished @guowenatk's task in 1m 14s —— View job PR Review Summary
Remaining Issues to FixAfter reviewing the latest commit (0e0988d), the critical issues from previous reviews have been addressed. However, a few minor items still need attention:
What's Been Fixed Since Last Review
What's Good
I've added inline comments with specific suggestions for each remaining issue. |
| 1. Navigate to `Admin > Config` in the platform. | ||
| 2. Adjust your configuration as shown in the example below. | ||
| 1. Use the following YAML configuration to update your platform config (the `config` section of the [`values.yaml`](../../../configure/introduction.mdx)) or through vCluster Platform UI **Admin > Config**: | ||
| 3. Obtain the necessary values from your SAML identity provider (IdP) for the required fields. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
List numbering issue: Step numbers jump from 1 to 3, skipping step 2.
| 3. Obtain the necessary values from your SAML identity provider (IdP) for the required fields. | |
| 2. Obtain the necessary values from your SAML identity provider (IdP) for the required fields. |
|
|
||
| The `agentValues` behavior is as follows: | ||
| - By default, `agentValues` is an empty object `{}`. | ||
| - An empty `agentValues` list means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Terminology: {} is an empty object in YAML/JSON, not an empty list. An empty list would be [].
| - An empty `agentValues` list means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster. | |
| - An empty `agentValues` object means that agents installed on connected host clusters will inherit the same configuration as the platform running on the primary host cluster. |
|
|
||
| If your kubectl context is not set to the cluster with running platform, it's | ||
| possible to login to the platform using the CLI and access key. | ||
| If you haven't already, you need to [create access key](/docs/platform/api/authentication#create-an-access-key) to be able to login to the platform. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link format: Per the style guide, links should use relative file paths with .mdx extension rather than absolute URL paths.
| If you haven't already, you need to [create access key](/docs/platform/api/authentication#create-an-access-key) to be able to login to the platform. | |
| If you haven't already, you need to [create access key](../../api/authentication.mdx#create-an-access-key) to be able to login to the platform. |
| - The primary host cluster runs the vCluster Platform. | ||
| - Other host clusters connect to the primary host cluster and run the vCluster Platform Agent. | ||
| - The Platform coordinates and manages all connected host clusters through their agents. | ||
| - There are both vCluster Platform and vCluster Platform agent running on the primary host cluster . The vCluster Platform manages the primary host cluster through its vCluster Platform Agent as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra space: There's an extra space before the period.
| - There are both vCluster Platform and vCluster Platform agent running on the primary host cluster . The vCluster Platform manages the primary host cluster through its vCluster Platform Agent as well. | |
| - There are both vCluster Platform and vCluster Platform agent running on the primary host cluster. The vCluster Platform manages the primary host cluster through its vCluster Platform Agent as well. |
Content Description
Update vcluster platform configure section structure
Preview Link
https://deploy-preview-1499--vcluster-docs-site.netlify.app/docs/platform/next/configure/introduction
Internal Reference
Closes DOC-1107
@netlify /docs
Note
Restructures the platform configure section by splitting the monolithic config.mdx into organized subsections.
introduction.mdxexplaining values.yaml configuration typesinstallation-options/overview.mdxfor installation modesplatform-configs/overview.mdxfor platform configuration referenceagent-settings/directory with overview, security-context, customization, agent-upgrade, and troubleshooting pagesconfig.mdx(content redistributed to new files)high-availability.mdx(content consolidated elsewhere)single-sign-on/directory (consolidated intoplatform-configs/single-sign-on.mdx)impersonate.mdx,agent-config.mdx,preserve-license.mdxGenerated by Claude for commit 4425903. Updates automatically on new commits.