clc viridian
This command group provides commands for doing various Viridian operations, such as creating and managing clusters.
All commands except viridian login
requires a token to be generated using an API key and secret which can be retrieved from Viridian Console. Running viridian login
prompts this information, and creates and saves the token.
Usage:
clc viridian [command] [options]
clc viridian login
Logs in to Viridian using the given API key and API secret and retrieves a token. The token is cached to be used by other commands. If not specified, the key and the secret will be asked in a prompt.
Alternatively, you can use the following environment variables:
-
CLC_VIRIDIAN_API_KEY
-
CLC_VIRIDIAN_API_SECRET
Usage:
clc viridian login [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
|
|
Optional |
Sets the API secret. Overrides the |
clc viridian list-cluster-types
Lists available cluster types that can be used while creating a Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian list-cluster-types [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
clc viridian create-cluster
Creates a Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian create-cluster [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
|
|
Optional |
Sets the name of the created cluster. If not given, an auto-generated name will be used. |
|
|
Optional |
Sets the cluster-type for the created cluster. |
|
|
Optional |
Sets the version of the Hazelcast cluster to be created. |
clc viridian get-cluster
Gets the information about the given Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian get-cluster [cluster-ID/name] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
clc viridian list-clusters
Lists all Viridian clusters for the logged in API key.
Make sure you login before running this command.
Usage:
clc viridian list-clusters [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
clc viridian pause-cluster
Stops the given Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian pause-cluster [cluster-ID/name] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
clc viridian resume-cluster
Resumes the given Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian resume-cluster [cluster-ID/name] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
clc viridian delete-cluster
Deletes the given Viridian cluster. Note that, all data in the cluster is deleted irreversibly.
Make sure you login before running this command.
Usage:
clc viridian delete-cluster [cluster-ID/name] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
|
|
Optional |
Skips confirming the delete operation. |
clc viridian download-logs
Downloads the logs of the given Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian download-logs [cluster-ID/name] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
|
|
Optional |
Output directory for the log files, if not given current directory is used. |
clc viridian import-config
Imports connection configuration of the given Viridian cluster.
Make sure you login before running this command.
Usage:
clc import-config [cluster-name/cluster-ID] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Sets the API key. Overrides the |
clc viridian list-custom-classes
Lists all custom classes in the Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian list-custom-classes [cluster-name/cluster-ID] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Prints additional column |
clc viridian upload-custom-class
Uploads a custom class to the Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian upload-custom-class [cluster-name/cluster-ID] [file-name] [flags]
clc viridian download-custom-class
Downloads a custom class from the Viridian cluster.
Make sure you login before running this command.
Usage:
clc viridian download-custom-class [cluster-name/cluster-ID] [file-name/artifact-ID] [flags]
Parameters:
Parameter | Required | Description | Default |
---|---|---|---|
|
Optional |
Output path for the downloaded artifact. The base directory of the path is created recursively if it doesn’t exist. |