Confluent Cloud Basics
This topic describes some common Confluent Cloud tasks, such as adding and deleting clusters,
changing your password, viewing your billing information, and more.
Note
If you are using Confluent Cloud Enterprise and need to add or delete clusters,
contact your account representative.
Monitor Cluster Activity
You can monitor cluster activity and usage from the cluster landing page within
each of your environments.
View and Change Cluster Settings
You can view and edit cluster properties in the
Cluster settings page Kafka tab. View the cloud type, provider, region, and zone
availability details.
Tip
Hover on the Cluster ID or Bootstrap server properties to access
a Copy to clipboard button for your convenience. Paste these details
when you are configuring, running commands, or troubleshooting your cluster.
Edit a cluster name
You can edit the cluster name and view the provider, region, zone availability, and other details.
Note
Dedicated cluster names currently cannot be changed.
From the cluster navigation bar, click the cluster name abbreviation and then
the Cluster settings menu. The Cluster settings page opens to the Kafka tab.
Click Change settings.
Edit the cluster name in Cluster Name field and click Save. You cannot change any other value.
You are prompted to confirm the changes.
Delete Cluster
Note
Applicable to Confluent Cloud only. If you’re using Confluent Cloud Enterprise, contact
your account representative.
From the cluster navigation bar, click the cluster name abbreviation and then
the Cluster settings menu. The Cluster settings page opens to the Kafka tab.
Click Change settings.
Click Delete.
You are prompted to confirm the deletion.
Install the Confluent Cloud CLI
You can use the Confluent Cloud CLI to administer your Confluent Cloud cluster. The Confluent Cloud CLI is supported for macOS, Microsoft Windows, and Linux operating systems.
Important
- The Confluent Cloud CLI only supports basic produce or consume operations. For example, you cannot pass in a
properties file using the Confluent Cloud CLI. This means you cannot set other
configuration properties or produce with keys. For advanced produce or consume operations, use the
Confluent CLI
confluent local produce
and
confluent local consume
commands with the --cloud --config <path-to-file>
flag.
- The Confluent Cloud CLI requires users to log in with a Confluent Cloud user account.
- All Confluent Cloud CLI traffic is https.
Scripted installation
Run this command to install the Confluent Cloud CLI. This command creates a bin
directory in your designated
location (<path-to-directory>/bin
). On Windows, an appropriate Linux environment may need to be installed
in order to have the curl
and sh
commands available, such as the
Windows Subsystem for Linux.
Important
The CLI installation location must be in your PATH (e.g. /usr/local/bin
).
curl -L --http1.1 https://cnfl.io/ccloud-cli | sh -s -- -b /<path-to-directory>/bin
Tarball installation
Download and install the raw binaries by platform.
Next steps
Run this command to log in to your Confluent Cloud cluster.
Your output should resemble:
Enter your Confluent credentials:
Email: jdoe@myemail.io
Password:
Logged in as jdoe@myemail.io
Using environment t118 ("default")
Run this command to view your cluster.
ccloud kafka cluster list
Your output should resemble:
Id | Name | Provider | Region | Durability | Status
+-------------+-------------------+----------+-------------+------------+--------+
lkc-emmox | My first cluster | gcp | us-central1 | LOW | UP
lkc-low0y | My second cluster | gcp | us-central1 | LOW | UP
Run this command to designate the active cluster.
ccloud kafka cluster use lkc-emmox
Verify installation by typing ccloud
in your terminal.
You should see Confluent Cloud CLI usage information:
Welcome to the Confluent Cloud CLI
Usage:
ccloud [command]
Available Commands:
api-key Manage API keys
completion Output shell completion code
environment Manage and select ccloud environments
help Help about any command
kafka Manage Kafka
login Login to Confluent Cloud
logout Logout of Confluent Cloud
service-account Manage service accounts
update Update ccloud
version Print the ccloud version
Flags:
-h, --help help for ccloud
-v, --verbose count increase output verbosity
--version version for ccloud
Connect Confluent Cloud CLI to a Cluster.
Change Password
From the Administration menu, click Settings -> Password.
Enter your Current password, New password, and click Save.
Tip
You can also access the Update password tab by clicking the Users
menu -> Your account link.
View Bill and Organization ID
From the Administration menu, click Billing & payment. The Billing
page shows current accrued charges by selected environment and time period
(year and month).
Click the Payment details & contacts tab to obtain your Cloud Organization ID, edit your billing
information, add an address for tax purposes, or claim a Promo Code.
For more information, see the billing page.