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
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map_ms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Topics:
File: microshift-config-snippets
- Name: Configuring IPv6 networking
File: microshift-nw-ipv6-config
- Name: Using ingress control for a MicroShift cluster
- Name: Using ingress control for a MicroShift node
File: microshift-ingress-controller
- Name: Disabling LVMS CSI provider and CSI snapshot
File: microshift-disable-lvms-csi-provider-csi-snapshot
Expand Down
2 changes: 1 addition & 1 deletion microshift_cli_ref/microshift-cli-tools-introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,5 @@ Commands for multi-node deployments, projects, and developer tools are not suppo
[role="_additional-resources"]
== Additional resources

* xref:..//microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI]
* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}/html/cli_tools/openshift-cli-oc#cli-about-cli_cli-developer-commands[About the OpenShift CLI] ({OCP} documentation)
5 changes: 2 additions & 3 deletions microshift_cli_ref/microshift-cli-using-oc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The optional {oc-first} tool provides a subset of `oc` commands for {microshift-
include::modules/microshift-cli-oc-about.adoc[leveloffset=+1]

[id="cli-using-cli_{context}"]
== Using oc with a {microshift-short} cluster
== Using oc with a {microshift-short} node

Review the following sections to learn how to complete common tasks in {microshift-short} using the `oc` CLI.

Expand Down Expand Up @@ -59,8 +59,7 @@ $ oc logs cakephp-ex-1-deploy
[id="listing-supported-apis_{context}"]
=== Listing supported API resources

Use the `oc api-resources` command to view the list of supported API resources
on the server.
Use the `oc api-resources` command to view the list of supported API resources on the server.

[source,terminal]
----
Expand Down
2 changes: 1 addition & 1 deletion microshift_configuring/microshift-config-snippets.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-config-snippets"]
= Using configuration snippets
include::_attributes/attributes-microshift.adoc[]
= Using {microshift-short} configuration snippets
:context: microshift-config-snippets

toc::[]
Expand Down
6 changes: 0 additions & 6 deletions microshift_configuring/microshift-default-config-yaml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,3 @@ 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]
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ To deploy applications or make other changes through the {microshift-short} API

The `greenboot-healthcheck` service runs one time and then exits. After greenboot has exited and the system is in a healthy state, you can proceed with configuration changes and deployments.

include::modules/microshift-greenboot-check-status.adoc[leveloffset=+1]
include::modules/microshift-greenboot-check-status.adoc[leveloffset=+1]
4 changes: 2 additions & 2 deletions microshift_configuring/microshift-ingress-controller.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-ingress-controller"]
= Using ingress control for a {microshift-short} cluster
= Using ingress control for a {microshift-short} node
include::_attributes/attributes-microshift.adoc[]
:context: microshift-ingress-controller

toc::[]

Use the ingress controller options in the {microshift-short} configuration file to make pods and services accessible outside the cluster.
Use the ingress controller options in the {microshift-short} configuration file to make pods and services accessible outside the node.

include::modules/microshift-ingress-controller-conc.adoc[leveloffset=+1]

Expand Down
8 changes: 4 additions & 4 deletions microshift_configuring/microshift-using-config-yaml.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
:_mod-docs-content-type: ASSEMBLY
[id="microshift-using-config-yaml"]
= Customizing MicroShift by using the configuration file
include::_attributes/attributes-microshift.adoc[]
= Customizing {microshift-short} by using the configuration file
:context: microshift-using-config-yaml

toc::[]
Expand All @@ -16,10 +16,10 @@ include::modules/microshift-nw-advertise-address.adoc[leveloffset=+2]

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

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

* xref:../../microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking Greenboot status]
* xref:../../microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking greenboot status]

* xref:../microshift_configuring/microshift-ingress-controller.adoc#microshift-ingress-controller[Using ingress control for a {microshift-short} cluster]
* xref:../microshift_configuring/microshift-ingress-controller.adoc#microshift-ingress-controller[Using ingress control for a {microshift-short} node]
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ include::modules/microshift-tls-default-cipher-suites.adoc[leveloffset=+2]
[role="_additional-resources"]
== Additional resources

//* xref:../microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]
* xref:../../microshift_configuring/microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]
* xref:../../microshift_running_apps/microshift-authentication.adoc#authentication-microshift[Pod security authentication and authorization with SCC]
* xref:../../microshift_configuring/microshift-node-access-kubeconfig#microshift-node-access-kubeconfig[Cluster access with kubeconfig]
* xref:../../microshift_configuring/microshift-node-access-kubeconfig#microshift-node-access-kubeconfig[Node access with kubeconfig]
* 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 @@ -22,8 +22,7 @@ include::modules/microshift-low-latency-config-yaml.adoc[leveloffset=+1]
//additional resources for the config.yaml
[role="_additional-resources"]
.Additional resources
//TODO * workload partitioning crossref here
//* xref:../../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the 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
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ include::modules/microshift-install-rhel-tools-concepts.adoc[leveloffset=+1]
include::modules/microshift-install-rhde-steps.adoc[leveloffset=+1]

include::modules/microshift-encrypt-etcd-data.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources

* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/managing_storage_devices/encrypting-block-devices-using-luks_managing-storage-devices#luks-disk-encryption_encrypting-block-devices-using-luks[LUKS disk encryption]

[id="additional-resources_microshift-install-get-ready_{context}"]
[role="_additional-resources"]
Expand All @@ -33,3 +29,4 @@ include::modules/microshift-encrypt-etcd-data.adoc[leveloffset=+1]
* xref:../microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI]
* link:https://docs.redhat.com/en/documentation/red_hat_build_of_microshift/latest/html/installing_with_an_rpm_package/index[Installing from an RPM package]
* xref:../microshift_networking/microshift-networking-settings.adoc#microshift-networking[Understanding networking settings]
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/managing_storage_devices/encrypting-block-devices-using-luks_managing-storage-devices#luks-disk-encryption_encrypting-block-devices-using-luks[LUKS disk encryption]
2 changes: 1 addition & 1 deletion microshift_install_rpm/microshift-install-rpm.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ include::modules/microshift-install-rpms.adoc[leveloffset=+1]
== Additional resources
* xref:../microshift_install_get_ready/microshift-fips.adoc#microshift-fips[Using FIPS mode with {microshift-short}]
* 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]
* xref:../microshift_configuring/microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9/html/interactively_installing_rhel_over_the_network/customizing-the-system-in-the-installer_rhel-installer#manual-partitioning_customizing-the-system-in-the-installer[Configuring manual partitioning]
* 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]
* 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]
14 changes: 7 additions & 7 deletions microshift_networking/microshift-cni.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ include::_attributes/attributes-microshift.adoc[]

toc::[]

The OVN-Kubernetes Container Network Interface (CNI) plugin is the default networking solution for {microshift-short} clusters. OVN-Kubernetes is a virtualized network for pods and services that is based on Open Virtual Network (OVN).
The OVN-Kubernetes Container Network Interface (CNI) plugin is the default networking solution for {microshift-short} nodes. OVN-Kubernetes is a virtualized network for pods and services that is based on Open Virtual Network (OVN).

* Default network configuration and connections are applied automatically in {microshift-short} with the `microshift-networking` RPM during installation.
* A cluster that uses the OVN-Kubernetes network plugin also runs Open vSwitch (OVS) on the node.
* A node that uses the OVN-Kubernetes network plugin also runs Open vSwitch (OVS) on the node.
* OVN-K configures OVS on the node to implement the declared network configuration.
* Host physical interfaces are not bound by default to the OVN-K gateway bridge, `br-ex`. You can use standard tools on the host for managing the default gateway, such as the Network Manager CLI (`nmcli`).
* Changing the CNI is not supported on {microshift-short}.
Expand All @@ -19,7 +19,7 @@ Using configuration files or custom scripts, you can configure the following net
* You can use subnet CIDR ranges to allocate IP addresses to pods.
* You can change the maximum transmission unit (MTU) value.
* You can configure firewall ingress and egress.
* You can define network policies in the {microshift-short} cluster, including ingress and egress rules.
* You can define network policies in the {microshift-short} node, including ingress and egress rules.
* You can use the {microshift-short} Multus plug-in to chain other CNI plugins.
* You can configure or remove the ingress router.

Expand All @@ -35,7 +35,7 @@ Networking features available with {microshift-short} {product-version} include:
* Dynamic node IP
* Custom gateway interface
* Second gateway interface
* Cluster network on specified host interface
* Node network on specified host interface
* Blocking external access to NodePort service on specific host interfaces

Networking features not available with {microshift-short} {product-version}:
Expand All @@ -47,7 +47,7 @@ Networking features not available with {microshift-short} {product-version}:

[id="microshift-ip-forward_{context}"]
== IP forward
The host network `sysctl net.ipv4.ip_forward` kernel parameter is automatically enabled by the `ovnkube-master` container when started. This is required to forward incoming traffic to the CNI. For example, accessing the NodePort service from outside of a cluster fails if `ip_forward` is disabled.
The host network `sysctl net.ipv4.ip_forward` kernel parameter is automatically enabled by the `ovnkube-master` container when started. This is required to forward incoming traffic to the CNI. For example, accessing the NodePort service from outside of a node fails if `ip_forward` is disabled.

[id="microshift-network-performance_{context}"]
== Network performance optimizations
Expand All @@ -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-using-config-yaml[Customizing {microshift-short} by using the 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]
* xref:../microshift_networking/microshift_network_policy/microshift-network-policy-index.adoc#microshift-network-policies[About network policies]
3 changes: 1 addition & 2 deletions microshift_networking/microshift-nw-router.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,10 @@ include::modules/microshift-nw-router-config-ports.adoc[leveloffset=+2]

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

[id="additional-resources_microshift-understanding-and-configuring-router"]
[role="_additional-resources"]
[id="additional-resources_microshift-understanding-and-configuring-router_{context}"]
== Additional resources
* 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]

include::modules/microshift-nw-config-route-admission.adoc[leveloffset=+1]
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-config-snippets.adoc#microshift-config-snippets[Using configuration snippets].
* xref:../microshift_configuring/microshift-config-snippets.adoc#microshift-config-snippets[Using configuration snippets]
8 changes: 4 additions & 4 deletions modules/microshift-ingress-controller-conc.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,18 @@
[id="microshift-ingress-control-concept_{context}"]
= Using ingress control in {microshift-short}

When you create your {microshift-short} cluster, each pod and service running on the cluster is allocated an IP address. These IP addresses are accessible to other pods and services running nearby by default, but are not accessible to external clients. {microshift-short} uses a minimal implementation of the {ocp} `IngressController` API to enable external access to cluster services.
When you create your {microshift-short} node, each pod and service running on the node is allocated an IP address. These IP addresses are accessible to other pods and services running nearby by default, but are not accessible to external clients. {microshift-short} uses a minimal implementation of the {ocp} `IngressController` API to enable external access to node services.

With more configuration options, you can fine-tune ingress to meet your specific needs. To use enhanced ingress control, update the parameters in the {microshift-short} configuration file and restart the service. Ingress configuration is useful in a variety of ways, for example:

* If your application starts processing requests from clients but the connection is
closed before it can respond, you can set the `ingress.tuningOptions.serverTimeout` parameter in the configuration file to a higher value to accommodate the speed of the response from the server.

* If the router has many connections open because an application running on the cluster does not close connections properly, you can set the `ingress.tuningOptions.serverTimeout` and `spec.tuningOptions.serverFinTimeout` parameters to a lower value, forcing those connections to close sooner.
* If the router has many connections open because an application running on the node does not close connections properly, you can set the `ingress.tuningOptions.serverTimeout` and `spec.tuningOptions.serverFinTimeout` parameters to a lower value, forcing those connections to close sooner.

* If you need to configure the ingress controller to verify client certificates, you can use the `ingress.clientTLS` parameter to set a clientCA value, which is a reference to a config map. The config map contains the PEM-encoded CA certificate bundle that is used to verify a client's certificate. Optionally, you can also configure a list of certificate subject filters.
* If you need to configure the ingress controller to verify client certificates, you can use the `ingress.clientTLS` parameter to set a clientCA value, which is a reference to a config map. The config map contains the PEM-encoded CA certificate bundle that is used to verify a client's certificate. Optionally, you can also configure a list of certificate subject filters.

* If you need to configure a TLS security profile for an ingress controller, you can use the `ingress.tlsSecurityProfile` parameter to specify a default or custom individual TLS security profiles. The TLS security profile defines the minimum TLS version and the TLS ciphers for TLS connections for the ingress controllers.
If a TLS security profile is not configured, the default value is based on the TLS security profile set for the API server.

* If you need to define a policy for handling new route claims, you can use the `routeAdmission` parameter to allow or deny claims across namespaces. You set the `routeAdmission` parameter to describe how hostname claims across namespaces should be handled and to describe how routes with wildcard policies are handled by the ingress controller.
* If you need to define a policy for handling new route claims, you can use the `routeAdmission` parameter to allow or deny claims across namespaces. You set the `routeAdmission` parameter to describe how hostname claims across namespaces should be handled and to describe how routes with wildcard policies are handled by the ingress controller.
Loading