Skip to content

Commit 61c1dcd

Browse files
tball-devtball-trimble
authored andcommitted
docs: update ccloud to confluent in docs and examples
1 parent 7c1c24c commit 61c1dcd

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

docs/confluent-cloud.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ This tool was designed to work with Confluent Cloud. It can manage service accou
66

77
Ensure you have installed `kafka-gitops` or are using the `kafka-gitops` docker image as described in the [installation][installation] instructions.
88

9-
You must have the `ccloud` command line tools installed if you wish to auto-populate the `principal` fields on services.
9+
You must have the `confluent` command line tool installed if you wish to auto-populate the `principal` fields on services.
1010

1111
## Desired State File
1212

1313
Create a basic desired state file, `state.yaml`, such as:
1414

1515
```yaml
1616
settings:
17-
ccloud:
17+
confluent:
1818
enabled: true
1919

2020
topics:
@@ -46,18 +46,18 @@ To use `kafka-gitops` with Confluent Cloud, you'll need to set a few environment
4646
* `KAFKA_SASL_MECHANISM`: `PLAIN`
4747
* `KAFKA_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM`: `HTTPS`
4848

49-
Additionally, you'll need to login to the `ccloud` tool. You can automate this by setting the following environment variables:
49+
Additionally, you'll need to login to the `confluent` tool. You can automate this by setting the following environment variables:
5050

51-
* `XX_CCLOUD_EMAIL`: Your Confluent Cloud administrator email
52-
* `XX_CCLOUD_PASSWORD`: Your Confluent Cloud administrator password
51+
* `CONFLUENT_CLOUD_EMAIL`: Your Confluent Cloud administrator email
52+
* `CONFLUENT_CLOUD_PASSWORD`: Your Confluent Cloud administrator password
5353

54-
Then, you can run `ccloud login` and it will run without a prompt. This is great for CI builds.
54+
Then, you can run `confluent login` and it will run without a prompt. This is great for CI builds.
5555

56-
You can optionally specify a path to a `ccloud` executable:
56+
You can optionally specify a path to a `confluent` executable:
5757

58-
* `CCLOUD_EXECUTABLE_PATH`: `/full/path/to/ccloud`
58+
* `CONFLUENT_EXECUTABLE_PATH`: `/full/path/to/confluent`
5959

60-
Otherwise, `ccloud` must be on your path.
60+
Otherwise, `confluent` must be on your path.
6161

6262
## Validate
6363

docs/quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Getting started with `kafka-gitops` is simple. For this tutorial, we will assume
55
- You have installed the `kafka-gitops` command as [described here](/installation.md).
66
- You have a kafka cluster running on `localhost:9092`.
77

8-
!> **NOTE**: If you desire to use this with Confluent Cloud, read our [Confluent Cloud page][ccloud].
8+
!> **NOTE**: If you desire to use this with Confluent Cloud, read our [Confluent Cloud page][confluent].
99

1010
## Desired State File
1111

@@ -147,7 +147,7 @@ org.apache.kafka.common.errors.PolicyViolationException: Topic replication facto
147147

148148
Congrats! You've successfully started using GitOps strategies to manage your cluster. If you have security on your cluster, read the [services][services] page to start defining services.
149149

150-
[ccloud]: /confluent-cloud.md
150+
[confluent]: /confluent-cloud.md
151151
[permissions]: /permissions.md
152152
[specification]: /specification.md
153153
[services]: /services.md

docs/specification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ The desired state file consists of:
1919

2020
**Options**:
2121

22-
- **ccloud** [Optional]: An object which contains an `enabled` field. Set this to true if using a Confluent Cloud cluster.
22+
- **confluent** [Optional]: An object which contains an `enabled` field. Set this to true if using a Confluent Cloud cluster.
2323
- **topics** [Optional]:
2424
- **defaults** [Optional]: Specify topic defaults so you don't need to specify them for every topic in the state file. Currently, only replication is supported.
2525
- **blacklist** [Optional]: Add a prefixed topic blacklist for ignoring specific topics when using `kafka-gitops`. This allows topics to be ignored from being deleted if they are not defined in the desired state file.
2626

2727
**Example**:
2828
```yaml
2929
settings:
30-
ccloud:
30+
confluent:
3131
enabled: true
3232
topics:
3333
defaults:

examples/confluent-cloud/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ The following environment variables need to be set locally or in the build job:
1313

1414
```bash
1515
# For service account creation / listing
16-
export XX_CCLOUD_EMAIL="Your Confluent Cloud email address"
17-
export XX_CCLOUD_PASSWORD="Your Confluent Cloud password"
16+
export CONFLUENT_CLOUD_EMAIL="Your Confluent Cloud email address"
17+
export CONFLUENT_CLOUD_PASSWORD="Your Confluent Cloud password"
1818

1919
# For executing against the cluster
2020
export KAFKA_BOOTSTRAP_SERVERS="Your Confluent Cloud cluster URL"
@@ -32,7 +32,7 @@ export CLICOLOR_FORCE="true"
3232

3333
Once defining services and users, you can generate service accounts.
3434

35-
**NOTE**: Before running `accounts` or `plan`, ensure you are logged in to Confluent Cloud. Use `ccloud login`.
35+
**NOTE**: Before running `accounts` or `plan`, ensure you are logged in to Confluent Cloud. Use `confluent login`.
3636

3737
Create accounts:
3838

examples/confluent-cloud/state.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
settings:
2-
ccloud:
2+
confluent:
33
enabled: true
44
files:
55
topics: topics.yaml

0 commit comments

Comments
 (0)