Symp CLI Client¶

Overview¶

The Zadara zCompute Symp client is a unified CLI (Command Line Interface) to manage and operate your zCompute services.

The zCompute Symp CLI tools should be installed on a VM image that is created from the zCompute Toolbox image, available in the zCompute cluster’s Machine Images Marketplace.

To install the zCompute Symp CLI tools, the VM should be configured to be accessible externally via ssh.

Installing the Symp CLI client¶

The Symp CLI client is supplied as part of the zCompute Toolbox.

In the zCompute UI, go to Machine Images > Marketplace. If there are more than one zCompute Toolbox images, use the the v2.2.0 (or later) image.

Caution

Do not use the Toolbox v21.0.0 image.

It is deprecated and exists only for backward compatibility.
In the Zadara apps list, click the zCompute Toolbox icon.

In the dialog box that opens:

Note

If you connected as an account admin, it is recommended that the Scope is set to Account.

Click Download.

Note

The image download takes a few minutes to finish.

The download process is complete when the image appears with the status Ready in the Machine Images > Images UI screen.

The zCompute Toolbox image is named fedora-3x-zadara-toolbox-xxxxx or similar. The image name can be modified at any time.
Create a VM instance:
1. Go to Compute > Instances > Create.
  1. Enter the Compute parameters:
    - Name: A name for the VM.
    - Create from: Select Image.
    - Image: Select the zcompute-toolbox image downloaded in the previous step.
    - Instance type: Search and select a suitable instance type.
    - Key Pair: Select the key pair to sign-in to the VM over ssh. If no key pair exists for the user, create one using the + sign and follow the instructions to save the private key file.
    - Click Next.
  2. Enter the Storage parameters:
    - Size: Set the required allocation for the boot volume.
    - Storage pool: Select the storage pool.
    - Click Data Volumes > Add to select or create a data volume with the required capacity.
    - Click Next.
  3. Enter the Networking tab parameters according to the specific environment, and click Finish. The VM instance will start.
When the VM instance is ready:
1. Launch the VM in the target project, if it wasn’t started yet:
  1. In the zCompute UI, go to Compute > Instances.
  2. Select the VM, and click Start.
2. If the Security Group settings are not yet configured to permit ssh access to the VM:
  1. Go to VPC Networking > Security Groups and select the Security Group for the account and project.
  2. On the top toolbar, click Modify.
  3. In the Modify Security Group dialog, click Add to add any required entries to permit ssh access.
  4. Click OK.
3. Configure an Elastic IP address for the VM:
  1. Go to Compute > Instances, and select the VM instance.
  2. On the top toolbar, select More > Attach > Elastic IP.
  3. In the Attach Elastic IP dialog, allocate an IP address.
  4. In Compute > Instances, click the VM instance’s link in the Name column.
  5. In the VM’s Subnets section, note its Elastic IP address, or copy it to the clipboard.
4. Connect to the VM instance via ssh, as the user fedora:
```
ssh -i <private-key pem path/filename> fedora@<Elastic IP address>
```
  The VM displays the Zadara Toolbox welcome message:
```
 _____         _                   _____           _ _
|__  /__ _  __| | __ _ _ __ __ _  |_   _|__   ___ | | |__   _____  __
  / // _` |/ _` |/ _` | '__/ _` |   | |/ _ \ / _ \| | '_ \ / _ \ \/ /
 / /| (_| | (_| | (_| | | | (_| |   | | (_) | (_) | | |_) | (_) >  <
/____\__,_|\__,_|\__,_|_|  \__,_|   |_|\___/ \___/|_|_.__/ \___/_/\_\

Welcome to Zadara Toolbox VM!
```
Install Symp on the VM by running the following command:

symp-update -c <Cluster IP> -k

Verify that the Symp installation was successful by running a symp command.

symp -k --url https://<cluster IP address> -d <account> -u <username> --project <projectname>

Symp will prompt for the user’s password.

For example:

symp -k --url https://10.11.12.13 -d cloud_member -u member1 --project vpc_proj1

Starting new HTTPS connection (1): 10.11.12.13
Password:

 d88888b  dP    dP 8888ba.88ba   888888ba  dP     dP   .88888.  888888ba  dP    dP
1.     "' Y8.  .8P 88  `8b  `8b  88    `8b 88     88  d8'   `8b 88    `8b Y8.  .8P
`Y88888b.  Y8aa8P  88   88   88 a88aaaa8P' 88aaaaa88a 88     88 88     88  Y8aa8P
      `8b    88    88   88   88  88        88     88  88     88 88     88    88
d8'   .8P    88    88   88   88  88        88     88  Y8.   .8P 88     88    88
 Y88888P     dP    dP   dP   dP  dP        dP     dP   `8888P'  dP     dP    dP

Tap <TAB> twice to get list of available commands.
Type --help to get help with any command
Symphony @ cloud_member/vpc_proj1 >