|
1 | 1 | // Module included in the following assemblies: |
2 | | - |
| 2 | +// |
3 | 3 | // * observability/network_observability/netobserv_cli/netobserv-cli-install.adoc |
4 | 4 |
|
5 | 5 | :_mod-docs-content-type: PROCEDURE |
6 | 6 | [id="network-observability-cli-install_{context}"] |
7 | 7 | = Installing the Network Observability CLI |
8 | 8 |
|
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. |
10 | 13 |
|
11 | 14 | [NOTE] |
12 | 15 | ==== |
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". |
14 | 17 | ==== |
15 | 18 |
|
16 | 19 | .Prerequisites |
17 | 20 | * You must install the {oc-first}. |
18 | 21 | * 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 | +==== |
19 | 28 |
|
20 | 29 | .Procedure |
21 | 30 |
|
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: |
23 | 32 | + |
24 | 33 | [source,terminal] |
25 | 34 | ---- |
26 | | -$ curl -LO https://mirror.openshift.com/pub/cgw/netobserv/latest/oc-netobserv-amd64 |
| 35 | +$ podman login registry.redhat.io |
27 | 36 | ---- |
28 | | -. Make the file executable: |
| 37 | + |
| 38 | +. Extract the `oc-netobserv` file from the image by running the following commands: |
29 | 39 | + |
30 | 40 | [source,terminal] |
31 | 41 | ---- |
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 |
33 | 45 | ---- |
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: |
35 | 48 | + |
36 | 49 | [source,terminal] |
37 | 50 | ---- |
38 | | -$ sudo mv ./oc-netobserv-amd64 /usr/local/bin/oc-netobserv |
| 51 | +$ sudo mv oc-netobserv /usr/local/bin/ |
39 | 52 | ---- |
40 | 53 |
|
41 | 54 | .Verification |
42 | 55 |
|
43 | | -* Verify that `oc netobserv` is available: |
| 56 | +. Verify that `oc netobserv` is available: |
44 | 57 | + |
45 | 58 | [source,terminal] |
46 | 59 | ---- |
47 | 60 | $ oc netobserv version |
48 | 61 | ---- |
49 | 62 | + |
50 | | -.Example output |
| 63 | +This command should produce an outcome similar to the following example: |
51 | 64 | [source,terminal] |
52 | 65 | ---- |
53 | 66 | Netobserv CLI version <version> |
54 | | ----- |
| 67 | +---- |
0 commit comments