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
4 changes: 2 additions & 2 deletions microshift_cli_ref/microshift-cli-tools-introduction.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ 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]
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/cli_tools/openshift-cli-oc#cli-about-cli_cli-developer-commands[About the OpenShift CLI] (OpenShift Container Platform documentation)
* 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)
* link:https://docs.redhat.com/en/documentation/red_hat_enterprise_linux/9[Red Hat Enterprise Linux (RHEL) documentation for specific use cases]
* xref:../microshift_configuring/microshift-node-access-kubeconfig.adoc#microshift-kubeconfig[Node access with kubeconfig]
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
4 changes: 2 additions & 2 deletions microshift_configuring/microshift-default-config-yaml.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ include::modules/microshift-config-yaml.adoc[leveloffset=+1]

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

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

//* xref:../microshift-using-config-yaml.adoc#microshift-using-config-yaml[Customizing {microshift-short} by using the configuration file]
* xref:../microshift_configuring/microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking greenboot status]
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]
6 changes: 3 additions & 3 deletions microshift_configuring/microshift-using-config-yaml.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
= 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 @@ -15,8 +15,8 @@ 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_configuring/microshift-greenboot-checking-status.adoc#microshift-greenboot-checking-status[Checking greenboot status]
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,12 @@ include::modules/microshift-install-system-requirements.adoc[leveloffset=+1]
Plan to pair a supported version of {op-system-ostree} with the {microshift-short} version you are using as described in the following compatibility table:

include::snippets/microshift-rhde-compatibility-table-snip.adoc[leveloffset=+1]

[id="additional-resources_microshift-install-get-ready"]
[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_install_rpm/microshift-install-rpm.adoc#microshift-install-rpm[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]
12 changes: 6 additions & 6 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 a {microshift-short} node. 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 @@ -68,7 +68,7 @@ include::modules/microshift-nw-topology.adoc[leveloffset=+1]
[id="_additional-resources_microshift-cni_{context}"]
== 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]
4 changes: 2 additions & 2 deletions microshift_networking/microshift-nw-router.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ 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_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]