Chapter 1. Installing the roxctl CLI
Chapter 1. Installing the roxctl CLI roxctl is a command-line interface (CLI) for running commands on Red Hat Advanced Cluster Security for Kubernetes (RHACS). You can install the roxctl CLI by downloading the binary or you can run the roxctl CLI from a container image. 1.1. Installing the roxctl CLI by downloading the binary You can install the roxctl CLI to interact with RHACS from a command-line interface. You can install roxctl on Linux, Windows, or macOS. 1.1.1. Installing the roxctl CLI on Linux You can install the roxctl CLI binary on Linux by using the following procedure. Note roxctl CLI for Linux is available for amd64 , arm64 , ppc64le , and s390x architectures. Procedure Determine the roxctl architecture for the target operating system: USD arch="USD(uname -m | sed "s/x86_64//")"; arch="USD{arch:+-USDarch}" Download the roxctl CLI: USD curl -L -f -o roxctl "https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Linux/roxctlUSD{arch}" Make the roxctl binary executable: USD chmod +x roxctl Place the roxctl binary in a directory that is on your PATH : To check your PATH , execute the following command: USD echo USDPATH Verification Verify the roxctl version you have installed: USD roxctl version 1.1.2. Installing the roxctl CLI on macOS You can install the roxctl CLI binary on macOS by using the following procedure. Note roxctl CLI for macOS is available for amd64 and arm64 architectures. Procedure Determine the roxctl architecture for the target operating system: USD arch="USD(uname -m | sed "s/x86_64//")"; arch="USD{arch:+-USDarch}" Download the roxctl CLI: USD curl -L -f -o roxctl "https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Darwin/roxctlUSD{arch}" Remove all extended attributes from the binary: USD xattr -c roxctl Make the roxctl binary executable: USD chmod +x roxctl Place the roxctl binary in a directory that is on your PATH : To check your PATH , execute the following command: USD echo USDPATH Verification Verify the roxctl version you have installed: USD roxctl version 1.1.3. Installing the roxctl CLI on Windows You can install the roxctl CLI binary on Windows by using the following procedure. Note roxctl CLI for Windows is available for the amd64 architecture. Procedure Download the roxctl CLI: USD curl -f -O https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Windows/roxctl.exe Verification Verify the roxctl version you have installed: USD roxctl version 1.2. Running the roxctl CLI from a container The roxctl client is the default entry point in the RHACS roxctl image. To run the roxctl client in a container image: Prerequisites You must first generate an authentication token from the RHACS portal. Procedure Log in to the registry.redhat.io registry. USD docker login registry.redhat.io Pull the latest container image for the roxctl CLI. USD docker pull registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 After you install the CLI, you can run it by using the following command: USD docker run -e ROX_API_TOKEN=USDROX_API_TOKEN \ -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 \ -e USDROX_CENTRAL_ADDRESS <command> Note In Red Hat Advanced Cluster Security Cloud Service (RHACS Cloud Service), when using roxctl commands that require the Central address, use the Central instance address as displayed in the Instance Details section of the Red Hat Hybrid Cloud Console. For example, use acs-ABCD12345.acs.rhcloud.com instead of acs-data-ABCD12345.acs.rhcloud.com . Verification Verify the roxctl version you have installed. USD docker run -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 version
arch="USD(uname -m | sed "s/x86_64//")"; arch="USD{arch:+-USDarch}" curl -L -f -o roxctl "https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Linux/roxctlUSD{arch}" chmod +x roxctl echo USDPATH roxctl version arch="USD(uname -m | sed "s/x86_64//")"; arch="USD{arch:+-USDarch}" curl -L -f -o roxctl "https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Darwin/roxctlUSD{arch}" xattr -c roxctl chmod +x roxctl echo USDPATH roxctl version curl -f -O https://mirror.openshift.com/pub/rhacs/assets/4.7.0/bin/Windows/roxctl.exe roxctl version docker login registry.redhat.io docker pull registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 docker run -e ROX_API_TOKEN=USDROX_API_TOKEN -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 -e USDROX_CENTRAL_ADDRESS <command> docker run -it registry.redhat.io/advanced-cluster-security/rhacs-roxctl-rhel8:4.7.0 version