Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions _topic_maps/_topic_map_ms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,19 @@ Name: Configuring
Dir: microshift_configuring
Distros: microshift
Topics:
- Name: Using the MicroShift configuration file
- Name: About the default MicroShift configuration file
File: microshift-default-config-yaml
- Name: Customizing MicroShift by using the configuration file
File: microshift-using-config-yaml
- Name: Using configuration snippets
File: microshift-config-snippets
- Name: Configuring IPv6 networking
File: microshift-nw-ipv6-config
- Name: Using ingress control for a MicroShift cluster
File: microshift-ingress-controller
- Name: Disabling LVMS CSI provider and CSI snapshot
File: microshift-disable-lvms-csi-provider-csi-snapshot
- Name: Checking the status of Greenboot health checks
- Name: Checking the status of greenboot health checks
File: microshift-greenboot-checking-status
- Name: Cluster access with kubeconfig files
File: microshift-cluster-access-kubeconfig
Expand Down
15 changes: 15 additions & 0 deletions microshift_configuring/microshift-config-snippets.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-config-snippets"]
include::_attributes/attributes-microshift.adoc[]
= Using {microshift-short} configuration snippets
:context: microshift-config-snippets

If you want to configure one or two settings, use the `/etc/microshift/config.d/` configuration directory to drop in configuration snippet YAML files.

include::modules/microshift-how-config-snippets-work.adoc[leveloffset=+1]

include::modules/microshift-example-config-snippets-list.adoc[leveloffset=+1]

include::modules/microshift-example-config-snippets-objects.adoc[leveloffset=+1]

include::modules/microshift-example-mixed-config-snippets.adoc[leveloffset=+1]
23 changes: 23 additions & 0 deletions microshift_configuring/microshift-default-config-yaml.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-default-config-yaml"]
include::_attributes/attributes-microshift.adoc[]
= About the default {microshift-short} configuration file
:context: microshift-default-config-yaml

toc::[]

The {microshift-short} built-in default settings are listed in a YAML file.

include::modules/microshift-config-rhde-con.adoc[leveloffset=+1]

include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]

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

include::modules/microshift-default-settings.adoc[leveloffset=+2]

//[id="additional-resources_microshift-using-config-yaml_{context}"]
//[role="_additional-resources"]
//== Additional resources

//* xref:../microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
2 changes: 1 addition & 1 deletion microshift_configuring/microshift-gdp.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ include::modules/microshift-ref-generic-device-plugin-troubleshooting.adoc[level
[id="_additional-resources_microshift-gdp_{context}"]
== Additional resources

* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[The {microshift-short} YAML configuration file]
//* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
* xref:../microshift_networking/microshift-networking-settings.adoc#microshift-understanding-networking-settings[Understanding networking settings]
* xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
* xref:../microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc#microshift-network-policies[About network policies]
Expand Down
2 changes: 1 addition & 1 deletion microshift_configuring/microshift-ingress-controller.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ include::modules/microshift-ingress-controller-tls-config.adoc[leveloffset=+2]
[role="_additional-resources"]
== Additional resources

* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-snippets_microshift-configuring[Using configuration snippets]
//* xref:../microshift_configuring/microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]

* link:https://docs.redhat.com/container-platform/latest/networking/networking_operators/ingress-operator.html#nw-http2-haproxy_configuring-ingress[Enabling HTTP/2 Ingress connectivity] ({OCP} documentation)
22 changes: 6 additions & 16 deletions microshift_configuring/microshift-using-config-yaml.adoc
Original file line number Diff line number Diff line change
@@ -1,37 +1,27 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-using-config-yaml"]
include::_attributes/attributes-microshift.adoc[]
= Using the {microshift-short} configuration file
:context: microshift-configuring

:FeatureName: The Generic Device Plugin for {microshift-short}

include::snippets/technology-preview.adoc[]
= Customizing {microshift-short} by using the configuration file
:context: microshift-using-config-yaml

toc::[]

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

include::modules/microshift-config-rhde-con.adoc[leveloffset=+1]

include::snippets/microshift-greenboot-status-snip.adoc[leveloffset=+2]
Use the {microshift-short} YAML file to customize your preferences, settings, and parameters.

include::modules/microshift-config-yaml.adoc[leveloffset=+1]
:FeatureName: The Generic Device Plugin for {microshift-short}

include::modules/microshift-default-settings.adoc[leveloffset=+2]
include::snippets/technology-preview.adoc[]

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

include::modules/microshift-config-parameters-table.adoc[leveloffset=+2]

include::modules/microshift-config-snippets.adoc[leveloffset=+2]

include::modules/microshift-nw-advertise-address.adoc[leveloffset=+2]

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

[role="_additional-resources"]
[id="additional-resources_microshift-using-config-yaml_{context}"]
[role="_additional-resources"]
== Additional resources

* xref:../../microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking Greenboot status]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ include::modules/microshift-tls-default-cipher-suites.adoc[leveloffset=+2]
[role="_additional-resources"]
== Additional resources

* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-snippets_microshift-configuring[Using configuration snippets].
//* xref:../microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]

* To secure pods using security content constraints (SCC), see xref:../../microshift_running_apps/microshift-authentication.adoc#authentication-microshift[Pod security authentication and authorization].
* To secure pods using security content constraints (SCC), see xref:../../microshift_running_apps/microshift-authentication.adoc#authentication-microshift[Pod security authentication and authorization]

* xref:../../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig[Cluster access with kubeconfig].
* xref:../../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig[Cluster access with kubeconfig]

* xref:../microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities].
* xref:../microshift_auth_security/microshift-custom-ca.adoc#microshift-custom-ca[Configuring custom certificate authorities]
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ include::modules/microshift-low-latency-config-yaml.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
//TODO * workload partitioning crossref here
* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[Using a YAML configuration file]
//* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
* link:https://kubernetes.io/docs/reference/config-api/kubelet-config.v1beta1/#kubelet-config-k8s-io-v1beta1-KubeletConfiguration[KubeletConfiguration reference] (Kubernetes upstream documentation)

//RHEL TuneD
Expand Down
10 changes: 5 additions & 5 deletions microshift_install_rpm/microshift-install-rpm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ include::modules/microshift-install-rpm-preparing.adoc[leveloffset=+1]
//additional resources for install rpm prep module
[role="_additional-resources"]
.Additional resources
* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console.
* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Configuring MicroShift].
* For more options on partition configuration, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/performing_a_standard_rhel_9_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning].
* Download the link:https://console.redhat.com/openshift/install/pull-secret[pull secret] from the Red Hat Hybrid Cloud Console
//* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
* For more options on partition configuration, read link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9/html-single/performing_a_standard_rhel_9_installation/index#manual-partitioning_graphical-installation[Configuring Manual Partitioning]
* For more information about resizing your existing LVs to free up capacity in your VGs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html-single/configuring_and_managing_logical_volumes/index#managing-lvm-volume-groups_configuring-and-managing-logical-volumes[Managing LVM Volume Groups].
* For more information about creating VGs and PVs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management].
* For more information about creating VGs and PVs, read link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/configuring_and_managing_logical_volumes/overview-of-logical-volume-management_configuring-and-managing-logical-volumes[Overview of logical volume management]

include::modules/microshift-install-rpms.adoc[leveloffset=+1]

Expand All @@ -43,7 +43,7 @@ include::modules/microshift-accessing.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool].
* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool]

include::modules/microshift-accessing-cluster-locally.adoc[leveloffset=+2]

Expand Down
2 changes: 1 addition & 1 deletion microshift_networking/microshift-cni.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ include::modules/microshift-nw-topology.adoc[leveloffset=+1]
[role="_additional-resources"]
== Additional resources

* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-yaml_microshift-configuring[Using a YAML configuration file]
//* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
* xref:../microshift_networking/microshift-networking-settings.adoc#microshift-understanding-networking-settings[Understanding networking settings]
* xref:../microshift_networking/microshift_multiple_networks/microshift-cni-multus.adoc#microshift-cni-multus[About using multiple networks]
* xref:../microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc#microshift-network-policies[About network policies]
2 changes: 1 addition & 1 deletion microshift_networking/microshift-nw-router.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ include::modules/microshift-nw-router-config-ip-address.adoc[leveloffset=+2]
[role="_additional-resources"]
[id="additional-resources_microshift-understanding-and-configuring-router_{context}"]
== Additional resources
* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-yaml-default_microshift-using-config-yaml[Default settings] ({microshift-short})
* xref:../microshift_configuring/microshift-default-config-yaml.adoc#microshift-default-config-yaml[About the default {microshift-short} configuration file]

* xref:../microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc#microshift-network-policies[About network policies]

Expand Down
6 changes: 3 additions & 3 deletions microshift_support/microshift-remote-cluster-monitoring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include::modules/microshift-info-collected-telemetry.adoc[leveloffset=+1]

include::modules/microshift-opt-out-telemetry.adoc[leveloffset=+1]

[id="additional-resources_microshift-remote-cluster-monitoring_{context}"]
== Additional resources
//[id="additional-resources_microshift-remote-cluster-monitoring_{context}"]
//== Additional resources

* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-config-snippets_microshift-configuring[Using configuration snippets].
//* xref:../microshift_configuring/microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets].
2 changes: 1 addition & 1 deletion modules/microshift-config-nodeport-limits.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Consider the following when configuring the NodePort service ranges:
|etcd port

|6443
|kubernetes API
|Kubernetes API

|8445/tcp
|openshift-route-controller-manager
Expand Down
8 changes: 4 additions & 4 deletions modules/microshift-config-parameters-table.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ The following table explains {microshift-short} configuration YAML parameters an

|`auditLog.maxFileAge`
|`number`
|How long log files are kept before automatic deletion. The default value of `0` in the `maxFileAge` parameter means a log file is never deleted based on age. This value can be configured.
|How long log files are stored before automatic deletion. The default value of `0` in the `maxFileAge` parameter means a log file is never deleted based on age. You can configure this value.

|`auditLog.maxFileSize`
|`number`
|By default, when the `audit.log` file reaches the `maxFileSize` limit, the `audit.log` file is rotated and {microshift-short} begins writing to a new `audit.log` file. This value can be configured.
|By default, when the `audit.log` file reaches the `maxFileSize` limit, the `audit.log` file is rotated and {microshift-short} begins writing to a new `audit.log` file. You can configure this value.

|`auditLog.maxFiles`
|`number`
|The total number of log files kept. By default, {microshift-short} retains 10 log files. The oldest is deleted when an excess file is created. This value can be configured.
|The total number of log files kept. By default, {microshift-short} retains 10 log files. The oldest is deleted when an excess file is created. You can configure this value.

|`auditLog.profile`
|`Default`, `WriteRequestBodies`, `AllRequestBodies`, or `None`
Expand All @@ -47,7 +47,7 @@ The following table explains {microshift-short} configuration YAML parameters an

|`namedCertificates.names`
|`list`
|Optional. Add a list of explicit DNS names. Leading wildcards are allowed. If no names are provided, the implicit names are extracted from the certificates.
|Optional. Add a list of explicit DNS names. Leading wildcards are allowed. If you do not list names, the implicit names are extracted from the certificates.

|`subjectAltNames`
|Fully qualified domain names (FQDNs), wildcards such as `*.domain.com`, or IP addresses.
Expand Down
2 changes: 1 addition & 1 deletion modules/microshift-config-rhde-con.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
// Module included in the following assemblies:
//
// * microshift_configuring/microshift-config-rhde-con.adoc
// * microshift_configuring/microshift-default-config-yaml.adoc

:_mod-docs-content-type: CONCEPT
[id="microshift-config-rhde-con_{context}"]
Expand Down
Loading