diff --git a/doc/source/_includes/configure-remote-clis-and-clients.rest b/doc/source/_includes/configure-remote-clis-and-clients.rest new file mode 100644 index 000000000..e204c624a --- /dev/null +++ b/doc/source/_includes/configure-remote-clis-and-clients.rest @@ -0,0 +1,5 @@ + + +.. start-after: remote-cli-begin +.. end-before: remote-cli-end + diff --git a/doc/source/_vendor/vendor_strings.txt b/doc/source/_vendor/vendor_strings.txt index 1884312f4..dccd32afb 100755 --- a/doc/source/_vendor/vendor_strings.txt +++ b/doc/source/_vendor/vendor_strings.txt @@ -43,6 +43,7 @@ used in sample domain names etc. .. |prefix| replace:: stx +.. |l-prefix| replace:: |prefix| .. space character. Needed for padding in tabular output. Currently used where |prefix| replacement is a length shorter than 3. diff --git a/doc/source/security/openstack/config-and-management-using-container-backed-remote-clis-and-clients.rst b/doc/source/security/openstack/config-and-management-using-container-backed-remote-clis-and-clients.rst index 0179d7006..63c77f87a 100644 --- a/doc/source/security/openstack/config-and-management-using-container-backed-remote-clis-and-clients.rst +++ b/doc/source/security/openstack/config-and-management-using-container-backed-remote-clis-and-clients.rst @@ -27,12 +27,12 @@ variables and aliases for the remote |CLI| commands. - Consider adding the following command to your .login or shell rc file, such that your shells will automatically be initialized with the environment - variables and aliases for the remote |CLI| commands. Otherwise, execute it before - proceeding: + variables and aliases for the remote |CLI| commands. Otherwise, execute it + before proceeding: .. code-block:: none - root@myclient:/home/user/remote_cli_wd# source remote_client_platform.sh + $ source remote_client_openstack.sh - You must have completed the configuration steps in :ref:`Configure Remote CLIs ` before proceeding. diff --git a/doc/source/security/openstack/configure-remote-clis-and-clients.rst b/doc/source/security/openstack/configure-remote-clis-and-clients.rst index 535a46008..971d9c8da 100644 --- a/doc/source/security/openstack/configure-remote-clis-and-clients.rst +++ b/doc/source/security/openstack/configure-remote-clis-and-clients.rst @@ -33,6 +33,11 @@ installed. Download the latest release tarball for Cygwin from tarball, extract it to any location and change the Windows variable to include its bin folder from the extracted winpty folder. +For access to remote CLI, it is required to set the DNS in the cluster using the +:command:`system service-parameter-add openstack helm endpoint_domain=domain_name` +command and reapply OpenStack using **system application-apply |prefix|-openstack** +command. + The following procedure shows how to configure the Container-backed Remote |CLIs| for OpenStack remote access. @@ -52,7 +57,7 @@ The following procedure shows how to configure the Container-backed Remote .. parsed-literal:: $ cd $HOME - $ tar xvf |prefix|-remote-clients-.tgz + $ tar xvf |l-prefix|-remote-clients-.tgz #. Download the user/tenant **openrc** file from the |os-prod-hor-long| to the remote workstation. @@ -73,14 +78,14 @@ The following procedure shows how to configure the Container-backed Remote For a Distributed Cloud system, navigate to **Project** \> **Central Cloud Regions** \> **RegionOne** \> and download the **Openstack RC file**. -#. On the remote workstation, configure the client access. +#. On the remote workstation, configure the OpenStack client access. #. Change to the location of the extracted tarball. .. parsed-literal:: - $ cd $HOME/|prefix|-remote-clients-/ + $ cd $HOME/|l-prefix|-remote-clients-/ #. Create a working directory that will be mounted by the container implementing the remote |CLIs|. @@ -89,14 +94,20 @@ The following procedure shows how to configure the Container-backed Remote $ mkdir -p $HOME/remote_cli_wd - #. Run the :command:`configure\_client.sh` script. + #. Run the :command:`configure\_client.sh` script to install and configure + the OpenStack CLIs/Clients. - .. parsed-literal:: + .. only:: starlingx - $ ./configure_client.sh -t openstack -r admin_openrc.sh -w - $HOME/remote_cli_wd -p - 625619392498.dkr.ecr.us-west-2.amazonaws.com/docker.io/starlingx/stx-platformclients:stx.5.0-v1.4.3 + :: + $ ./configure_client.sh -t openstack -r admin-openrc.sh -w $HOME/remote_cli_wd + + .. only:: partner + + .. include:: /_includes/configure-remote-clis-and-clients.rest + :start-after: remote-cli-begin + :end-before: remote-cli-end If you specify repositories that require authentication, as shown above, you must remember to perform a :command:`docker login` to that @@ -106,7 +117,7 @@ The following procedure shows how to configure the Container-backed Remote **-t** The type of client configuration. The options are platform \(for - |prod-long| |CLI| and clients\) and openstack \(for + |prod-long| |CLI| and clients\) and OpenStack \(for |prod-os| application |CLI| and clients\). The default value is platform. @@ -124,7 +135,7 @@ The following procedure shows how to configure the Container-backed Remote commands. For the platform client setup, the default is - remote\_client\_platform.sh. For the openstack application client + remote\_client\_platform.sh. For the OpenStack application client setup, the default is remote\_client\_openstack.sh. **-w** @@ -141,14 +152,6 @@ The following procedure shows how to configure the Container-backed Remote By default, the platform |CLIs| and clients container image is pulled from docker.io/starlingx/stx-platformclients. - For example, to use the container images from the |prod| |AWS| ECR: - - .. parsed-literal:: - - $ ./configure_client.sh -t platform -r admin-openrc.sh -k - admin-kubeconfig -w $HOME/remote_cli_wd -p - 625619392498.dkr.ecr.us-west-2.amazonaws.com/docker.io/starlingx/stx-platformclients:stx.5.0-v1.4.3 - If you specify repositories that require authentication, you must first perform a :command:`docker login` to that repository before using remote |CLIs|. @@ -164,7 +167,7 @@ The following procedure shows how to configure the Container-backed Remote in the shell to set up required environment variables and aliases before any remote |CLI| commands can be run. - #. Copy the file remote\_client\_platform.sh to $HOME/remote\_cli\_wd + #. Copy the file remote\_client\_openstack.sh to $HOME/remote\_cli\_wd .. rubric:: |postreq| @@ -179,7 +182,7 @@ variables and aliases for the remote |CLI| commands. your shells will automatically be initialized with the environment variables and aliases for the remote |CLI| commands. -See :ref:`Use Container-backed Remote |CLI|s and Clients +See :ref:`Use Container-backed Remote CLIs and Clients ` for details.