docs(object-storage): Scope bucket policy examples by org condition - #304
Open
thedriftofwords wants to merge 5 commits into
Open
docs(object-storage): Scope bucket policy examples by org condition#304thedriftofwords wants to merge 5 commits into
thedriftofwords wants to merge 5 commits into
Conversation
thedriftofwords
marked this pull request as ready for review
April 27, 2026 18:26
sosheskaz
previously approved these changes
Apr 28, 2026
Author
|
7/30/26 update: Used agent-assisted testing harness for docs examples as described above in PR description; harness used locally to test this PR, and will be added in a subsequent PR after this one is merged. |
thedriftofwords
marked this pull request as draft
April 28, 2026 17:17
Made-with: Cursor
thedriftofwords
force-pushed
the
cg/DOCS-2126-scope-bucket-policy-examples
branch
from
July 30, 2026 16:03
8f847d7 to
13b5ebc
Compare
Declare the CoreWeave provider source so copied examples resolve the correct provider and support Terraform initialization. Co-authored-by: Cursor <cursoragent@cursor.com>
dfinster
previously approved these changes
Jul 31, 2026
Replace org-wide CW wildcard principals with one console user and one SAML group ARN, keeping cw:PrincipalOrgID as an extra safety measure. Co-authored-by: Cursor <cursoragent@cursor.com>
4 tasks
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
CW) and one SAML group (AWS) as named principals, aligned with the merged docs PR coreweave/docs#3044.cw:PrincipalOrgIDin each example as an extra safety measure.arn:aws:s3:::*data source example with bucket-specific bucket and object ARNs.coreweave/coreweaveas the provider source in each independently copyable example and regenerates the provider reference docs.Rationale
The earlier draft used
"CW": ["*"]. In HCL, the square brackets are list syntax for the principal map, but*as the identifier is not the correct org-scoped wildcard form. The docs now use named principal ARNs for generic examples and reserve bare"Principal": "*"for explicit org-wide patterns withcw:PrincipalOrgID.Each example is a standalone root module when copied from the generated reference documentation, so declaring
coreweave/coreweaveonce per example makes it directly initializable without duplicating the declaration for every resource.Test plan
terraform fmton the updated example filesmake -f GNUmakefile generatego test ./coreweave/object_storagegit diff --checkterraform init -backend=falseandterraform validatefor both updated examples.terraform plan -refresh=falsereaches provider configuration for both examples. It stops as expected without a CoreWeave API token; no remote resources are created.Additional validation with documentation example harness
To increase confidence before merge, the changes in this PR were also validated with a credential-free documentation example harness developed on branch
cg/DOCS-3002-terraform-example-harness(DOCS-3002). That branch is based on this PR and is not part of this merge scope.The harness copies each registered example into a temporary directory so no
.terraform/or lockfiles are written underexamples/, then runs:terraform fmt -checkterraform init -backend=false -input=falseterraform validateBoth modules in this PR passed:
examples/resources/coreweave_object_storage_bucket_policyexamples/data-sources/coreweave_object_storage_bucket_policy_documentThe harness does not run
planorapply, so it does not require CoreWeave API credentials. It confirms that each example resolvescoreweave/coreweave, initializes cleanly, and passes schema validation as an independently copyable root module.Closes DOCS-2126
Made with Cursor