docs: add confluent cloud example

Author: devshawn

docs/confluent-cloud.md

@@ -41,7 +41,7 @@ To use `kafka-gitops` with Confluent Cloud, you'll need to set a few environment
 
 * `KAFKA_BOOTSTRAP_SERVERS`: Your Confluent Cloud cluster URL
 * `KAFKA_SASL_JAAS_USERNAME`: Your Confluent Cloud API key
-* `KAFKA_SASL_JAAS_USERNAME`: Your Confluent Cloud API secret
+* `KAFKA_SASL_JAAS_PASSWORD`: Your Confluent Cloud API secret
 * `KAFKA_SECURITY_PROTOCOL`: `SASL_SSL`
 * `KAFKA_SASL_MECHANISM`: `PLAIN`
 * `KAFKA_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM`: `HTTPS`

examples/confluent-cloud/README.md

@@ -0,0 +1,72 @@
+# Confluent Cloud Example
+
+This is a basic example of using `kafka-gitops` with Confluent Cloud.
+
+## Files
+- `services.yaml` defines service accounts + generates ACLs
+- `topics.yaml` defines topics and their configs
+- `users.yaml` defines "user" service accounts and roles (prefixed with `user-{name}`)
+
+## Configuration
+
+The following environment variables need to be set locally or in the build job:
+
+```bash
+# For service account creation / listing
+export XX_CCLOUD_EMAIL="Your Confluent Cloud email address"
+export XX_CCLOUD_PASSWORD="Your Confluent Cloud password"
+
+# For executing against the cluster
+export KAFKA_BOOTSTRAP_SERVERS="Your Confluent Cloud cluster URL"
+export KAFKA_SASL_JAAS_USERNAME"Your Confluent Cloud API key"
+export KAFKA_SASL_JAAS_PASSWORD="Your Confluent Cloud API secret"
+export KAFKA_SECURITY_PROTOCOL="SASL_SSL"
+export KAFKA_SASL_MECHANISM="PLAIN"
+export KAFKA_SSL_ENDPOINT_IDENTIFICATION_ALGORITHM="HTTPS"
+
+# For colored output
+export CLICOLOR_FORCE="true"
+```
+
+## Service Accounts
+
+Once defining services and users, you can generate service accounts. 
+
+**NOTE**: Before running `accounts` or `plan`, ensure you are logged in to Confluent Cloud. Use `ccloud login`.
+
+Create accounts:
+
+```bash
+kafka-gitops -f state.yaml accounts
+```
+
+## Plan
+
+Generate an execution plan against your Confluent Cloud cluster as so:
+
+```bash
+kafka-gitops -f state.yaml plan -o plan.json
+```
+
+To disable deletes, you can use:
+
+```bash
+kafka-gitops -f state.yaml --no-delete plan -o plan.json
+```
+
+This will output a plan file as well as pretty print the plan to standard out.
+
+## Apply
+
+Apply the plan against your Confluent Cloud cluster as so:
+
+```bash
+kafka-gitops -f state.yaml apply -p plan.json
+```
+
+
+To disable deletes, you can use:
+
+```bash
+kafka-gitops -f state.yaml --no-delete apply -p plan.json
+```

examples/confluent-cloud/services.yaml

@@ -0,0 +1,5 @@
+services:
+ my-test-service:
+ type: application
+ consumes:
+ - my-test-topic

examples/confluent-cloud/topics.yaml

@@ -0,0 +1,4 @@
+topics:
+ my-test-topic:
+ partitions: 6
+ replication: 3

examples/confluent-cloud/users.yaml

@@ -0,0 +1,4 @@
+users:
+ john-doe:
+ roles:
+ - operator