-
Notifications
You must be signed in to change notification settings - Fork 1.1k
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
Updated node_pools variable documentation #297
Conversation
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.
Please check the formatting of this (you can preview on GitHub). I'd suggest formatting as a table.
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.
Please recheck requirements and provide defaults from the codebase.
autogen/README.md
Outdated
| Name | Description | Requirement | | ||
| --- | --- | --- | | ||
| name | The name of the node pool. If left blank, Terraform will auto-generate a unique name | Optional | | ||
| min_count | Minimum number of nodes in the NodePool. Must be >=0 and <= max_count | Required | |
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.
Not required, has a default: https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/blob/master/cluster.tf#L150
autogen/README.md
Outdated
| --- | --- | --- | | ||
| name | The name of the node pool. If left blank, Terraform will auto-generate a unique name | Optional | | ||
| min_count | Minimum number of nodes in the NodePool. Must be >=0 and <= max_count | Required | | ||
| max_count | Maximum number of nodes in the NodePool. Must be >= min_count | Required | |
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.
Not required.
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.
Please add a column explaining defaults.
This should incorporate the addition of |
Does I just tried this module with the following node pool definition
after I ran
but if I explicitly add
|
The default depends on whether the cluster is regional or zonal: https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/blob/master/autogen/main.tf#L62 |
@morgante ah! Then I humble request that default values, that depend on whether the cluster is regional or zonal, are also reflected in this part of the documentation. Keep up the awesome work! |
Agreed. @neelesh9795 please make sure to update with that. |
@neelesh9795 please also consider sorting the table in alphabetical order 🤗 |
@@ -182,6 +182,26 @@ In order to operate with the Service Account you must activate the following API | |||
- Compute Engine API - compute.googleapis.com | |||
- Kubernetes Engine API - container.googleapis.com | |||
|
|||
## node_pools variable |
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 table must include node_count
which was added in #313.
Closing this due to merge conflicts. Re opening at #331 |
Added the wrong file last time. Updated the autogen/README.md