-
Notifications
You must be signed in to change notification settings - Fork 9.3k
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.
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
docs: add storage configuration block for eks_cluster resource #41267
docs: add storage configuration block for eks_cluster resource #41267
Conversation
Community NoteVoting for Prioritization
For Submitters
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Had a minor suggestion, but otherwise looks good to me! Thank you for taking the time to raise this @stefanfreitag! 🎉
@@ -477,7 +489,7 @@ This resource exports the following attributes in addition to the arguments abov | |||
* `endpoint` - Endpoint for your Kubernetes API server. | |||
* `id` - Name of the cluster. | |||
* `identity` - Attribute block containing identity provider information for your cluster. Only available on Kubernetes version 1.13 and 1.14 clusters created or upgraded on or after September 3, 2019. Detailed below. | |||
* `kubernetes_network_config` - Attribute block containing Kubernetes network configuration for the cluster. Detailed below. | |||
* `kubernetes_network_config` - Attribute block containing Kubernetes network configuration for the cluster. [Detailed](#kubernetes_network_config-1) below. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since this is an argument, I think we should remove it from the attributes section entirely to be more consistent with other areas of the docs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @justinretzolk,
we can do so. One question I have before going that route:
As part of kubernetes_network_config
there is service_ipv6_cidr
which is Computed: true
.
Is this maybe the reason why kubernetes_network_config
block is listed under the Attributes section?
(rephrased: How would we need to document service_ipv6_cidr
then without mentioning the block under Attributes? - sorry for this possibly stupid question)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an interesting one, and I think a great question @stefanfreitag!
From my perspective, the right approach would be to combine the two kubernetes_network_config
block definitions (the ones starting at lines 416 and 506 respectively) and then note service_ipv6_cidr
as (Read-Only)
or (Computed)
similar to the way we do for (Optional)
. I'm not aware of another place in the documentation that we do this, so I'll spend some time looking around to see if we have a precedent here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In looking, it seems the (Computed)
note is an established pattern:
aws_apigatewayv2_domain_name.domain_name_configuration.hosted_zone_id
aws_lex_bot_alias.log_settings.resource_prefix
Another time where I wish we were generating all of the docs, but alas 🙂
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I introduced (Computed)
and applied our approach on kubernetes_network_config
also on vpc_config
to be consistent in the document.
Merge the block definitions existing in arguments and attributes section for vpc_config and kubernetes_network_config.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me! Thanks again for taking care of this! I'll get it merged once the checks go green 🚀
This functionality has been released in v5.87.0 of the Terraform AWS Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading. For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you! |
Description
aws_eks_cluster
contains astorage_config
block, see e.g. example code available here.storage_config
.The pull requests
storage_config
Relations
Closes #41226
References
Output from Acceptance Testing
Not applicable. Only documentation is updated.