Copy page

Commands

Documentation for `scw kafka`

This API allows you to manage your Clusters for Apache Kafka®.

Cluster management commands

A Kafka cluster is composed of one or multiple dedicated compute nodes running a single Kafka broker.

Create a Kafka cluster

Create a new Kafka cluster.

Usage:

Code
scw kafka cluster create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
project-id	Project ID to use. If none is passed the default project ID will be used
name	Name of the Kafka cluster	Default: <generated>
version	Version of Kafka	Required
tags.{index}	Tags to apply to the Kafka cluster
node-amount	Number of nodes to use for the Kafka cluster	Required
node-type	Type of node to use for the Kafka cluster	Required
volume.size-bytes	Volume size
volume.type	Type of volume where data is stored	One of: unknown_type, sbs_5k, sbs_15k
endpoints.{index}.public-network
endpoints.{index}.private-network.private-network-id	UUID of the Private Network
user-name	Username for the kafka user
password	Password for the kafka user
multi-az	MultiAZ tell the cluster is deployed on multiple availability zones in the region.
mono-az.zone	Zone is the zone on which the cluster nodes are deployed.
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Delete a Kafka cluster

Delete a given Kafka cluster, specified by the region and cluster_id parameters. Deleting a Kafka cluster is permanent, and cannot be undone. Note that upon deletion all your data will be lost.

Usage:

Code
scw kafka cluster delete <cluster-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	UUID of the Kafka Cluster to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Get a Kafka cluster

Retrieve information about a given Kafka cluster, specified by the region and cluster_id parameters. Its full details, including name, status, IP address and port, are returned in the response object.

Usage:

Code
scw kafka cluster get <cluster-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	UUID of the Kafka Cluster	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Get a Kafka cluster's certificate authority

Retrieve certificate authority for a given Kafka cluster, specified by the region and cluster_id parameters. The response object contains the certificate in PEM format. The certificate is required to validate the sever from the client side during TLS connection.

Usage:

Code
scw kafka cluster get-ca <cluster-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	UUID of the Kafka Cluster	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

List Kafka clusters

List all Kafka clusters in the specified region. By default, the clusters returned in the list are ordered by creation date in ascending order, though this can be modified via the order_by field. You can define additional parameters for your query, such as tags and name. For the name parameter, the value you include will be checked against the whole name string to see if it includes the string you put in the parameter.

Usage:

Code
scw kafka cluster list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
tags.{index}	List Kafka cluster with a given tag
name	Lists Kafka clusters that match a name pattern
order-by	Criteria to use when ordering Kafka cluster listings	One of: created_at_asc, created_at_desc, name_asc, name_desc, status_asc, status_desc
project-id	Project ID
organization-id	Organization ID of the Kafka cluster
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Renew the Kafka cluster's certificate authority

Request to renew the certificate authority for a given Kafka cluster, specified by the region and cluster_id parameters. The certificate authority will be renewed within a few minutes.

Usage:

Code
scw kafka cluster renew-ca <cluster-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	UUID of the Kafka Cluster	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Update a Kafka cluster

Update the parameters of a Kafka cluster.

Usage:

Code
scw kafka cluster update <cluster-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	UUID of the Kafka Clusters to update	Required
name	Name of the Kafka Cluster
tags.{index}	Tags of a Kafka Cluster
version	Version of Kafka
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Endpoints management commands

Cluster endpoints enable connection to your cluster.

Create a new Kafka cluster endpoint

Create a new endpoint for a Kafka cluster. You can add public_network or private_network specifications to the body of the request. Note that currently only private_network is supported.

Usage:

Code
scw kafka endpoint create <cluster-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	UUID of the Kafka Cluster	Required
endpoint.public-network
endpoint.private-network.private-network-id	UUID of the Private Network
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Delete a Kafka cluster endpoint

Delete the endpoint of a Kafka cluster. You must specify the endpoint_id parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.

Usage:

Code
scw kafka endpoint delete <endpoint-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
endpoint-id	UUID of the endpoint to delete	Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Node types management commands

Two node type ranges are available:

• Shared: a complete and highly reliable node range with shared resources, made for scaling from development to production needs, at affordable prices.
• Dedicated: Kafka nodes with dedicated vCPU for the most demanding workloads and mission-critical applications.

List available node types

List available node types.

Usage:

Code
scw kafka node-type list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
include-disabled-types	Defines whether or not to include disabled types
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Kafka users management commands

Kafka users enable authentication to your cluster.

List kafka resources

List kafka resources.

Usage:

Code
scw kafka users list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by		One of: name_asc, name_desc
name
cluster-id		Required
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all

Update kafka resources

Update kafka resources.

Usage:

Code
scw kafka users update [arg=value ...]

Arguments:

Name	Description	Argument Specifications
cluster-id	ID of the cluster in which to update the user's password	Required
username	Username of the Kafka cluster user	Required
password	New password for the Kafka cluster user
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par

Kafka version management commands

A version of Apache Kafka®.

List Kafka versions

List all available versions of Kafka at the current time.

Usage:

Code
scw kafka version list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
version	Kafka version to filter for
region	Region to target. If none is passed will use default region from the config	Default: fr-par One of: fr-par, all