Skip to content

feat(docs): add warning for public attribute of cks cluster resource #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
radu-malliu wants to merge 2 commits into
base: main
Choose a base branch
from
Open

feat(docs): add warning for public attribute of cks cluster resource #177

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd3d3e9
feat(docs): add warning for public attribute of cks cluster resource
radu-malliu Dec 22, 2025
445ba85
fix(docs): generate docs the right way
radu-malliu Jan 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion coreweave/cks/resource_cluster.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -553,7 +553,7 @@ func (r *ClusterResource) Schema(ctx context.Context, req resource.SchemaRequest
"public": schema.BoolAttribute{
Optional: true,
Computed: true,
MarkdownDescription: "Whether the cluster's api-server is publicly accessible from the internet.",
MarkdownDescription: "Whether the cluster's api-server is publicly accessible from the internet.\n\t> WARNING: Do not set this attribute to `false` at cluster creation. Additional setup is required before a cluster can be made private. Check with your CoreWeave account team for details.",
Default: booldefault.StaticBool(false),
},
"version": schema.StringAttribute{
Expand Down
1 change: 1 addition & 0 deletions docs/resources/cks_cluster.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ The prefixes must exist in the cluster's VPC. This field is append-only.
- `node_port_range` (Attributes) Kubernetes Service NodePort range. NodePort range can be expanded in existing clusters but not shrunk. Updating the NodePort range to a smaller range will require a replacement of the cluster. (see [below for nested schema](#nestedatt--node_port_range))
- `oidc` (Attributes) OpenID Connect (OIDC) configuration for authentication to the api-server. (see [below for nested schema](#nestedatt--oidc))
- `public` (Boolean) Whether the cluster's api-server is publicly accessible from the internet.
> WARNING: Do not set this attribute to `false` at cluster creation. Additional setup is required before a cluster can be made private. Check with your CoreWeave account team for details.
- `shared_storage_cluster_id` (String) The `cluster_id` of the cluster to share storage with. Must be enabled by CoreWeave suppport. Contact CoreWeave support if you are interested in this feature.

### Read-Only
Expand Down
Loading