|
6 | 6 | [id="microshift-config-yaml_{context}"] |
7 | 7 | = Using a YAML configuration file |
8 | 8 |
|
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}. |
12 | 10 |
|
13 | 11 | [id="microshift-yaml-default_{context}"] |
14 | 12 | == 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. |
16 | 14 |
|
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 |
18 | 23 | [source,yaml] |
19 | 24 | ---- |
20 | 25 | dns: |
@@ -44,21 +49,22 @@ debugging: |
44 | 49 | <8> Subject Alternative Names for API server certificates. |
45 | 50 | <9> Log verbosity. Valid values for this field are `Normal`, `Debug`, `Trace`, or `TraceAll`. |
46 | 51 |
|
| 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 | + |
47 | 56 | [IMPORTANT] |
48 | 57 | ==== |
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. |
50 | 59 | ==== |
51 | 60 |
|
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 |
57 | 63 | 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 | + |
59 | 65 | [IMPORTANT] |
60 | 66 | ==== |
61 | 67 | 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. |
62 | 68 | ==== |
63 | | -+ |
| 69 | + |
64 | 70 | 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