Skip to content

Commit 5ac32c2

Browse files
authored
Merge pull request #98256 from ShaunaDiaz/OSDOCS-15754
OSDOCS-15754: adds concept module RHDE config
2 parents cca7290 + 6d2e84b commit 5ac32c2

File tree

3 files changed

+29
-3
lines changed

3 files changed

+29
-3
lines changed

microshift_configuring/microshift-using-config-yaml.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ toc::[]
88

99
A YAML file customizes {microshift-short} instances with your preferences, settings, and parameters.
1010

11+
include::modules/microshift-config-rhde-con.adoc[leveloffset=+1]
12+
1113
include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]
1214

1315
include::modules/microshift-config-yaml.adoc[leveloffset=+1]
@@ -24,8 +26,8 @@ include::modules/microshift-nw-advertise-address.adoc[leveloffset=+2]
2426

2527
include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+2]
2628

27-
[id="additional-resources_microshift-using-config-yaml_{context}"]
2829
[role="_additional-resources"]
30+
[id="additional-resources_microshift-using-config-yaml_{context}"]
2931
== Additional resources
3032

3133
* xref:../../microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking Greenboot status]
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift_configuring/microshift-config-rhde-con.adoc
4+
5+
:_mod-docs-content-type: CONCEPT
6+
[id="microshift-config-rhde-con_{context}"]
7+
= Configuring {op-system-bundle}
8+
9+
{microshift-short} and {op-system-base-full} work together to bring a lighter-weight, single-node Kubernetes to the edge. This combination means that there is a single node that is both control-plane and worker. It also means that the operating system handles many functions. You add features by installing optional RPMs or Operators. In many cases, you must configure the operating system or other resources in addition to the {microshift-short} service.
10+
11+
Bringing many of these pieces together is the {microshift-short} configuration file, `config.yaml`. The {microshift-short} configuration file customizes your application platform and can enable many advanced functions. For example:
12+
13+
* Ingress is available by default, but you can add advanced functions such as TLS and route admission specifications by using parameters in the {microshift-short} configuration file.
14+
* If you do not need storage, you can disable the built-in storage provider by using the {microshift-short} configuration file. If you do want to use the built-in storage provider, you must make your adjustments in the `lvmd.config` file. The role of the {microshift-short} configuration file in this case is to set whether you use the default storage provider.
15+
* Advanced networking functions, such as using multiple networks. The Multus package is an installable RPM, but you set up access by using the {microshift-short} configuration file to set parameters. In addition, you must configure network settings on your networks through the host.
16+
17+
For your convenience, a `config.yaml.default` file is automatically installed. You can copy and rename this file `config.yaml` and use it as a starting point for your own custom configuration.
18+
19+
[NOTE]
20+
====
21+
You can also add features that operate without configurations to the {microshift-short} `config.yaml` file. For example, you can install and configure GitOps for application management without configuring {microshift-short}.
22+
====

modules/microshift-config-yaml.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
[id="microshift-config-yaml_{context}"]
77
= The {microshift-short} YAML configuration file
88

9-
At start up, {microshift-short} checks the system-wide `/etc/microshift/` directory for a configuration file named `config.yaml`. If the configuration file does not exist in the directory, built-in default values are used to start the service.
9+
At startup, {microshift-short} checks the system-wide `/etc/microshift/` directory for a configuration file named `config.yaml`. If the configuration file does not exist in the directory, built-in default values are used to start the service.
1010

11-
The {microshift-short} configuration file must be used in combination with host and, sometimes, application and service settings. Ensure that each item is configured in tandem when you customize your {microshift-short} cluster.
11+
You must use the {microshift-short} configuration file must be used in combination with host and, sometimes, application and service settings. Ensure that you configure each function in tandem, as needed, when you adjust settings for your {microshift-short} cluster.
12+
13+
For your convenience, a `config.yaml.default` file ready for your inputs is automatically installed.

0 commit comments

Comments
 (0)