Merge pull request #60414 from ShaunaDiaz/OSDOCS-6146

Author: michaelryanpeter

_topic_maps/_topic_map_ms.yml

@@ -88,8 +88,8 @@ Name: CLI tools
 Dir: microshift_cli_ref
 Distros: microshift
 Topics:
-- Name: CLI tools overview
-  File: microshift-cli-overview
+- Name: CLI tools introduction
+  File: microshift-cli-tools-introduction
 - Name: Installing the OpenShift CLI
   File: microshift-oc-cli-install
 - Name: Configuring the OpenShift CLI

microshift_cli_ref/microshift-cli-overview.adoc

@@ -0,0 +1,31 @@
+:_content-type: ASSEMBLY
+[id="microshift-cli-tools"]
+= {product-title} CLI tools introduction
+include::_attributes/attributes-microshift.adoc[]
+:context: microshift-cli-tools-introduction
+
+toc::[]
+
+You can use different command-line interface (CLI) tools to build, deploy, and manage {product-title} clusters and workloads. With CLI tools, you can complete various administration and development operations from the terminal to manage deployments and interact with each component of the system.
+
+CLI tools available for use with {product-title} are the following:
+
+* Built-in `microshift` command types
+* Linux CLI tools
+* Kubernetes CLI (`kubectl`)
+* The OpenShift CLI (`oc`) tool with an enabled subset of commands
+
+[NOTE]
+====
+Commands for multi-node deployments, projects, and developer tooling are not supported by {product-title}.
+====
+
+[role="_additional-resources"]
+[id="additional-resources_microshift-cli-tools"]
+.Additional resources
+
+* xref:..//microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool for MicroShift].
+
+* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html/cli_tools/openshift-cli-oc[Detailed description of the OpenShift CLI (oc)].
+
+* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9[Red Hat Enterprise Linux (RHEL) documentation for specific use cases].

microshift_cli_ref/microshift-cli-tools-introduction.adoc

@@ -1,12 +1,12 @@
 :_content-type: ASSEMBLY
 [id="microshift-cli-using-oc"]
-= Using the `oc` tool
+= Using the oc tool
 include::_attributes/attributes-microshift.adoc[]
 :context: microshift-using-oc
 
 toc::[]
 
-The optional OpenShift CLI (`oc`) tool is available for you to use if you are already familiar with {OCP} and Kubernetes.
+The optional OpenShift CLI (`oc`) tool provides a subset of `oc` commands for {product-title} deployments. Using `oc` is convenient if you are familiar with {OCP} and Kubernetes.
 
 include::modules/microshift-cli-oc-about.adoc[leveloffset=+1]
 

microshift_cli_ref/microshift-cli-using-oc.adoc

@@ -2,21 +2,36 @@
 [id="microshift-oc-cli-commands"]
 = OpenShift CLI command reference
 include::_attributes/attributes-microshift.adoc[]
-:context: cli-administrator-commands
+:context: microshift-oc-cli-commands
 
 toc::[]
 
-This reference provides descriptions and example commands for OpenShift CLI (`oc`) commands. You must have `cluster-admin` or equivalent permissions to use these commands.
+Descriptions and example commands for OpenShift CLI (`oc`) commands are included in this reference document. You must have `cluster-admin` or equivalent permissions to use these commands. To list administrator commands and information about them, use the following commands:
 
-Run `oc adm -h` to list all administrator commands or run `oc <command> --help` to get additional details for a specific command.
+* Enter the `oc adm -h` command to list all administrator commands:
++
+.Command syntax
++
+[source,terminal]
+----
+$ oc adm -h
+----
+
+* Enter the `oc <command> --help` command to get additional details for a specific command:
++
+.Command syntax
++
+[source,terminal]
+----
+$ oc <command> --help
+----
 
 [IMPORTANT]
 ====
 Using `oc <command> --help` lists details for any `oc` command. Not all `oc` commands apply to using {product-title}.
 ====
 
-// The OCP file is auto-generated from the openshift/oc repository; MicroShift is made manually
-// OpenShift CLI (oc) administrator commands
-//include::modules/microshift-oc-by-example-content.adoc[leveloffset=+1]
-include::modules/microshift-oc-by-example-content-gen.adoc[leveloffset=+1]
+// The OCP files are auto-generated from the openshift/oc repository; use the MicroShift-specific flags to generate MicroShift command files from the same repo
+include::modules/microshift-oc-by-example-content.adoc[leveloffset=+1]
+
 include::modules/microshift-oc-adm-by-example-content.adoc[leveloffset=+1]

microshift_cli_ref/microshift-oc-cli-commands-list.adoc

@@ -6,12 +6,21 @@ include::_attributes/attributes-microshift.adoc[]
 
 toc::[]
 
-The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title} is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with {product-title}, or you can gain extended functionality by using the `oc` binary.
+The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title} is a certified Kubernetes distribution, you can use the supported `kubectl` CLI tool that ships with {product-title}, or you can gain extended functionality by using the `oc` CLI tool.
+
+[id="microshift-kubectl-binary_{context}"]
+== The kubectl CLI tool
+
+You can use the `kubectl` CLI tool to interact with Kubernetes primitives on your {product-title} cluster. You can also use existing `kubectl` workflows and scripts for new {product-title} users coming from another Kubernetes environment, or for those who prefer to use the `kubectl` CLI.
+
+The `kubectl` CLI tool is included in the archive if you download the `oc` CLI tool.
+
+For more information, read the link:https://kubernetes.io/docs/reference/kubectl/overview/[Kubernetes CLI tool documentation].
 
 [id="microshift-oc-binary_{context}"]
-== The oc binary
+== The oc CLI tool
 
-The `oc` binary offers the same capabilities as the `kubectl` binary, but it extends to natively support additional {product-title} features, including:
+The `oc` CLI tool offers the same capabilities as the `kubectl` CLI tool, but it extends to natively support additional {product-title} features, including:
 
 * **Route resource**
 +
@@ -23,7 +32,7 @@ The additional command `oc new-app`, for example, makes it easier to get new app
 
 [IMPORTANT]
 ====
-If you installed an earlier version of the `oc` binary, you cannot use it to complete all of the commands in {product-title} {product-version}.  If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your {product-title} server version.
+If you installed an earlier version of the `oc` CLI tool, you cannot use it to complete all of the commands in {product-title} {ocp-version}. If you want the latest features, you must download and install the latest version of the `oc` CLI tool corresponding to your {product-title} version.
 ====
 
 Non-security API changes will involve, at minimum, two minor releases (4.1 to 4.2 to 4.3, for example) to allow older `oc` binaries to update. Using new capabilities might require newer `oc` binaries. A 4.3 server might have additional capabilities that a 4.2 `oc` binary cannot use and a 4.3 `oc` binary might have additional capabilities that are unsupported by a 4.2 server.
@@ -51,12 +60,3 @@ image:redcircle-1.png[] Fully compatible.
 image:redcircle-2.png[] `oc` client might not be able to access server features.
 
 image:redcircle-3.png[] `oc` client might provide options and features that might not be compatible with the accessed server.
-
-[id="microshift-kubectl-binary_{context}"]
-== The kubectl binary
-
-The `kubectl` binary is provided as a means to support existing workflows and scripts for new {product-title} users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the {product-title} cluster.
-
-The `kubectl` binary is included in the archive if you download the `oc` binary.
-
-For more information, see the link:https://kubernetes.io/docs/reference/kubectl/overview/[kubectl documentation].

microshift_cli_ref/microshift-usage-oc-kubectl.adoc

@@ -22,14 +22,25 @@ To troubleshoot connection problems with the NodePort service, read about the kn
 ====
 
 include::modules/microshift-cni.adoc[leveloffset=+1]
+
 include::modules/microshift-configuring-ovn.adoc[leveloffset=+1]
+
 include::modules/microshift-restart-ovnkube-master.adoc[leveloffset=+1]
+
 //include::modules/microshift-man-config-ovs-bridge.adoc[leveloffset=+1]
+
 include::modules/microshift-http-proxy.adoc[leveloffset=+1]
+
+include::modules/microshift-rpm-ostree-https.adoc[leveloffset=+1]
+
 include::modules/microshift-cri-o-container-runtime.adoc[leveloffset=+1]
+
 include::modules/microshift-ovs-snapshot.adoc[leveloffset=+1]
-include::modules/microshift-deploying-a-load-balancer.adoc[leveloffset=+1] 
-include::modules/microshift-blocking-nodeport-access.adoc[leveloffset=+1] 
+
+include::modules/microshift-deploying-a-load-balancer.adoc[leveloffset=+1]
+
+include::modules/microshift-blocking-nodeport-access.adoc[leveloffset=+1]
+
 include::modules/microshift-mDNS.adoc[leveloffset=+1]
 
 [role="_additional-resources"]

microshift_networking/microshift-networking.adoc

@@ -13,4 +13,4 @@ toc::[]
 include::snippets/microshift-tech-preview-snip.adoc[leveloffset=+1]
 
 include::modules/microshift-observe-debug-etcd-server.adoc[leveloffset=+1]
-include::modules/microshift-configuration.adoc[leveloffset=+1]
+include::modules/microshift-config-etcd.adoc[leveloffset=+1]

microshift_support/microshift-etcd.adoc

@@ -37,7 +37,9 @@ $ sudo cat /var/lib/microshift/resources/kubeadmin/kubeconfig > ~/.kube/config
 $ chmod go-r ~/.kube/config
 ----
 
-. Verify that {product-title} is running by entering the following command:
+.Verification
+
+* Verify that {product-title} is running by entering the following command:
 +
 [source,terminal]
 ----

modules/microshift-accessing-cluster-locally.adoc

@@ -8,26 +8,28 @@
 [id="microshift-accessing-cluster-open-firewall_{context}"]
 = Opening the firewall for remote access to the {product-title} cluster
 
-Use the following procedure to open the firewall so that a remote user can access the {product-title} cluster. Your account must have cluster admin privileges. This procedure must be completed before a workstation user can access the cluster remotely.
+Use the following procedure to open the firewall so that a remote user can access the {product-title} cluster. This procedure must be completed before a workstation user can access the cluster remotely.
 
-* `user@microshift`, is the user on the {product-title} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation.
+For this procedure, `user@microshift` is the user on the {product-title} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation.
 
 .Prerequisites
 
 * You have installed the `oc` binary.
 
+* Your account has cluster administration privileges.
+
 .Procedure
 
-. As `user@microshift` on the {product-title} host, open the firewall port for the Kubernetes API server (`6443/tcp`) by running the following command:
+* As `user@microshift` on the {product-title} host, open the firewall port for the Kubernetes API server (`6443/tcp`) by running the following command:
 +
 [source,terminal]
 ----
 [user@microshift]$ sudo firewall-cmd --permanent --zone=public --add-port=6443/tcp && sudo firewall-cmd --reload
 ----
 
-.Verify {product-title} is running
+.Verification
 
-. As `user@microshift`, verify that {product-title} is running by entering the following command:
+* As `user@microshift`, verify that {product-title} is running by entering the following command:
 +
 [source,terminal]
 ----