Add documentation for node_pools #331
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -185,6 +185,27 @@ 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 | ||
| The node_pools variable takes the following parameters: | ||
|
|
||
| | Name | Description | Default | Requirement | | ||
| | --- | --- | --- | --- | | ||
| | auto_repair | Whether the nodes will be automatically repaired | true | Optional | | ||
| | autoscaling | Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage | true | Optional | | ||
| | auto_upgrade | Whether the nodes will be automatically upgraded | true (if cluster is regional) | Optional | | ||
| | disk_size_gb | Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB | 100GB | Optional | | ||
| | disk_type | Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd') | pd-standard | Optional | | ||
| | image_type | The image type to use for this node. Note that changing the image type will delete and recreate all nodes in the node pool | COS | Optional | | ||
| | initial_node_count | The initial number of nodes for the pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Changing this will force recreation of the resource | 0 | Optional | | ||
| | machine_type | The name of a Google Compute Engine machine type | n1-standard-2 | Optional | | ||
| | max_count | Maximum number of nodes in the NodePool. Must be >= min_count | 100 | Optional | | ||
| | min_count | Minimum number of nodes in the NodePool. Must be >=0 and <= max_count | 1 | Optional | | ||
| | name | The name of the node pool | " " | Optional | | ||
| | node_count | The number of nodes in the nodepool when autoscaling is false | 2 | Required (when autoscaling is false) | | ||
| | node_locations | The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters | " " | Optional | | ||
|
There was a problem hiding this comment. This is only available on beta clusters, please make sure to only include beta features inside beta conditionals: https://github.com/terraform-google-modules/terraform-google-kubernetes-engine/blob/master/autogen/cluster.tf.tmpl#L321 |
||
| | preemptible | A boolean that represents whether or not the underlying node VMs are preemptible | false | Optional | | ||
| | service_account | The service account to be used by the Node VMs | " " | Optional | | ||
|
|
||
| ## File structure | ||
| The project has the following folders and files: | ||
|
|
||
|
|
||
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
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.
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.
Required.