Skip to content

Commit 455328f

Browse files
authored
Merge pull request #101693 from gwynnemonahan/OSDOCS-17179
OSDOCS-17179 [NETOBSERV] Outdated doc for netobserv CLI
2 parents ff0b27b + 4af71aa commit 455328f

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed
Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,67 @@
11
// Module included in the following assemblies:
2-
2+
//
33
// * observability/network_observability/netobserv_cli/netobserv-cli-install.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="network-observability-cli-install_{context}"]
77
= Installing the Network Observability CLI
88

9-
Installing the Network Observability CLI (`oc netobserv`) is a separate procedure from the Network Observability Operator installation. This means that, even if you have the Operator installed from the software catalog, you need to install the CLI separately.
9+
[role="_abstract"]
10+
The Network Observability CLI gives you a lightweight way to quickly debug and troubleshoot network observability. It must be installed separately.
11+
12+
Installing the Network Observability CLI (`oc netobserv`) is a separate procedure from the Network Observability Operator installation. This means that, even if the Operator is installed from the software catalog, the `CLI` must be installed separately.
1013

1114
[NOTE]
1215
====
13-
You can optionally use Krew to install the `netobserv` CLI plugin. For more information, see "Installing a CLI plugin with Krew".
16+
Users can optionally use Krew to install the `netobserv` CLI plugin. For more information, see "Installing a CLI plugin with Krew".
1417
====
1518

1619
.Prerequisites
1720
* You must install the {oc-first}.
1821
* You must have a macOS or Linux operating system.
22+
* You must install either `docker` or `podman`.
23+
24+
[NOTE]
25+
====
26+
You can use `podman` or `docker` to run the installation commands. This procedure uses `podman`.
27+
====
1928

2029
.Procedure
2130

22-
. Download the link:https://mirror.openshift.com/pub/cgw/netobserv/latest/[`oc netobserv` file] that corresponds with your architecture. For example, for the `amd64` archive:
31+
. Log in to the *Red Hat registry* by running the following command:
2332
+
2433
[source,terminal]
2534
----
26-
$ curl -LO https://mirror.openshift.com/pub/cgw/netobserv/latest/oc-netobserv-amd64
35+
$ podman login registry.redhat.io
2736
----
28-
. Make the file executable:
37+
38+
. Extract the `oc-netobserv` file from the image by running the following commands:
2939
+
3040
[source,terminal]
3141
----
32-
$ chmod +x ./oc-netobserv-amd64
42+
$ podman create --name netobserv-cli registry.redhat.io/network-observability/network-observability-cli-rhel9:1.10
43+
$ podman cp netobserv-cli:/oc-netobserv .
44+
$ podman rm netobserv-cli
3345
----
34-
. Move the extracted `netobserv-cli` binary to a directory that is on your `PATH`, such as `/usr/local/bin/`:
46+
47+
. Move the extracted file to a directory that is on the system's `PATH`, such as `/usr/local/bin/`, by running the following command:
3548
+
3649
[source,terminal]
3750
----
38-
$ sudo mv ./oc-netobserv-amd64 /usr/local/bin/oc-netobserv
51+
$ sudo mv oc-netobserv /usr/local/bin/
3952
----
4053

4154
.Verification
4255

43-
* Verify that `oc netobserv` is available:
56+
. Verify that `oc netobserv` is available:
4457
+
4558
[source,terminal]
4659
----
4760
$ oc netobserv version
4861
----
4962
+
50-
.Example output
63+
This command should produce an outcome similar to the following example:
5164
[source,terminal]
5265
----
5366
Netobserv CLI version <version>
54-
----
67+
----

0 commit comments

Comments
 (0)