Skip to content

Commit a359141

Browse files
Benjamin BauerDennis Ploeger
authored andcommitted
bug: generate documentation and fix typo
1 parent b152a71 commit a359141

File tree

2 files changed

+72
-41
lines changed

2 files changed

+72
-41
lines changed

README.md

Lines changed: 57 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -132,14 +132,39 @@ Type: `list(string)`
132132

133133
Default: `[]`
134134

135+
### auto\_scaling\_enable
136+
137+
Description: Enable auto-scaling of node pool
138+
139+
Type: `bool`
140+
141+
Default: `false`
142+
143+
### auto\_scaling\_max\_node\_count
144+
145+
Description: Enable auto-scaling of node pool
146+
147+
Type: `string`
148+
149+
Default: `"1"`
150+
151+
### auto\_scaling\_min\_node\_count
152+
153+
Description: Enable auto-scaling of node pool
154+
155+
Type: `string`
156+
157+
Default: `"1"`
158+
135159
### automatic\_channel\_upgrade
136160

137-
Description: Values: none, patch, stable, rapid, node-image
138-
for further information see https://learn.microsoft.com/en-us/azure/aks/auto-upgrade-cluster
161+
Description: Values:
162+
none, patch, stable, rapid, node-image
163+
see https://learn.microsoft.com/en-us/azure/aks/auto-upgrade-cluster
139164

140165
Type: `string`
141166

142-
Default: `none`
167+
Default: `"none"`
143168

144169
### availability\_zones
145170

@@ -189,57 +214,55 @@ Type: `string`
189214

190215
Default: `"basic"`
191216

192-
### managed\_identity\_security\_group
193-
194-
Description: The name of a group which is assigned to appropriate roles in the subscription to manage resources that are required by the AKS.
195-
Setting this to a non empty string will add the AKS managed identity to this group.
196-
197-
You need the following API permissions (with admin consent) on a service prinicpal to make this work:
198-
199-
* Directory.Read.All
200-
* Group.Read.All
201-
* Group.ReadWrite.All
202-
203-
Type: `string`
204-
205-
Default: `""`
206-
207217
### maintenance\_window\_auto\_upgrade\_day\_of\_week
208218

209-
Description: The maintenance window is automatically, if automatic\_channel\_upgrade != none
210-
for values see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
219+
Description: see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
211220

212221
Type: `string`
213222

214223
Default: `"Monday"`
215224

216225
### maintenance\_window\_auto\_upgrade\_duration
217226

218-
Description: The maintenance window is automatically, if automatic\_channel\_upgrade != none
219-
for values see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
227+
Description: see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
220228

221229
Type: `string`
222230

223231
Default: `"4"`
224232

225233
### maintenance\_window\_auto\_upgrade\_start\_time
226234

227-
Description: The maintenance window is automatically, if automatic\_channel\_upgrade != none
228-
for values see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
235+
Description: Example: "04:00"
236+
see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
229237

230238
Type: `string`
231239

232240
Default: `"04:00"`
233241

234242
### maintenance\_window\_auto\_upgrade\_utc\_offset
235243

236-
Description: The maintenance window is automatically, if automatic\_channel\_upgrade != none
237-
for values see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
244+
Description: Example: "+00:00"
245+
see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
238246

239247
Type: `string`
240248

241249
Default: `"+00:00"`
242250

251+
### managed\_identity\_security\_group
252+
253+
Description: The name of a group which is assigned to appropriate roles in the subscription to manage resources that are required by the AKS.
254+
Setting this to a non empty string will add the AKS managed identity to this group.
255+
256+
You need the following API permissions (with admin consent) on a service prinicpal to make this work:
257+
258+
* Directory.Read.All
259+
* Group.Read.All
260+
* Group.ReadWrite.All
261+
262+
Type: `string`
263+
264+
Default: `""`
265+
243266
### max\_pods
244267

245268
Description: Amount of pods allowed on each node (be aware that kubernetes system pods are also counted
@@ -335,6 +358,14 @@ Type: `map(any)`
335358

336359
Default: `{}`
337360

361+
### temporary\_name\_for\_rotation
362+
363+
Description: Specifies the name of the temporary node pool used to cycle the default node pool for VM resizing.
364+
365+
Type: `string`
366+
367+
Default: `"rotationtmp"`
368+
338369
## Outputs
339370

340371
The following outputs are exported:

vars.tf

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -95,21 +95,21 @@ variable "node_pools" {
9595
}
9696

9797
variable "auto_scaling_enable" {
98-
type = bool
99-
description = "Enable auto scaling of node pool"
100-
default = false
98+
type = bool
99+
description = "Enable auto-scaling of node pool"
100+
default = false
101101
}
102102

103103
variable "auto_scaling_min_node_count" {
104-
type = string
105-
description = "Enable auto scaling of node pool"
106-
default = "1"
104+
type = string
105+
description = "Enable auto-scaling of node pool"
106+
default = "1"
107107
}
108108

109109
variable "auto_scaling_max_node_count" {
110-
type = string
111-
description = "Enable auto scaling of node pool"
112-
default = "1"
110+
type = string
111+
description = "Enable auto-scaling of node pool"
112+
default = "1"
113113
}
114114

115115
variable "load_balancer_sku" {
@@ -131,9 +131,9 @@ variable "availability_zones" {
131131
}
132132

133133
variable "temporary_name_for_rotation" {
134-
type = string
134+
type = string
135135
description = "Specifies the name of the temporary node pool used to cycle the default node pool for VM resizing."
136-
default = "rotationtmp"
136+
default = "rotationtmp"
137137
}
138138

139139
variable "sku_tier" {
@@ -228,23 +228,23 @@ variable "automatic_channel_upgrade" {
228228
variable "maintenance_window_auto_upgrade_day_of_week" {
229229
type = string
230230
default = "Monday"
231-
description = <<-EOF
231+
description = <<-EOF
232232
see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
233233
EOF
234234
}
235235

236236
variable "maintenance_window_auto_upgrade_duration" {
237237
type = string
238238
default = "4"
239-
description = <<-EOF
239+
description = <<-EOF
240240
see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
241241
EOF
242242
}
243243

244244
variable "maintenance_window_auto_upgrade_start_time" {
245245
type = string
246246
default = "04:00"
247-
description = <<-EOF
247+
description = <<-EOF
248248
Example: "04:00"
249249
see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
250250
EOF
@@ -253,7 +253,7 @@ variable "maintenance_window_auto_upgrade_start_time" {
253253
variable "maintenance_window_auto_upgrade_utc_offset" {
254254
type = string
255255
default = "+00:00"
256-
description = <<-EOF
256+
description = <<-EOF
257257
Example: "+00:00"
258258
see https://learn.microsoft.com/en-us/azure/aks/planned-maintenance#creating-a-maintenance-window
259259
EOF

0 commit comments

Comments
 (0)