Skip to content

Commit f633de4

Browse files
Merge pull request #29342 from bgilbert/fixes
Fix Ignition doc links, spec versions, some wording
2 parents 4e2ed7a + 18e6c75 commit f633de4

10 files changed

+13
-13
lines changed

modules/create-a-kubeletconfig-crd-to-edit-kubelet-parameters.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
[id="create-a-kubeletconfig-crd-to-edit-kubelet-parameters_{context}"]
88
= Creating a `KubeletConfig` CRD to edit kubelet parameters
99

10-
The kubelet configuration is currently serialized as an ignition configuration, so it can be directly edited. However, there is also a new
10+
The kubelet configuration is currently serialized as an Ignition configuration, so it can be directly edited. However, there is also a new
1111
`kubelet-config-controller` added to the Machine Config Controller (MCC). This allows you to create a `KubeletConfig` custom resource (CR) to edit the kubelet parameters.
1212

1313
.Procedure

modules/ignition-config-viewing.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ config from the bootstrap machine:
7171
Here are a few things you can learn from the `bootstrap.ign` file: +
7272

7373
* Format: The format of the file is defined in the
74-
https://github.com/coreos/ignition/tree/spec2x[Ignition config spec].
74+
https://coreos.github.io/ignition/configuration-v3_2/[Ignition config spec].
7575
Files of the same format are used later by the MCO to merge changes into a
7676
machine’s configuration.
7777
* Contents: Because the bootstrap machine serves the Ignition configs for other

modules/installation-azure-user-infra-uploading-rhcos.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
// * installing/installing_gcp/installing-azure-user-infra.adoc
44

55
[id="installation-azure-user-infra-uploading-rhcos_{context}"]
6-
= Uploading the {op-system} cluster image and bootstrap ignition config file
6+
= Uploading the {op-system} cluster image and bootstrap Ignition config file
77

88
The Azure client does not support deployments based on files existing locally;
99
therefore, you must copy and store the {op-system} virtual hard disk (VHD)
10-
cluster image and bootstrap ignition config file in a storage container so they
10+
cluster image and bootstrap Ignition config file in a storage container so they
1111
are accessible during deployment.
1212

1313
.Prerequisites

modules/installation-osp-converting-ignition-resources.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Edit the file and upload it. Then, create a secondary bootstrap Ignition configu
1515
* You have the bootstrap Ignition file that the installer program generates, `bootstrap.ign`.
1616
* The infrastructure ID from the installer's metadata file is set as an environment variable (`$INFRA_ID`).
1717
** If the variable is not set, see *Creating the Kubernetes manifest and Ignition config files*.
18-
* You have an HTTP(S)-accessible way to store the bootstrap ignition file.
18+
* You have an HTTP(S)-accessible way to store the bootstrap Ignition file.
1919
** The documented procedure uses the {rh-openstack} image service (Glance), but you can also use the {rh-openstack} storage service (Swift), Amazon S3, an internal HTTP server, or an ad hoc Nova server.
2020

2121
.Procedure

modules/installation-rhv-about-inventory-yml.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@ You can override the value a virtual machine inherits from its profile. To do th
170170

171171
.Metadata variables
172172

173-
For virtual machines, `metadata.infraID` prepends the name of the virtual machine with the infrastructure ID from the `metadata.json` file you create when you build the ignition files.
173+
For virtual machines, `metadata.infraID` prepends the name of the virtual machine with the infrastructure ID from the `metadata.json` file you create when you build the Ignition files.
174174

175175
The playbooks use the following code to read `infraID` from the specific file located in the `ocp.assets_dir`.
176176

modules/installation-rhv-building-ignition-files.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
// * installing/installing_rhv/installing-rhv-user-infra.adoc
44

55
[id="installation-rhv-building-ignition-files_{context}"]
6-
= Building the ignition files
6+
= Building the Ignition files
77

88
To build the Ignition files from the manifest files you just generated and modified, you run the installation program. This action creates a {op-system-first} machine, `initramfs`, which fetches the Ignition files and performs the configurations needed to create a node.
99

modules/investigating-master-node-installation-issues.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ curl -I http://<http_server_fqdn>:<port>/master.ign <1>
3636
----
3737
<1> The `-I` option returns the header only. If the Ignition file is available on the specified URL, the command returns `200 OK` status. If it is not available, the command returns `404 file not found`.
3838
+
39-
.. To verify that the ignition file was received by the master node, query the HTTP server logs on the serving host. For example, if you are using an Apache web server to serve Ignition files:
39+
.. To verify that the Ignition file was received by the master node, query the HTTP server logs on the serving host. For example, if you are using an Apache web server to serve Ignition files:
4040
+
4141
[source,terminal]
4242
----

modules/investigating-worker-node-installation-issues.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ $ curl -I http://<http_server_fqdn>:<port>/worker.ign <1>
3636
----
3737
<1> The `-I` option returns the header only. If the Ignition file is available on the specified URL, the command returns `200 OK` status. If it is not available, the command returns `404 file not found`.
3838
+
39-
.. To verify that the ignition file was received by the worker node, query the HTTP server logs on the HTTP host. For example, if you are using an Apache web server to serve Ignition files:
39+
.. To verify that the Ignition file was received by the worker node, query the HTTP server logs on the HTTP host. For example, if you are using an Apache web server to serve Ignition files:
4040
+
4141
[source,terminal]
4242
----

modules/machine-config-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ a machine config that is injected directly into the {product-title} installer pr
2121

2222
* MCO is only supported for writing to files in `/etc` and `/var` directories, although there are symbolic links to some directories that can be writeable by being symbolically linked to one of those areas. The `/opt` directory is an example.
2323

24-
* Ignition is the configuration format used in MachineConfigs. See the link:https://github.com/coreos/ignition/blob/master/docs/configuration-v3_1.md[Ignition Configuration Specification v3.1.0] for details.
24+
* Ignition is the configuration format used in MachineConfigs. See the link:https://coreos.github.io/ignition/configuration-v3_2/[Ignition Configuration Specification v3.2.0] for details.
2525

2626
* Although Ignition config settings can be delivered directly at {product-title} installation time, and are formatted in the same way that MCO delivers Ignition configs, MCO has no way of seeing what those original Ignition configs are. Therefore, you should wrap Ignition config settings into a machine config before deploying them.
2727

@@ -30,12 +30,12 @@ offending file, however, and should continue to operate in a `degraded` state.
3030

3131
* A key reason for using a machine config is that it will be applied when you spin up new nodes for a pool in your {product-title} cluster. The `machine-api-operator` provisions a new machine and MCO configures it.
3232

33-
MCO uses link:https://github.com/coreos/ignition[CoreOS Ignition] as the configuration format {product-title} 4.6 moved from Ignition version 2 to Ignition version 3 format.
33+
MCO uses link:https://coreos.github.io/ignition/[Ignition] as the configuration format. {product-title} 4.6 moved from Ignition config specification version 2 to version 3.
3434

3535
== What can you change with machine configs?
3636
The kinds of components that MCO can change include:
3737

38-
* **config**: Create ignition config objects (see the link:https://github.com/coreos/ignition/blob/master/docs/configuration-v3_1.md[Ignition configuration specification]) to do things like modify files, systemd services, and other features on {product-title} machines, including:
38+
* **config**: Create Ignition config objects (see the link:https://coreos.github.io/ignition/configuration-v3_2/[Ignition configuration specification]) to do things like modify files, systemd services, and other features on {product-title} machines, including:
3939
- **Configuration files**: Create or overwrite files in the `/var` or `/etc` directory.
4040
- **systemd units**: Create and set the status of a systemd service or add to an existing systemd service by dropping in additional settings.
4141
- **users and groups**: Change ssh keys in the passwd section post-installation.

post_installation_configuration/machine-configuration-tasks.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Tasks in this section let you create `MachineConfig` objects to modify files, sy
2424
content related to link:https://access.redhat.com/solutions/5307301[changing MTU network settings], link:https://access.redhat.com/solutions/5096731[adding] or
2525
link:https://access.redhat.com/solutions/4510281[updating] SSH authorized keys, link:https://access.redhat.com/solutions/4518671[replacing DNS nameservers], link:https://access.redhat.com/verify-images-ocp4[verifying image signatures], link:https://access.redhat.com/solutions/4727321[enabling SCTP], and link:https://access.redhat.com/solutions/5170251[configuring iSCSI initiatornames] for {product-title}.
2626

27-
{product-title} version 4.7 supports link:https://github.com/coreos/ignition/blob/master/docs/configuration-v3_1.md[Ignition specification version 3.1]. All new machine configs you create going forward should be based on Ignition specification version 3.1. If you are upgrading your {product-title} cluster, any existing Ignition specification version 2.x machine configs will be translated automatically to specification version 3.1.
27+
{product-title} version 4.7 supports link:https://coreos.github.io/ignition/configuration-v3_2/[Ignition specification version 3.2]. All new machine configs you create going forward should be based on Ignition specification version 3.2. If you are upgrading your {product-title} cluster, any existing Ignition specification version 2.x machine configs will be translated automatically to specification version 3.2.
2828

2929
include::modules/installation-special-config-crony.adoc[leveloffset=+2]
3030
include::modules/nodes-nodes-kernel-arguments.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)