OSSM-5632: Installing the istioctl tool & Supported Commands

_topic_maps/_topic_map.yml

@@ -73,6 +73,8 @@ Topics:
   File: ossm-multi-cluster-topologies
 - Name: Deploying multiple service meshes on a single cluster
   File: ossm-deploying-multiple-service-meshes-on-single-cluster
+- Name: Installing the Istio command line utility
+  File: ossm-istioctl-tool
 ---
 Name: Updating
 Dir: update

install/ossm-istioctl-tool.adoc

@@ -0,0 +1,10 @@
+:_mod-docs-content-type: ASSEMBLY
+[id="ossm-istioctl-tool"]
+= Istioctl tool
+include::_attributes/common-attributes.adoc[]
+:context: ossm-istioctl-tool
+
+{SMProduct} 3 supports `istioctl`, the command line utility for the {istio} project that includes many diagnostic and debugging utilities.
+
+include::modules/ossm-support-for-istioctl.adoc[leveloffset=+1]
+include::modules/ossm-installing-the-istioctl-tool.adoc[leveloffset=+1]

migrating/checklists/ossm-migrating-read-me-assembly.adoc

@@ -43,6 +43,10 @@ Be aware that setting the `updateStrategy` to `RevisionBased` also has implicati
 
 include::modules/ossm-migrating-read-me-supported-multi-cluster-topologies.adoc[leveloffset=+1]
 include::modules/ossm-migrating-read-me-support-for-istioctl.adoc[leveloffset=+1]
+
+.Next steps
+* You can install the xref:../../install/ossm-istioctl-tool.adoc#ossm-installing-the-istioctl-tool_ossm-istioctl-tool[Istioctl tool].
+
 include::modules/ossm-migrating-read-me-kubernetes-network-policy-management.adoc[leveloffset=+1]
 include::modules/ossm-migrating-read-me-tls-configuration-change.adoc[leveloffset=+1]
 

modules/ossm-installing-the-istioctl-tool.adoc

@@ -0,0 +1,59 @@
+// Module included in the following assemblies:
+//
+// * service-mesh-docs-main/about/ossm-migrating-assembly.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="ossm-installing-the-istioctl-tool_{context}"]
+= Installing the Istioctl tool
+
+.Prerequisites
+
+* You have access to the {ocp-product-title} web console.
+
+.Procedure
+
+. In the {ocp-product-title} web console, click the question mark icon and select *Command Line Tools*.
+
+. Click *Download istioctl*. Choose the version and architecture that matches your system.
+
+* link:https://mirror.openshift.com/pub/cgw/servicemesh/1.23.0/[Version 1.23.0]
+
+* link:https://mirror.openshift.com/pub/cgw/servicemesh/1.24.1/[Version 1.24.1]
+
+* link:https://mirror.openshift.com/pub/cgw/servicemesh/latest/[Latest]
+
+. Extract the `istioctl` binary by running the following command:
++
+[source,terminal]
+----
+$ tar xzf istioctl-<VERSION>-<OS>-<ARCH>.tar.gz
+----
+
+. Move to the uncompressed directory by running the following command:
++
+[source,terminal]
+----
+$ cd istioctl-<VERSION>-<OS>-<ARCH>
+----
+
+. Add the `istioctl` client to the path by running the following command:
++
+[source,terminal]
+----
+$ export PATH=$PWD:$PATH
+----
+
+. Confirm that the `istioctl` client version and the {istio} control plane version match or are within one version by running the following command:
++
+[source,terminal]
+----
+$ istioctl version
+----
++
+.Sample output:
+[source,terminal]
+----
+client version: 1.20.0
+control plane version: 1.24.3_ossm
+data plane version: none
+----

modules/ossm-migrating-read-me-support-for-istioctl.adoc

@@ -14,19 +14,20 @@
 .Supported Istioctl commands
 [cols="1,1"]
 |===
-|Command |Description
+|Command |Description 
 
-|`admin` | Manage control plane (`istiod`) configuration
-|`analyze` | Analyze Istio configuration and print validation messages
-|`bug-report` | Cluster information and log capture support tool
-|`completion` | Generate the autocompletion script for the specified shell
-|`create-remote-secret` | Create a secret with credentials to allow Istio to access remote Kubernetes `apiservers`
-|`help` | Help about any command
-|`manifest` | Commands related to Istio manifests
-|`proxy-config` | Retrieve information about proxy configuration from Envoy (Kubernetes only)
-|`proxy-status` | Retrieves the synchronization status of each Envoy in the mesh
-|`remote-clusters` | Lists the remote clusters each `istiod` instance is connected to
-|`version` | Prints out build version information
+|`admin` | Manage the control plane (`istiod`) configuration 
+|`analyze` | Analyze the {istio} configuration and print validation messages 
+|`completion` | Generate the autocompletion script for the specified shell 
+|`create-remote-secret` | Create a secret with credentials to allow {istio} to access remote Kubernetes API servers
+|`help` | Display help about any command 
+|`proxy-config`, `pc` | Retrieve information about the proxy configuration from Envoy (Kubernetes only) 
+|`proxy-status`, `ps` | Retrieve the synchronization status of each Envoy in the mesh 
+|`remote-clusters` | List the remote clusters each `istiod` instance is connected to 
+|`validate`, `v` | Validate the {istio} policy and rules files 
+|`version` | Print out build version information 
+|`waypoint` | Manage the waypoint configuration 
+|`ztunnel-config` | Update or retrieve the current Ztunnel configuration. 
 |===
 
 //table for supported commands may need to be included in prod doc instructions for Istioctl, if Istioctl procedure content is to be included in prod docs. As of 11/11/2024, there is no additional prod doc content for Istioctl. It is upstream https://github.com/openshift-service-mesh/sail-operator/blob/55e26da369c897583a578b6a622b70c9ff67beb9/docs/ossm/istioctl/README.md#supported-commands but that may change for GA.

modules/ossm-support-for-istioctl.adoc

@@ -0,0 +1,29 @@
+// Module included in the following assemblies:
+//
+// * service-mesh-docs-main/install/ossm-istioctl-tool
+
+:_mod-docs-content-type: REFERENCE
+[id="ossm-support-for-istioctl_{context}"]
+= Support for Istioctl
+
+{SMProduct} 3 supports a selection of Istioctl commands.
+
+.Supported Istioctl commands
+[cols="1,1"]
+|===
+|Command |Description 
+
+|`admin` | Manage the control plane (`istiod`) configuration 
+|`analyze` | Analyze the {istio} configuration and print validation messages 
+|`completion` | Generate the autocompletion script for the specified shell
+|`create-remote-secret` | Create a secret with credentials to allow {istio} to access remote Kubernetes API servers 
+|`help` | Display help about any command 
+|`proxy-config`, `pc` | Retrieve information about the proxy configuration from Envoy (Kubernetes only) 
+|`proxy-status`, `ps` | Retrieve the synchronization status of each Envoy in the mesh
+|`remote-clusters` | List the remote clusters each `istiod` instance is connected to 
+|`validate`, `v` | Validate the {istio} policy and rules files 
+|`version` | Print out the build version information 
+|`waypoint` | Manage the waypoint configuration 
+|`ztunnel-config` | Update or retrieve the current Ztunnel configuration.
+|===
+