Skip to content

TELCODOCS-2687 DITA rewrite for ibi-edge-image-based-install-standalone.adoc #106508

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.

Sign up for GitHub

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
base: main
Choose a base branch
from
+13 −15
Open

TELCODOCS-2687 DITA rewrite for ibi-edge-image-based-install-standalone.adoc #106508

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions modules/ibi-create-standalone-config-iso.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="create-standalone-config-iso_{context}"]
= Deploying a {sno} cluster using the openshift-install program

[role="_abstract"]
You can use the `openshift-install` program to configure and deploy a host that you preinstalled with an image-based installation. To configure the target host with site-specific details, you must create the following resources:

* The `install-config.yaml` installation manifest
Expand All @@ -30,16 +31,16 @@ For more information about the specifications for the `image-based-config.yaml`
+
[source,terminal]
----
$ mkdir ibi-config-iso-workdir <1>
$ mkdir <working_directory>
----
<1> Replace `ibi-config-iso-workdir` with the name of your working directory.
+
where `<working_directory>` is the name of your working directory, for example `ibi-config-iso-workdir`.

. Create the installation manifest:

.. Create a YAML file that defines the `install-config` manifest:
.. Create a YAML file that defines the `install-config` manifest, as in the following example:
+
--
.Example `install-config.yaml` file
[source,yaml]
----
apiVersion: v1
Expand All @@ -57,7 +58,7 @@ controlPlane:
name: master
replicas: 1
networking:
machineNetwork: <1>
machineNetwork:
- cidr: 192.168.200.0/24
#- cidr: fd01::/64
platform:
Expand All @@ -67,7 +68,8 @@ cpuPartitioningMode: "AllNodes"
pullSecret: '{"auths":{"<your_pull_secret>"}}}'
sshKey: 'ssh-rsa <your_ssh_pub_key>'
----
<1> For dual-stack networking, you can specify both IPv4 and IPv6 CIDRs using a list format. The first CIDR in the list is the primary address family and must match the primary address family of the seed cluster.
+
For dual-stack networking, you can specify both IPv4 and IPv6 CIDRs using a list format in the `machineNetwork` field. The first CIDR in the list is the primary address family and must match the primary address family of the seed cluster.

[IMPORTANT]
====
Expand Down
13 changes: 4 additions & 9 deletions modules/ibi-extra-manifests-standalone.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,17 @@
[id="ibi-extra-manifest-standalone_{context}"]
= Configuring resources for extra manifests

[role="_abstract"]
You can optionally define additional resources in an image-based deployment for {sno} clusters.

Create the additional resources in an `extra-manifests` folder in the same working directory that has the `install-config.yaml` and `image-based-config.yaml` manifests.

[NOTE]
====
Filenames for additional resources in the `extra-manifests` directory must not exceed 30 characters. Longer filenames might cause deployment failures.
Filenames for additional resources in the `extra-manifests` directory must not exceed 30 characters. Longer filenames might cause deployment failures.
====

== Creating a resource in the extra-manifests folder

You can create a resource in the `extra-manifests` folder of your working directory to add extra manifests to the image-based deployment for {sno} clusters.

The following example adds an single-root I/O virtualization (SR-IOV) network to the deployment.
The following example shows how to create a resource in the `extra-manifests` folder of your working directory to add an single-root I/O virtualization (SR-IOV) network to the deployment.

[NOTE]
====
Expand All @@ -41,9 +38,7 @@ $ mkdir extra-manifests

. Create the `SriovNetworkNodePolicy` and `SriovNetwork` resources in the `extra-manifests` folder:

.. Create a YAML file that defines the resources:
+
.Example `sriov-extra-manifest.yaml` file
.. Create a YAML file that defines the resources, as in the following example:
+
[source,yaml]
----
Expand Down
1 change: 1 addition & 0 deletions modules/ibi-installer-configuration-config.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
[id="ibi-installer-configuration-config_{context}"]
= Reference specifications for the image-based-config.yaml manifest

[role="_abstract"]
The following content describes the specifications for the `image-based-config.yaml` manifest.

The `openshift-install` program uses the `image-based-config.yaml` manifest to create a site-specific configuration ISO for image-based deployments of {sno}.
Expand Down