Overview

The Spectro CLI tool is a command-line interface for the Spectro Cloud Pack Registry server to upload or download the packs using commands.

Prerequisites

• A custom pack registry server must be up and running.

Installation

The Spectro CLI tool is currently available for OSX and Linux.

1. Download the CLI binary file:

   OSX

   wget https://software.spectrocloud.com/spectro-registry/cli/v4.0.1/osx/spectro

   Linux

   wget https://software.spectrocloud.com/spectro-registry/cli/v4.0.1/linux/spectro

2. Provide the executable permission to the CLI spectro.

   chmod +x spectro

Global Arguments

List of Arguments available to all the Spectro CLI commands:

Global Flags

• List of Flags available to all the Spectro CLI commands:

  • h, --help - help for each command

Commands

LOGIN

LOGIN

Authenticate user with Spectro Cloud pack registry by using the login command:

Usage

 spectro registry login [SERVER]

Example

 spectro registry login spectro.io:5000

 spectro registry login spectro.io:5000 --insecure --default

Args

SERVER - Spectro Cloud pack registry server in the format [host:port]

Flags

-i, --insecure - Insecure is used when the pack registry is installed in HTTP or HTTPS with self-signed certificates.

-d, --default - Set the server as default Spectro Cloud pack registry for all the CLI commands.

Note: In case of HTTPS, if you have access to the pack registry's CA certificate, there is no need for the insecure flag; simply place the CA certificate at /etc/spectro/certs.d/[SERVER]/ca.crt.

PUSH

PUSH

Upload the pack content from the pack source dir to the Spectro Cloud pack registry.

Usage

 spectro pack push [PACK_SOURCE_DIR] [flags]

Example

 spectro pack push /tmp/packs/nginx-1.16.1

 spectro pack push /tmp/packs/nginx-1.16.1 --registry-server spectro.io:5000

 spectro pack push /tmp/packs/nginx-1.16.1 --force --message "updated nginx pack values"

Args

PACK_SOURCE_DIR: Directory location where pack content is located.

Flags

-r, --registry-server string - To override the default Spectro Cloud pack registry

-f, --force - If a pack with the same tag already exists in the registry, then the force option can be used to overwrite the pack contents in the registry.

-m, --message - A short description about the pack changes. It is mandatory to set this flag when the force option is enabled.

--skip-digest-check - By default, the force option can push the pack only if the pack content digest is different than the registry pack digest. So the skip digest command can be used to skip the comparison of the digests.

LIST

LIST

List all the packs from the Spectro Cloud pack registry:

Usage

 spectro pack ls [flags]

Example

 spectro pack ls spectro.io:5000

 spectro pack ls spectro.io:5000 --name ubuntu --registry-server spectro.io:5000

Flags

-n, --name string - packs can be filtered by pack name

-r, --registry-server string - To override the default Spectro Cloud pack registry

PULL

PULL

Download the packs from the Spectro Cloud pack registry to a pack target location:

Usage

 spectro pack pull NAME[:TAG|@DIGEST] TARGET_DIR [flags]

Example

 spectro pack pull nginx:1.16.1 /tmp/packs

 spectro pack pull nginx@sha256:5269f073ac8e3c2536270b496ca1cc537e32e44186a5a014b8c48cddca3c6e87 /tmp/packs --registry-server spectro.io:5000

Args

PACK_NAME: TAG|@DIGEST - Name of the pack for a particular tag or a sha digest.

PACK_TARGET_DIR - Directory location where pack content will be pulled.

Flags

-r, --registry-server string - To override the default Spectro Cloud pack registry.

ADD

ADD (Add a Tag)

Create a new tag to a pack which is already pushed to the Spectro Cloud pack registry:

Usage

 spectro pack tag add SOURCE_PACK:TAG TARGET_LABEL [flags]

Example

 spectro pack tag add ubuntu:lts__14.4.3 stable

 spectro pack tag add ubuntu:lts__14.4.3 14.4.3-beta -g lts -r spectro.io:5000

Note: Tag is a combination of label and the group name. The label is mandatory whereas the group is optional.

tag → <group>__<label>

Ex. lts___14.4.3 : lts → group, 14.4.3 → label

Args

PACK_NAME: TAG - Name of the pack for a particular tag to which a new tag will be created.

TARGET_LABEL - Target tag label.

Flags

-g, --group string - Target tag group.

-r, --registry-server string - To override the default Spectro Cloud pack registry.

DELETE

DELETE (Delete a tag)

Delete a tag to a pack that is already pushed to the Spectro Cloud pack registry.

Usage

 spectro pack tag delete PACK:TAG [flags]

Example

 spectro pack tag delete ubuntu:14.4.3

 spectro pack tag delete ubuntu:14.4.3 -r spectro.io:5000

Note: Parent tags like major version (Ex: 14.x) and minor version (Ex: 14.4.x) can not be deleted as these are auto-generated by the system. So, when no tags are associated with the pack then these are auto-deleted by the system. When a tag (Ex: 14.4.3) is deleted then the major and minor version tags are auto-linked to the remaining tags of a pack.

Args

PACK_NAME: TAG - Pack name and Tag which needs to be deleted.

Flags

-r, --registry-server string - To override the default Spectro Cloud pack registry.

VERSION

VERSION

Check the version of the Spectro CLI that is currently installed.

 spectro  version
Spectro ClI Version 4.0.1 linux/amd64