Cloud Search Service (CSS)¶

The CSS client is the command-line interface (CLI) for the Cloud Search Service (CSS) API and its extensions.

For help on a specific css command, enter:

$ openstack css help SUBCOMMAND

CSS Cluster Operations¶

css cluster add nodes¶

Add master and client nodes to a cluster.

openstack css cluster add nodes
    --node-type <node_type>
    --flavor <flavor>
    --node-size <node_size>
    --volume-type
    {ULTRAHIGH,COMMON,HIGH}
    [--wait]
    [--timeout <timeout>]
    <cluster>

--node-type <node_type>¶: Node type.

--flavor <flavor>¶: Flavor ID.

--node-size <node_size>¶: Number of nodes.

--volume-type {ULTRAHIGH,COMMON,HIGH}¶: Node storage type.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster create¶

Create a new CSS cluster instance.

openstack css cluster create
    [--datastore-type {elasticsearch, opensearch}]
    [--datastore-version <datastore_version>]
    [--availability-zone <availability_zone>]
    --flavor <flavor>
    [--num-nodes <num_nodes>]
    [--volume-size <volume_size>]
    [--volume-type {common,high,ultrahigh}]
    --router-id <router_id>
    --network-id <network_id>
    --security-group-id <security_group_id>
    [--https-enable]
    [--cmk-id <cmk_id>]
    [--admin-pwd <admin_pwd>]
    [--backup-policy period=<period>,prefix=<prefix>,keepday=<keepday>]
    [--tag key=<key>,value=<value>]
    [--wait]
    [--timeout <timeout>]
    <name>

--datastore-type {elasticsearch, opensearch}¶: Cluster type. Values: - elasticsearch - opensearch The default value is elasticsearch.

--datastore-version <datastore_version>¶: CSS Cluster Engine Versions. If datastore_type is elasticsearch supported versions: (7.6.2, 7.9.3, 7.10.2) If datastore_type is opensearch supported versions: (1.3.6) (default datastore_version: 7.10.2).

--availability-zone <availability_zone>¶: Separate multiple AZs with commas (,), for example, az1,az2. AZs must be unique. The number of nodes must be greater than or equal to the number of AZs.

--flavor <flavor>¶: Cluster Instance flavor.

--num-nodes <num_nodes>¶: Number of clusters nodes. The value range is 1 to 32. (default value: 1)

--volume-size <volume_size>¶: Size of the instance disk volume in GB. (default value: 40)

--volume-type {common,high,ultrahigh}¶: Volume type. Supported types: COMMON, HIGH, ULTRAHIGH. (default value: COMMON)

--router-id <router_id>¶: Router ID.

--network-id <network_id>¶: Network ID.

--security-group-id <security_group_id>¶: Security group ID.

--https-enable¶: Whether communication is encrypted on the cluster.

--cmk-id <cmk_id>¶: Encryption Key Id. The system encryption is used or cluster encryption.The Default Master Keys cannot be used to create grants.

--admin-pwd <admin_pwd>¶: Password of the cluster user admin in security mode.

--backup-policy period=<period>,prefix=<prefix>,keepday=<keepday>¶: Automatic backup creation policy. This function is enabled by default. The following keys are required: period=<period>: Time when a snapshot is created every day. prefix=<prefix>: Prefix of the name of the snapshot that is automatically created. keepday=<keepday>: Number of days for which automatically created snapshots are reserved. Value range: 1 to 90. Optional Keys: bucket=<bucket>: OBS bucket used for storing backup. basepath=<basepath>: Storage path of the snapshot in the OBS bucket. agency=<agency>: IAM agency used to access OBS.

--tag key=<key>,value=<value>¶: key=<key>: Tag key. The value can contain 1 to 36 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed. value=<value>: Tag value. The value can contain 0 to 43 characters. Only digits, letters, hyphens (-) and underscores (_) are allowed.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

name¶: Cluster Name.

This command is provided by the otcextensions plugin.

css cluster delete¶

Delete CSS Cluster(s)

openstack css cluster delete <cluster> [<cluster> ...]

cluster¶: ID or Name of the CSS cluster(s) to be deleted.

This command is provided by the otcextensions plugin.

css cluster extend¶

Scaling Out a Cluster’s with only Common Nodes.

openstack css cluster extend
    --add-nodes <add_nodes>
    [--wait]
    [--timeout <timeout>]
    <cluster>

--add-nodes <add_nodes>¶: Number of css nodes to be scaled out.

--wait¶: Wait for Cluster Scaling Task to complete.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: ID or Name of the CSS cluster to be extended.

This command is provided by the otcextensions plugin.

css cluster extend nodes¶

Scaling Out a Cluster with Special Nodes.

openstack css cluster extend nodes
    --extend type
    =<type>,nodesize=<nodesize>,disksize=<disksize>
    [--wait]
    [--timeout <timeout>]
    <cluster>

--extend type=<type>,nodesize=<nodesize>,disksize=<disksize>¶: Extend Cluster Nodes.Type: ess, ess-cold, ess-master, and ess-client. For type: ess-master and ess-client disksize cannot be extended. Examples: –extend type=ess,disksize=60,nodesize=2 –extend type=ess-master,disksize=0,nodesize=2

--wait¶: Wait for Cluster Scaling Task to complete.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: ID or Name of the CSS cluster to be extended.

This command is provided by the otcextensions plugin.

css cluster list¶

List CSS Clusters.

openstack css cluster list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

This command is provided by the otcextensions plugin.

css cluster nodes list¶

List CSS Cluster Nodes.

openstack css cluster nodes list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <cluster>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster replace node¶

Replace a node in the cluster.

openstack css cluster replace node
    --node-id <nodes_id>
    [--wait]
    [--timeout <timeout>]
    <cluster>

--node-id <nodes_id>¶: IDs of the node to be replaced.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster restart¶

Restart a CSS cluster

openstack css cluster restart [--wait] [--timeout <timeout>] <cluster>

--wait¶: Wait for Cluster to Restart.

--timeout <timeout>¶: Timeout for the wait in seconds (default 300 seconds).

cluster¶: ID or Name of the CSS cluster to be restart.

This command is provided by the otcextensions plugin.

css cluster retry upgrade job¶

Retry a task or terminate the impact of a task.

openstack css cluster retry upgrade job
    --job-id <job_id>
    [--retry-mode <retry_mode>]
    [--wait]
    [--timeout <timeout>]
    <cluster>

--job-id <job_id>¶: ID of the task to be retried.

--retry-mode <retry_mode>¶

If this parameter is not left blank,: the impact of the task is terminated.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster scale in¶

Scale in a cluster by removing specified nodes.

openstack css cluster scale in
    --nodes <nodes>
    [<nodes> ...]
    [--wait]
    [--timeout <timeout>]
    <cluster>

--nodes <nodes>¶: IDs of the nodes to remove.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster scale in node type¶

Remove instances of specific types.

openstack css cluster scale in node type
    [--ess <reduce_num>]
    [--ess-master <reduce_num>]
    [--ess-client <reduce_num>]
    [--ess-cold <reduce_num>]
    [--wait]
    [--timeout <timeout>]
    <cluster>

--ess <reduce_num>¶: Reduce the ess nodes.

--ess-master <reduce_num>¶: Reduce the ess-master nodes.

--ess-client <reduce_num>¶: Reduce the ess-client nodes.

--ess-cold <reduce_num>¶: Reduce the ess-cold nodes.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster show¶

Show details of a CSS cluster

openstack css cluster show <cluster>

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster update flavor¶

Modify the specifications of a cluster.

openstack css cluster update flavor
    [--node-type {ess,ess-cold,ess-client,ess-master}]
    --flavor <flavor>
    [--check-replica]
    [--wait]
    [--timeout <timeout>]
    <cluster>

--node-type {ess,ess-cold,ess-client,ess-master}¶: Type of the node to modify.

--flavor <flavor>¶: ID of the new flavor.

--check-replica¶: Indicates whether to verify replicas.

--wait¶: Wait for Cluster.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster update kernel¶

Upgrade cluster version.

openstack css cluster update kernel
    [--target-image-id <target_image_id>]
    --upgrade-type
    {same,cross,cross-engine}
    [--check-backup-indices]
    --agency <agency>
    [--check-cluster-load]
    <cluster>

--target-image-id <target_image_id>¶: ID of the target image version.

--upgrade-type {same,cross,cross-engine}¶: Upgrade type.

--check-backup-indices¶: ID of the target image version.

--agency <agency>¶: Agency name.

--check-cluster-load¶: Indicates whether to verify the load.

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster update name¶

Change the name of a cluster.

openstack css cluster update name --new-name <new_name> <cluster>

--new-name <new_name>¶: New cluster name.

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster update password¶

Change the password of a cluster.

openstack css cluster update password
    --new-password <new_password>
    <cluster>

--new-password <new_password>¶: New password.

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster update security group¶

Change the security group after a cluster is created

openstack css cluster update security group
    --security-group <security_group>
    <cluster>

--security-group <security_group>¶: New security group id or name.

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster update security mode¶

Change the security mode of a cluster.

openstack css cluster update security mode
    [--authority-enable]
    [--admin-pwd <admin_pwd>]
    [--https-enable]
    <cluster>

--authority-enable¶: Indicates whether to enable the security mode.

--admin-pwd <admin_pwd>¶: Cluster password in security mode.

--https-enable¶: Indicates whether to enable HTTPS.

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster upgrade status¶

List CSS Cluster Nodes.

openstack css cluster upgrade status
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    <cluster>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

css cluster version upgrades list¶

List available upgradable versions.

openstack css cluster version upgrades list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    --upgrade-type
    {same,
    cross}
    <cluster>

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

--upgrade-type {same, cross}¶: Version type.

cluster¶: Cluster name or ID.

This command is provided by the otcextensions plugin.

CSS Snapshot Operations¶

css snapshot configure¶

Set Basic Configurations of a CSS Cluster Snapshot.

openstack css snapshot configure
    [--auto-configure]
    [--backup-path <backup_path>]
    [--bucket <bucket>]
    [--agency <agency>]
    [--cmk-id <cmk_id>]
    <cluster>

--auto-configure¶: Set Snapshot Configuration Automatically.

--backup-path <backup_path>¶: Storage path of the snapshot in the OBS bucket.

--bucket <bucket>¶: OBS bucket used for index data backup.

--agency <agency>¶: IAM agency used to access OBS.

--cmk-id <cmk_id>¶: Key ID used for snapshot encryption.

cluster¶: ID or Name of the cluster to which the snapshot belongs.

This command is provided by the otcextensions plugin.

css snapshot create¶

Create a Manual CSS snapshot.

openstack css snapshot create
    [--description <description>]
    [--indices <indices>]
    [--wait]
    [--timeout <timeout>]
    <cluster>
    <name>

--description <description>¶: Description of a snapshot.

--indices <indices>¶: Name of the index to be backed up. Multiple index names are separated by commas.

--wait¶: Wait for Cluster to Restart.

--timeout <timeout>¶: Timeout for the wait in seconds (default: 600 seconds).

cluster¶: Specify ID or Name of the CSS cluster from where index data is to be backed up.

name¶: Snapshot name.

This command is provided by the otcextensions plugin.

css snapshot delete¶

Delete CSS Cluster Snapshot(s).

openstack css snapshot delete <cluster> <snapshot> [<snapshot> ...]

cluster¶: ID or Name of the cluster to which the snapshot belongs.

snapshot¶: ID(s) of the snapshot(s) to be deleted.

This command is provided by the otcextensions plugin.

css snapshot disable¶

Disable the snapshot creation function.

openstack css snapshot disable <cluster>

cluster¶: ID or Name of the cluster to which the snapshot belongs.

This command is provided by the otcextensions plugin.

css snapshot list¶

List CSS Backups

openstack css snapshot list
    [--sort-column SORT_COLUMN]
    [--sort-ascending | --sort-descending]
    cluster

--sort-column SORT_COLUMN¶: specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated

--sort-ascending¶: sort the column(s) in ascending order

--sort-descending¶: sort the column(s) in descending order

cluster¶: Specifies the ID or Name of the CSS Cluster.

This command is provided by the otcextensions plugin.

css snapshot policy set¶

Setting the Automatic Snapshot Creation Policy.

openstack css snapshot policy set
    --name-prefix <name_prefix>
    [--period <period>]
    --keep-days <keep_days>
    [--disable]
    [--delete-auto]
    <cluster>

--name-prefix <name_prefix>¶: Prefix of the snapshot name that is automatically created.

--period <period>¶: Time when a snapshot is created every day. Time format is followed by the time zone HH:mm z. For example, 00:00 GMT+08:00 and 01:00 GMT+08:00. (Default Value: 01:00 GMT+01:00)

--keep-days <keep_days>¶: Number of days that a snapshot can be retained.

--disable¶: Disable the automatic snapshot creation policy.

--delete-auto¶: Whether to delete all automatically created snapshots when the automatic snapshot creation policy is disabled.Value is true or false. Default vaule is false

cluster¶: ID or Name of the cluster to which the snapshot belongs.

This command is provided by the otcextensions plugin.

css snapshot policy show¶

Show details of a CSS cluster backup policy.

openstack css snapshot policy show <cluster>

cluster¶: ID or Name of the cluster to which the snapshot belongs.

This command is provided by the otcextensions plugin.

css snapshot restore¶

Restore the CSS cluster using the specified snapshot

openstack css snapshot restore
    --target-cluster <target_cluster>
    [--indices <indices>]
    [--rename-pattern <rename_pattern>]
    [--rename-replacement <rename_replacement>]
    [--wait]
    [--timeout <timeout>]
    <cluster>
    <snapshotId>

--target-cluster <target_cluster>¶: ID or Name of the cluster, to which the snapshot is to be restored.

--indices <indices>¶: Name of the index to be restored. Multiple index names are separated by commas (,).

--rename-pattern <rename_pattern>¶: Rule for defining the indices to be restored. The value contains a maximum of 1,024 characters.

--rename-replacement <rename_replacement>¶: Rule for renaming an index. The value contains 0 to 1,024 characters.

--wait¶: Wait for Cluster to Restart.

--timeout <timeout>¶: Timeout for the wait in seconds (default 1200 seconds).

cluster¶: Cluster ID or Name to which the snapshot belongs.

snapshotId¶: The snapshot ID.

This command is provided by the otcextensions plugin.

css snapshot show¶

Show details of a CSS cluster

openstack css snapshot show <cluster> <snapshot>

cluster¶: Cluster name or ID.

snapshot¶: Snapshot name or ID.

This command is provided by the otcextensions plugin.

last updated: UTC - commit: