-
Notifications
You must be signed in to change notification settings - Fork 9
refactor: reorganize install documentation structure #719
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
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| weight: 40 | ||
| weight: 60 | ||
| --- | ||
|
|
||
| # Global Cluster Disaster Recovery | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| --- | ||
| weight: 50 | ||
| --- | ||
|
|
||
| # Next Steps | ||
|
|
||
| After <Term name="productShort" /> Core validation succeeds, complete the following post-install tasks according to your scenario. | ||
|
|
||
| | Priority | Task | When to use | Continue with | | ||
| | --- | --- | --- | --- | | ||
| | Recommended immediately | Install the Product Docs plugin. | Install this plugin so in-console help links can open product documentation. | [Install Product Docs Plugin](#install_product_docs_plugin) | | ||
| | Conditional | Configure Global Cluster Disaster Recovery. | Use this path when your environment requires primary and standby `global` clusters. | [Global Cluster Disaster Recovery](./global_dr.mdx) | | ||
| | Conditional | Create workload clusters or connect existing clusters. | Use this path when your architecture requires workload clusters separate from the `global` cluster. | [Clusters](../configure/clusters/index.mdx) | | ||
| | Conditional | Upload and install Extensions Packages. | Use this path when you need additional platform capabilities after <Term name="productShort" /> Core is installed. | [Extend](../extend/index.mdx) | | ||
| | Recommended before broad user onboarding | Configure identity providers, users, roles, projects, and project membership. | Use this path before onboarding administrators, project users, or application teams. | [Users and Roles](../security/users_and_roles/index.mdx) and [Projects](../security/project/index.mdx) | | ||
| | Recommended before application workloads | Prepare storage, networking, registry access, and workload prerequisites. | Use this path before application teams deploy workloads. | [Storage](../configure/storage/index.mdx), [Networking](../configure/networking/index.mdx), [Registry](../developer/registry/index.mdx), and [Clusters](../configure/clusters/index.mdx) | | ||
| | Recommended before production operation | Review backup, upgrade, monitoring, and operational documentation. | Use this path before operating the platform for production workloads. | [Backup](../configure/backup/index.mdx), [Upgrade](../upgrade/index.mdx), and [Observability](../observability/index.mdx) | | ||
|
|
||
| These tasks do not all apply to every installation. Follow the paths that match your deployment architecture and operational requirements. | ||
|
|
||
| ## Install Product Docs Plugin \{#install_product_docs_plugin} | ||
|
|
||
| The **<Term name="product" /> Product Docs** plugin provides access to product documentation within the platform. All help links throughout the platform direct users to this documentation. If this plugin is not installed, clicking help links in the platform results in 404 access errors. | ||
|
|
||
| <Steps> | ||
| ### Open Cluster Plugins | ||
|
|
||
| Navigate to **Administrator**. In the left sidebar, click **Marketplace** > **Cluster Plugins** and select the `global` cluster. | ||
|
|
||
| ### Install the Plugin | ||
|
|
||
| Locate the **<Term name="product" /> Product Docs** plugin and click **Install**. | ||
| </Steps> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| weight: 15 | ||
| --- | ||
|
|
||
| # Plan | ||
|
|
||
| Before you start the installer, choose the deployment architecture and confirm the installation settings that affect later operations. | ||
|
|
||
| <Directive type="info" title="INFO"> | ||
| <Term name="productShort" /> Core installation deploys the `global` cluster on prepared nodes. It does not support direct installation of the `global` cluster into an existing Kubernetes environment. | ||
| </Directive> | ||
|
|
||
| ## Choose a Deployment Architecture | ||
|
|
||
| Choose the architecture that matches your business scenario, management model, workload placement, resource planning, and isolation requirements. | ||
|
|
||
| | Architecture | Use when | Planning notes | | ||
| | --- | --- | --- | | ||
| | Multi-Cluster | You need one `global` cluster to manage multiple workload clusters. | Avoid running non-platform workloads on the `global` cluster. Plan resources for the expected number of managed workload clusters. | | ||
| | Single Cluster | You intentionally use one cluster for platform components and application workloads. | Single Cluster supports production use when it fits the business scenario. Because the `global` cluster also runs application workloads, plan resources and platform/workload isolation before installation. | | ||
| | Single Node | You need a test or proof-of-concept environment. | Do not use Single Node for production. | | ||
|
|
||
| For resource requirements and sizing guidance, see [Prerequisites](./prepare/prerequisites.mdx). | ||
|
|
||
| ## Confirm Install-Time Decisions | ||
|
|
||
| Confirm the following decisions before running the installer: | ||
|
|
||
| | Decision | What to confirm | Continue with | | ||
| | --- | --- | --- | | ||
| | Package architecture | Choose an x86, ARM, or hybrid Core Package. | [Download](./prepare/download.mdx) | | ||
| | Cluster network protocol | Choose IPv4, IPv6, or dual stack before starting the installer. | [Installing](./installing.mdx#start_installer) | | ||
| | Cluster Endpoint and Platform Access Address | Prepare the access addresses that cluster components, administrators, and users will use. | [Prerequisites](./prepare/prerequisites.mdx#network-resources) and [Parameter Description](./installing.mdx#parameters) | | ||
| | Load balancing | Decide whether to use an external load balancer or Self-built VIP. | [Prerequisites](./prepare/prerequisites.mdx#network-resources) and [LoadBalancer Forwarding Rules](./prepare/prerequisites.mdx#port-forward) | | ||
| | Certificates | Decide whether to use installer-generated self-signed certificates or trusted certificates that you provide. | [Prerequisites](./prepare/prerequisites.mdx#network-resources) and [Parameter Description](./installing.mdx#parameters) | | ||
| | Image repository | Decide whether to use the platform deployment image repository or an external image repository. | [Parameter Description](./installing.mdx#parameters) | | ||
| | Nodes | Confirm node names, node roles, and whether platform node isolation is required. | [Node Preprocessing](./prepare/node_preprocessing.mdx) and [Parameter Description](./installing.mdx#parameters) | | ||
| | Global Cluster Disaster Recovery | Decide whether your environment requires primary and standby `global` clusters. | [Global Cluster Disaster Recovery](./global_dr.mdx) | | ||
|
|
||
| If you plan to use Global Cluster Disaster Recovery, read [Global Cluster Disaster Recovery](./global_dr.mdx) before installing <Term name="productShort" /> Core. Disaster recovery planning affects domain names, VIPs, certificates, load balancer rules, image registry choices, package architecture, and installation parameter consistency. | ||
|
|
||
| ## Read Before You Install | ||
|
|
||
| Use the following pages as the source of truth before running the installer: | ||
|
|
||
| - [Prerequisites](./prepare/prerequisites.mdx): Prepare resource, network, and storage requirements. | ||
| - [Disk Configuration Requirements](../configure/scalability/disk_configuration.mdx): Confirm disk capacity and performance requirements. | ||
| - [Node Preprocessing](./prepare/node_preprocessing.mdx): Check and prepare each node before installation. | ||
| - [Download](./prepare/download.mdx): Download the Core Package and select the package architecture. | ||
| - [Global Cluster Disaster Recovery](./global_dr.mdx): Plan primary and standby `global` clusters if disaster recovery is required. | ||
| - [Installing](./installing.mdx): Upload the Core Package, start the installer, and configure parameters. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Global Cluster Disaster Recovery should not be presented as a normal post-install next step. DR planning affects pre-install decisions such as domain names, VIPs, certificates, LoadBalancer rules, image registry choices, package architecture, and Primary/Standby installation parameter consistency. This PR already states in
planning.mdxthat users should read the DR guide before installing Core, so listing “Configure Global Cluster Disaster Recovery” here after Core validation can mislead users into planning DR too late. Please remove this row from Next Steps, or reword it to cover only post-install DR verification/drill actions for environments where DR was already planned before installation.