A newer version of Hazelcast CLC is available.

View latest

clc config

5.4.0 5.3.7 5.3.6 5.3.5 5.3.4 5.2.1

Configuration operations.

Usage:

clc config [command] [flags]

Commands

clc config add

Adds a named configuration with the given values. Specify the configurations as KEY=VALUE pairs.

It overwrites the previous configuration if it exists.

Usage:

clc config add [target] [source] [flags] [key=value...]

Configuration keys:

Key Value Default Value Note

cluster.name

Any string

dev

cluster.address

HOST:PORT / HOST / :PORT

localhost:5701

cluster.user

Any string

Hazelcast Enterprise only

cluster.password

Any string

Hazelcast Enterprise only

cluster.discovery-token

Any string

Cloud only

ssl.enabled

true / false

false

Cloud or Hazelcast Enterprise

ssl.server

DOMAIN_NAME (must match SSL certificate)

Cloud (automatically set) or Hazelcast Enterprise

ssl.skip-verify

true / false

false

Cloud or Hazelcast Enterprise. Disables SSL host name and client-side verification. Never set to true in production.

ssl.ca-path

An absolute or relative path

Cloud or Hazelcast Enterprise. Sets the path to the CA certificate.

ssl.key-path

An absolute or relative path

Cloud or Hazelcast Enterprise. Sets the path to the certificate key.

ssl.key-password

Any string

Cloud or Hazelcast Enterprise. Sets the password for the certificate key.

log.path

An absolute or relative path or stderr to log to stderr.

$CLC_HOME/logs/YYYY-MM-DD.log where the date is today.

log.level

One of:

  1. error

  2. warn

  3. info

  4. debug

info

Parameters:

Parameter Required Description Default

target

Required

Name of the configuration or its path. If a name is used, the configuration is saved to $CLC_HOME/configs/NAME

N/A

key=value

Optional

Zero or more config_item=value pairs.

N/A

Example output:

clc config add dev cluster.name=dev cluster.address=localhost:5701

clc config import

Imports configuration from an arbitrary source.

Currently importing only Cloud connection configuration is supported.

  1. On the Cloud console, visit:

    Dashboard → Connect Client → Quick connection guide → Go

  2. Copy the text in box 1 and pass it as the second parameter. Make sure the text is quoted before running:

    clc config import my-config "curl https://api.viridian.hazelcast.com ... default.zip"

Usage:

clc config import [configuration-name] [source] [flags]

Parameters:

Parameter Required Description Default

configuration-name

Required

Name of the configuration or its path. If a name is used, the configuration is saved to $CLC_HOME/configs/NAME

N/A

source

Required

The following configuration sources are supported:

  • Zip file for the Cloud Go client, e.g., hazelcast-cloud-go-sample-client-pr-3814-default.zip. Use this if you have downloaded the sample yourself.

  • cURL command line for the Cloud Go client sample, such as: curl https://api.viridian.hazelcast.com/client_samples/download/XXX -o hazelcast-cloud-go-sample-client-pr-3814-default.zip. Use this command to allow the Hazelcast CLC to download the sample. Do not forget to wrap the line with quotes.

N/A

Example output:

clc config import production ~/Downloads/hazelcast-cloud-go-sample-client-pr-3814-default.zip

clc config list

Lists the known configurations.

A known configuration is a directory at $CLC_HOME/configs that contains config.yaml. Directory names which start with dot (.) or underscore (_) are ignored.

Usage:

clc config list [flags]

Example output:

clc config list
default
production