Skip to content

Commit 65fda84

Browse files
committed
OSDOCS-7998: update config yaml path and text
1 parent 822f585 commit 65fda84

File tree

2 files changed

+24
-18
lines changed

2 files changed

+24
-18
lines changed

microshift_configuring/microshift-using-config-tools.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]
1212

1313
include::modules/microshift-config-yaml.adoc[leveloffset=+1]
1414

15-
include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+1]
15+
include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+2]
1616

17-
//[id="additional-resources_microshift-using-config-tools_{context}"]
18-
//[role="_additional-resources"]
19-
//== Additional resources
17+
[id="additional-resources_microshift-using-config-tools_{context}"]
18+
[role="_additional-resources"]
19+
== Additional resources
2020

21-
//TODO:add xref to check greenboot status module after merge
21+
* xref:../../microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking Greenboot status]

modules/microshift-config-yaml.adoc

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,20 @@
66
[id="microshift-config-yaml_{context}"]
77
= Using a YAML configuration file
88

9-
{product-title} searches for a configuration file in the user-specific directory, `~/.microshift/config.yaml`, then the system-wide `/etc/microshift/config.yaml` directory. You must create the configuration file and specify any settings that should override the defaults before starting {product-title}.
10-
11-
//include admonition snippet about waiting for greenboot
9+
On start up, {product-title} searches the system-wide `/etc/microshift/` directory for a configuration file named `config.yaml`. To use custom configurations, you must create the configuration file and specify any settings that should override the defaults before starting {product-title}.
1210

1311
[id="microshift-yaml-default_{context}"]
1412
== Default settings
15-
If you do not create a `config.yaml` file, the default values are used. The following example configuration shows the default settings. You must create a custom `config.yaml` file and change any settings that should override the defaults before starting {product-title}.
13+
If you do not create a `config.yaml` file, the default values are used. The following example shows the default configuration settings.
1614

17-
.Default YAML values example
15+
* You can use the following command to see the default values:
16+
+
17+
[source,terminal]
18+
----
19+
$ microshift show-config
20+
----
21+
+
22+
.Default values example output in YAML form
1823
[source,yaml]
1924
----
2025
dns:
@@ -44,21 +49,22 @@ debugging:
4449
<8> Subject Alternative Names for API server certificates.
4550
<9> Log verbosity. Valid values for this field are `Normal`, `Debug`, `Trace`, or `TraceAll`.
4651

52+
[id="microshift-yaml-custom_{context}"]
53+
== Custom settings
54+
To create custom configurations, you must create a `config.yaml` file in the `/etc/microshift/` directory, then change any settings that should override the defaults before starting or restarting {product-title}.
55+
4756
[IMPORTANT]
4857
====
49-
Restart {product-title} after changing any configuration settings to have them take effect. {product-title} reads the configuration file only on start.
58+
Restart {product-title} after changing any configuration settings to have them take effect. The `config.yaml` file is read only when {product-title} starts.
5059
====
5160

52-
[id="microshift-yaml-custom_{context}"]
53-
== Custom settings
54-
You must change any settings that should override the defaults before starting {product-title}.
55-
56-
advertiseAddress::
61+
[id="microshift-yaml-advertiseAddress_{context}"]
62+
=== advertiseAddress
5763
The `apiserver.advertiseAddress` flag specifies the IP address on which to advertise the API server to members of the cluster. This address must be reachable by the cluster. You can set a custom IP address here, but you must also add the IP address to a host interface. Customizing this parameter preempts {product-title} from adding a default IP address to the `br-ex` network interface.
58-
+
64+
5965
[IMPORTANT]
6066
====
6167
If you customize the `advertiseAddress` IP address, make sure it is reachable by the cluster when {product-title} starts by adding the IP address to a host interface.
6268
====
63-
+
69+
6470
If unset, the default value is `10.44.0.0/32`. It will be set to the next immediate subnet after the service network. For example, when the service network is `10.43.0.0/16`, the `advertiseAddress` is set to `10.44.0.0/32`.

0 commit comments

Comments
 (0)