clc viridian

This command group provides commands for doing various operations on Hazelcast Viridian Cloud, such as creating and managing clusters.

All commands except viridian login require the generation of a token using an API key and secret, which you can retrieve from the Viridian Cloud console. Running viridian login prompts you for this information, and creates and saves the token.

Usage:

clc viridian [command] [options]

Logs in to Viridian Cloud 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

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, an input prompt is shown.
`--api-secret`	Optional	Sets the API secret. Overrides the `CLC_VIRIDIAN_API_SECRET` environment variable. If not given, an input prompt is shown.

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, an input prompt is shown.

--api-secret

Optional

Sets the API secret. Overrides the CLC_VIRIDIAN_API_SECRET environment variable. If not given, an input prompt is shown.

clc viridian create-cluster

Creates a Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian create-cluster [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.
`--name`	Optional	Sets the name of the created cluster. If not given, an auto-generated name will be used.
`--development`	Optional	Creates a development cluster.
`--prerelease`	Optional	Creates the cluster with a prerelease image.

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

--name

Optional

Sets the name of the created cluster. If not given, an auto-generated name will be used.

--development

Optional

Creates a development cluster.

--prerelease

Optional

Creates the cluster with a prerelease image.

clc viridian get-cluster

Gets the information about the given Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian get-cluster [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

clc viridian list-clusters

Lists all Viridian Cloud clusters for the logged in API key.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian list-clusters [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

clc viridian stop-cluster

Stops the given Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian stop-cluster [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.
`--wait`	Optional	Waits for the cluster to be stopped.	`false`

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

--wait

Optional

Waits for the cluster to be stopped.

false

clc viridian resume-cluster

Resumes the given Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian resume-cluster [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.
`--wait`	Optional	Waits for the cluster to be resumed.	`false`

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

--wait

Optional

Waits for the cluster to be resumed.

false

clc viridian delete-cluster

Deletes the given Viridian Cloud cluster. All data in the cluster is deleted irreversibly.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian delete-cluster [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.
`--yes`	Optional	Skips confirming the delete operation.
`--wait`	Optional	Waits for the cluster to be deleted.	`false`

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

--yes

Optional

Skips confirming the delete operation.

--wait

Optional

Waits for the cluster to be deleted.

false

clc viridian download-logs

Downloads the logs of the given Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian download-logs [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.
`--output-dir -o`	Optional	Output directory for the log files, if not given current directory is used.

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

--output-dir -o

Optional

Output directory for the log files, if not given current directory is used.

clc viridian stream-logs

Outputs the logs of the given Viridian Cloud cluster as a stream.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

The log format may be one of:

minimal: Only the log message
basic: Time, level and the log message
detailed: Time, level, thread, logger and the log message
free form template, see: https://pkg.go.dev/text/template for the format. You can use the following placeholders: msg, level, time, thread and logger. Usage:

clc viridian stream-logs [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.
`--log-format`	Optional	Format of log lines. Either a predefined or free form format.	`basic`

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

--log-format

Optional

Format of log lines. Either a predefined or free form format.

basic

clc viridian import-config

Imports the connection configuration of the given Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc import-config [cluster-name/cluster-ID] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--api-key`	Optional	Sets the API key. Overrides the `CLC_VIRIDIAN_API_KEY` environment variable. If not given, one of the existing API keys will be used.

--api-key

Optional

Sets the API key. Overrides the CLC_VIRIDIAN_API_KEY environment variable. If not given, one of the existing API keys will be used.

clc viridian list-custom-classes

Lists all custom classes in the Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian list-custom-classes [cluster-name/cluster-ID] [flags]

Parameters:

Parameter Required Description Default

Parameter	Required	Description	Default
`--verbose`	Optional	Prints additional column `Temporary Custom Classes ID`

--verbose

Optional

Prints additional column Temporary Custom Classes ID

clc viridian upload-custom-class

Uploads a custom class to the Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian 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 Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian 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

Parameter	Required	Description	Default
`--output-path`	Optional	Output path for the downloaded artifact. The base directory of the path is created recursively if it doesn’t exist.

--output-path

Optional

Output path for the downloaded artifact. The base directory of the path is created recursively if it doesn’t exist.

clc viridian delete-custom-class

Deletes a custom class from the Viridian Cloud cluster.

Make sure you authenticate to the Viridian Cloud API using viridian login before running this command.

Usage:

clc viridian delete-custom-class [cluster-name/cluster-ID] [file-name/artifact-ID] [flags]