mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
OSDOCS-16326-417: manual CP
This commit is contained in:
“Shauna Diaz”
@@ -119,8 +119,6 @@ Topics:
|
||||
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: Disabling LVMS CSI provider and CSI snapshot
|
||||
|
||||
@@ -24,6 +24,4 @@ Commands for multi-node deployments, projects, and developer tools are not suppo
|
||||
== 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/{ocp-version}/html/cli_tools/openshift-cli-oc#cli-about-cli_cli-developer-commands[About the OpenShift CLI] (OpenShift Container Platform 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]
|
||||
* 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)
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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]
|
||||
----
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
:_mod-docs-content-type: ASSEMBLY
|
||||
[id="microshift-config-snippets"]
|
||||
include::_attributes/attributes-microshift.adoc[]
|
||||
= Using {microshift-short} configuration snippets
|
||||
:context: microshift-config-snippets
|
||||
|
||||
toc::[]
|
||||
|
||||
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]
|
||||
@@ -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]
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -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::[]
|
||||
@@ -20,4 +20,4 @@ include::modules/microshift-config-nodeport-limits.adoc[leveloffset=+2]
|
||||
[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]
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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"]
|
||||
@@ -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/{ocp-version}/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]
|
||||
|
||||
@@ -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]
|
||||
|
||||
@@ -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}.
|
||||
@@ -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.
|
||||
|
||||
@@ -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}:
|
||||
@@ -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
|
||||
@@ -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]
|
||||
|
||||
@@ -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]
|
||||
Reference in New Issue
Block a user