A newer version of Hazelcast CLC is available.

View latest

clc cloud

5.5.0 5.4.1 5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

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

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

Usage:

clc cloud [command] [options]

Commands

clc cloud login

Logs in to 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_CLOUD_API_KEY

  • CLC_CLOUD_API_SECRET

Usage:

clc cloud login [flags]

Parameters:

Parameter Required Description Default

--api-key

Optional

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

--api-secret

Optional

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

clc cloud create-cluster

Creates a Cloud cluster.

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

Usage:

clc cloud create-cluster [flags]

Parameters:

Parameter Required Description Default

--api-key

Optional

Sets the API key. Overrides the CLC_CLOUD_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 cloud get-cluster

Gets the information about the given Cloud cluster.

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

Usage:

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

Parameters:

Parameter Required Description Default

--api-key

Optional

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

clc cloud list-clusters

Lists all Cloud clusters for the logged in API key.

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

Usage:

clc cloud list-clusters [flags]

Parameters:

Parameter Required Description Default

--api-key

Optional

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

clc cloud stop-cluster

Stops the given Cloud cluster.

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

Usage:

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

Parameters:

Parameter Required Description Default

--api-key

Optional

Sets the API key. Overrides the CLC_CLOUD_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 cloud resume-cluster

Resumes the given Cloud cluster.

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

Usage:

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

Parameters:

Parameter Required Description Default

--api-key

Optional

Sets the API key. Overrides the CLC_CLOUD_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 cloud delete-cluster

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

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

Usage:

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

Parameters:

Parameter Required Description Default

--api-key

Optional

Sets the API key. Overrides the CLC_CLOUD_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 cloud download-logs

Downloads the logs of the given Cloud cluster.

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

Usage:

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

Parameters:

Parameter Required Description Default

--api-key

Optional

Sets the API key. Overrides the CLC_CLOUD_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 cloud stream-logs

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

Make sure you authenticate to the Cloud API using cloud 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 cloud stream-logs [cluster-ID/name] [flags]

Parameters:

Parameter Required Description Default

--api-key

Optional

Sets the API key. Overrides the CLC_CLOUD_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 cloud import-config

Imports the connection configuration of the given Cloud cluster.

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

Usage:

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

Parameters:

Parameter Required Description Default

--api-key

Optional

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

clc cloud list-custom-classes

Lists all custom classes in the Cloud cluster.

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

Usage:

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

Parameters:

Parameter Required Description Default

--verbose

Optional

Prints additional column Temporary Custom Classes ID

clc cloud upload-custom-class

Uploads a custom class to the Cloud cluster.

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

Usage:

clc cloud upload-custom-class [cluster-name/cluster-ID] [file-name] [flags]

clc cloud download-custom-class

Downloads a custom class from the Cloud cluster.

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

Usage:

clc cloud download-custom-class [cluster-name/cluster-ID] [file-name/artifact-ID] [flags]

Parameters:

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.

clc cloud delete-custom-class

Deletes a custom class from the Cloud cluster.

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

Usage:

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

Help and support