-
Notifications
You must be signed in to change notification settings - Fork 1.9k
TELCODOCS-2685 DITA rewrite for ibi-understanding-image-based-install.adoc #106504
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
Open
rohennes
wants to merge
1
commit into
openshift:main
Choose a base branch
from
rohennes:TELCODOCS-2685-dita-rewrite
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
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,40 @@ | ||
| // Module included in the following assemblies: | ||
| // * edge_computing/image_base_install/ibi-understanding-image-based-install.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id="ibi-image-based-deployment-overview_{context}"] | ||
| = Image-based deployment for {sno} clusters | ||
|
|
||
| [role="_abstract"] | ||
| You can use the `openshift-install` program or the IBI Operator to configure and deploy a host that you preinstalled with an image-based installation. | ||
|
|
||
| {sno-caps} cluster deployment:: | ||
|
|
||
| To configure the target host with site-specific details by using the `openshift-install` program, you must create the following resources: | ||
| + | ||
| -- | ||
| * The `install-config.yaml` installation manifest | ||
|
|
||
| * The `image-based-config.yaml` manifest | ||
| -- | ||
| + | ||
| The `openshift-install` program uses these resources to generate a configuration ISO that you attach to the preinstalled target host to complete the deployment. | ||
|
|
||
| Managed {sno} cluster deployment:: | ||
|
|
||
| {rh-rhacm-first} and the {mce} (MCE) use a hub-and-spoke architecture to manage and deploy {sno} clusters across multiple sites. Using this approach, the hub cluster serves as a central control plane that manages the spoke clusters, which are often remote {sno} clusters deployed at the far edge of the network. | ||
| + | ||
| You can define the site-specific configuration resources for an image-based deployment in the hub cluster. The IBI Operator uses these configuration resources to reconfigure the preinstalled host at the remote site and deploy the host as a managed {sno} cluster. This approach is especially beneficial for telecommunications providers and other service providers with extensive, distributed infrastructures, where an end-to-end installation at the remote site would be time-consuming and costly. | ||
| + | ||
| The following is a high-level overview of the image-based deployment process for hosts preinstalled with an imaged-based installation: | ||
| + | ||
| -- | ||
| * Define the site-specific configuration resources for the preinstalled host in the hub cluster. | ||
| * Apply these resources in the hub cluster. This initiates the deployment process. | ||
| * The IBI Operator creates a configuration ISO. | ||
| * The IBI Operator boots the target preinstalled host with the configuration ISO attached. | ||
| * The host mounts the configuration ISO and begins the reconfiguration process. | ||
| * When the reconfiguration completes, the {sno} cluster is ready. | ||
| -- | ||
| + | ||
| As the host is already preinstalled using an image-based installation, a technician can reconfigure and deploy the host in a matter of minutes. |
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,23 @@ | ||
| // Module included in the following assemblies: | ||
| // * edge_computing/image_base_install/ibi-understanding-image-based-install.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT | ||
| [id="ibi-image-based-installation-overview_{context}"] | ||
| = Image-based installation for {sno} clusters | ||
|
|
||
| [role="_abstract"] | ||
| Using the {lcao}, you can generate an OCI container image that encapsulates an instance of a {sno} cluster. | ||
|
|
||
| This image is derived from a dedicated cluster that you can configure with the target {product-title} version. | ||
|
|
||
| You can reference this image in a live installation ISO to consistently preinstall configured and validated instances of {sno} to multiple hosts. This approach enables the preparation of hosts at a central location, for example in a factory or service depot, before shipping the preinstalled hosts to a remote site for rapid reconfiguration and deployment. The instructions for preinstalling a host are the same whether you deploy the host by using only the `openshift-install` program or using the program with the IBI Operator. | ||
|
|
||
| The following is a high-level overview of the image-based installation process: | ||
|
|
||
| . Generate an image from a {sno} cluster. | ||
| . Use the `openshift-install` program to embed the seed image URL, and other installation artifacts, in a live installation ISO. | ||
| . Start the host using the live installation ISO to preinstall the host. | ||
| + | ||
| During this process, the `openshift-install` program installs {op-system-first} to the disk, pulls the image you generated, and precaches release container images to the disk. | ||
|
|
||
| . When the installation completes, the host is ready to ship to the remote site for rapid reconfiguration and deployment. |
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,24 @@ | ||
| // Module included in the following assemblies: | ||
| // * edge_computing/image_base_install/ibi-understanding-image-based-install.adoc | ||
|
|
||
| :_mod-docs-content-type: REFERENCE | ||
| [id="ibi-installation-deployment-components_{context}"] | ||
| = Image-based installation and deployment components | ||
|
|
||
| [role="_abstract"] | ||
| The following content describes the components in an image-based installation and deployment. | ||
|
|
||
| Seed image:: OCI container image generated from a dedicated cluster with the target {product-title} version. | ||
|
|
||
| Seed cluster:: Dedicated {sno} cluster that you use to create a seed image and is deployed with the target {product-title} version. | ||
|
|
||
| {lcao}:: Generates the seed image. | ||
|
|
||
| Image Based Install (IBI) Operator:: When you deploy managed clusters, the IBI Operator creates a configuration ISO from the site-specific resources you define in the hub cluster, and attaches the configuration ISO to the preinstalled host by using a bare-metal provisioning service. | ||
|
|
||
| `openshift-install` program:: Creates the installation and configuration ISO, and embeds the seed image URL in the live installation ISO. If the IBI Operator is not used, you must manually attach the configuration ISO to a preinstalled host to complete the deployment. | ||
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
|
|
||
| * xref:../../edge_computing/image_base_install/ibi_deploying_sno_clusters/ibi-edge-image-based-install-standalone.adoc#create-standalone-config-iso_ibi-edge-image-based-install[Deploying a {sno} cluster using the `openshift-install` program] | ||
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
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.
🤖 [error] OpenShiftAsciiDoc.NoXrefInModules: Do not include xrefs in modules, only assemblies (exception: release notes modules).