docs: Fix FAQ example for not attaching the cluster primary security group - #3726
bryantbiggs merged 2 commits into
Conversation
|
This PR has been automatically marked as stale because it has been open 30 days |
|
Still relevant. This corrects the FAQ example for detaching the cluster primary security group, which currently documents a configuration that doesn't work as written. CI is green and the change is docs-only, so there's no rebase or conflict risk holding it up — it just needs a maintainer look. |
|
This PR is included in version 21.24.1 🎉 |
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
3 participants
Description
Fixes the FAQ entry I received an error:
expect exactly one securityGroup tagged with kubernetes.io/cluster/<CLUSTER_NAME> ....The entry lists two opposite approaches for resolving the error, but both showed the same example. The second case — "By not attaching the cluster primary security group" — still set
attach_cluster_primary_security_group = true, which is the attaching behavior described in the first case. This corrects the second example toattach_cluster_primary_security_group = falseso it actually demonstrates not attaching the cluster primary security group (matching the# default is falsecomment already present).Closes #3724
Motivation and Context
The contradictory example is confusing for users hitting the
expect exactly one securityGroup ...error — the "not attaching" remedy showed code that attaches.Breaking Changes
None — documentation only.
How Has This Been Tested?
examples/*projectsDocumentation-only change (
docs/faq.md); no Terraform code paths are affected.