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:
Go to Compute > Instances > Create.
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.
Enter the Storage parameters:
Boot Volume - disk size (GB) and volume type that will be used for the boot volume of the VM instance.
Data Volumes - add new or existing data volumes. To add a new volume, click Add and + and configure the following:
Name - volume name.
Description - description of volume.
Volume Type - select the volume type from the dropdown list.
Size - volume size (GB).
Protection Group - protection group for the volume.
Click Next.
Enter the Networking tab parameters according to the specific environment, and click Finish. The VM instance will start.
When the VM instance is ready:
Launch the VM in the target project, if it wasn’t started yet:
In the zCompute UI, go to Compute > Instances.
Select the VM, and click Start.
If the Security Group settings are not yet configured to permit ssh access to the VM:
Go to VPC Networking > Security Groups and select the Security Group for the account and project.
On the top toolbar, click Modify.
In the Modify Security Group dialog, click Add to add any required entries to permit ssh access.
Click OK.
Configure an Elastic IP address for the VM:
Go to Compute > Instances, and select the VM instance.
On the top toolbar, select More > Attach > Elastic IP.
In the Attach Elastic IP dialog, allocate an IP address.
In Compute > Instances, click the VM instance’s link in the Name column.
In the VM’s Subnets section, note its Elastic IP address, or copy it to the clipboard.
Connect to the VM instance via
ssh
, as the userfedora
: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 88. "' 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 >
Adaptive-Table Output Format Modifiers¶
The Adaptive-Table Output Format is Symp’s CLI default output format.
It is sensitive to the terminal width and supports hierarchical data structures and the filtering of rows and columns.
Usage¶
$ symp command [argument [argument...]] [--flag] [-m modifier [modifier...]]
Filter Modifiers¶
By default, symp displays all rows and columns.
To restrict the output to a select population of rows, columns, or both, apply filter modifiers to the symp command.
Note
Multiple filter modifiers can be applied to a single symp command.
Multiple filter modifiers are processed in the following order:
grep*
head
tail
columns
Filter Modifier |
Description |
---|---|
|
Usage: Displays only those rows containing a value that matches the pattern. The matching value is case-sensitive. The pattern can be any regular expression. For example:
Note: The values are searched recursively. |
|
Usage: Same as |
|
Usage: Displays all rows except those containing any values that match the pattern. The matching value is case-sensitive. The pattern can be any regular expression. For example:
|
|
Usage: Same as |
|
Usage: Displays only the first n rows. |
|
Usage: Displays only the last n rows. Thus, if a table has 20 rows, the modifier Note: tail is processed after head regardless of their order in the command. |
|
Usage: Displays only those columns whose headers match the pattern. The matching value is case-sensitive. The pattern can be any regular expression. Note: The columns modifier is processed after the
|
Display Modifiers¶
To customize the output style, apply display modifiers to the symp command to override the default output style settings.
Note
The display modifiers split-table
, force-frames
, and
horizontal-lines
are boolean settings, with the following valid values:
true
,t
yes
,y
false
,f
no
,n
All boolean values are case-insensitive.
Display Modifier |
Description |
---|---|
|
Usage: Splits output into multiple, terminal-width tables, each containing some of the columns. Default: |
|
Usage: Displays the columns according to a comma-separated list of column headers. The unlisted columns are displayed after the listed ones in alphabetical order. Default: |
|
Usage: Displays frames around all sub-tables. Default: |
|
Usage: Displays horizontal lines between each row. Horizontal lines are normally only drawn if either the row above or below is split into multiple lines. Default: |
|
Usage: Determines whether to split words when displaying cell values that are longer than their cell width. There are four policies:
|
|
Usage: Sets the width of the terminal to Default: auto-detected value. |
Symp CLI Reference Guide¶
Note
The Symp CLI parameters domain_name
and domain_id
are known as
Account Name and Account ID respectively, in zCompute’s UI.