examples: add user-and-acls example - #346
Open
sago2k8 wants to merge 1 commit into
Open
Conversation
Adds a focused, customer-shareable example that provisions a SASL/SCRAM user and a typical consumer-style ACL bundle (CLUSTER, TOPIC, GROUP) against an existing Redpanda Cloud cluster. The example deliberately does not bootstrap the resource group, network, or cluster -- see examples/redpanda-role for that path. The README spells out the service-account-with-Admin-role prerequisite and links to the Cloud RBAC docs.
sago2k8
force-pushed
the
examples/user-and-acls
branch
from
May 21, 2026 21:28
c13aa74 to
23e23e3
Compare
Member
|
Needs to be added to a template so that it can be referenced in the generated docs. The example as currently implemented is a bare directory |
gene-redpanda
requested changes
Jun 24, 2026
gene-redpanda
left a comment
Member
There was a problem hiding this comment.
See comment re: adding example to a template
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
examples/user-and-acls/that provisions a SASL/SCRAM user and a typical consumer-style ACL bundle (CLUSTER, TOPIC, GROUP — 9 ACLs viafor_eachover operation lists) against an existing Redpanda Cloud cluster.examples/redpanda-role. The new example assumes the cluster already exists and is referenced viavar.cluster_api_url.Admin-role prerequisite, the env-var credential flow, how to fetch the dataplane URL from the Control Plane API, and pointers to the Cloud RBAC docs. Includes outputs, cleanup, and a "Customizing the ACL set" section keyed on thelocalsoperation lists.redpanda-data/redpanda,hashicorp/random) so it runs cleanly in air-gapped / mirror environments. Pinsrequired_version >= 1.11because the example uses the write-onlypassword_woattribute.This grew out of a customer case where the failure surface was unclear; the example exists so customers and support can validate the user/ACL provisioning path against any cluster in one
terraform apply.Test plan
terraform init && terraform validatefrom insideexamples/user-and-acls/terraform applyagainst a non-prod cluster with aREDPANDA_CLIENT_ID/REDPANDA_CLIENT_SECRETfor a service account that has theAdminrole — confirms the 1 user + 9 ACLs landterraform destroycleans up without leftover resources