Skip to content

Commit 5d144e8

Browse files
author
Shamsher Ansari
authored
Fix workload-group docs (istio#1743)
1 parent da30ccf commit 5d144e8

6 files changed

+91
-91
lines changed

‎kubernetes/customresourcedefinitions.gen.yaml

+5-5
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎mesh/v1alpha1/istio.mesh.v1alpha1.gen.json

+37-37
Original file line numberDiff line numberDiff line change
@@ -1336,22 +1336,22 @@
13361336
"format": "int32"
13371337
},
13381338
"timeoutSeconds": {
1339-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1339+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
13401340
"type": "integer",
13411341
"format": "int32"
13421342
},
13431343
"periodSeconds": {
1344-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1344+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
13451345
"type": "integer",
13461346
"format": "int32"
13471347
},
13481348
"successThreshold": {
1349-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1349+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
13501350
"type": "integer",
13511351
"format": "int32"
13521352
},
13531353
"failureThreshold": {
1354-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1354+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
13551355
"type": "integer",
13561356
"format": "int32"
13571357
}
@@ -1371,22 +1371,22 @@
13711371
"format": "int32"
13721372
},
13731373
"timeoutSeconds": {
1374-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1374+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
13751375
"type": "integer",
13761376
"format": "int32"
13771377
},
13781378
"periodSeconds": {
1379-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1379+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
13801380
"type": "integer",
13811381
"format": "int32"
13821382
},
13831383
"successThreshold": {
1384-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1384+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
13851385
"type": "integer",
13861386
"format": "int32"
13871387
},
13881388
"failureThreshold": {
1389-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1389+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
13901390
"type": "integer",
13911391
"format": "int32"
13921392
},
@@ -1406,22 +1406,22 @@
14061406
"format": "int32"
14071407
},
14081408
"timeoutSeconds": {
1409-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1409+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
14101410
"type": "integer",
14111411
"format": "int32"
14121412
},
14131413
"periodSeconds": {
1414-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1414+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
14151415
"type": "integer",
14161416
"format": "int32"
14171417
},
14181418
"successThreshold": {
1419-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1419+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
14201420
"type": "integer",
14211421
"format": "int32"
14221422
},
14231423
"failureThreshold": {
1424-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1424+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
14251425
"type": "integer",
14261426
"format": "int32"
14271427
},
@@ -1441,22 +1441,22 @@
14411441
"format": "int32"
14421442
},
14431443
"timeoutSeconds": {
1444-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1444+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
14451445
"type": "integer",
14461446
"format": "int32"
14471447
},
14481448
"periodSeconds": {
1449-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1449+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
14501450
"type": "integer",
14511451
"format": "int32"
14521452
},
14531453
"successThreshold": {
1454-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1454+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
14551455
"type": "integer",
14561456
"format": "int32"
14571457
},
14581458
"failureThreshold": {
1459-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1459+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
14601460
"type": "integer",
14611461
"format": "int32"
14621462
},
@@ -1481,22 +1481,22 @@
14811481
"format": "int32"
14821482
},
14831483
"timeoutSeconds": {
1484-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1484+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
14851485
"type": "integer",
14861486
"format": "int32"
14871487
},
14881488
"periodSeconds": {
1489-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1489+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
14901490
"type": "integer",
14911491
"format": "int32"
14921492
},
14931493
"successThreshold": {
1494-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1494+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
14951495
"type": "integer",
14961496
"format": "int32"
14971497
},
14981498
"failureThreshold": {
1499-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1499+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
15001500
"type": "integer",
15011501
"format": "int32"
15021502
},
@@ -1516,22 +1516,22 @@
15161516
"format": "int32"
15171517
},
15181518
"timeoutSeconds": {
1519-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1519+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
15201520
"type": "integer",
15211521
"format": "int32"
15221522
},
15231523
"periodSeconds": {
1524-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1524+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
15251525
"type": "integer",
15261526
"format": "int32"
15271527
},
15281528
"successThreshold": {
1529-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1529+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
15301530
"type": "integer",
15311531
"format": "int32"
15321532
},
15331533
"failureThreshold": {
1534-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1534+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
15351535
"type": "integer",
15361536
"format": "int32"
15371537
},
@@ -1551,22 +1551,22 @@
15511551
"format": "int32"
15521552
},
15531553
"timeoutSeconds": {
1554-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
1554+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
15551555
"type": "integer",
15561556
"format": "int32"
15571557
},
15581558
"periodSeconds": {
1559-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
1559+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
15601560
"type": "integer",
15611561
"format": "int32"
15621562
},
15631563
"successThreshold": {
1564-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
1564+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
15651565
"type": "integer",
15661566
"format": "int32"
15671567
},
15681568
"failureThreshold": {
1569-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
1569+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
15701570
"type": "integer",
15711571
"format": "int32"
15721572
},
@@ -1588,11 +1588,11 @@
15881588
]
15891589
},
15901590
"istio.networking.v1alpha3.ExecHealthCheckConfig": {
1591-
"description": "health is determined by how the command that is executed exited.",
1591+
"description": "Health is determined by how the command that is executed exited.",
15921592
"type": "object",
15931593
"properties": {
15941594
"command": {
1595-
"description": "command to run. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
1595+
"description": "Command to run. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
15961596
"type": "array",
15971597
"items": {
15981598
"type": "string",
@@ -1602,7 +1602,7 @@
16021602
}
16031603
},
16041604
"istio.networking.v1alpha3.HTTPHealthCheckConfig": {
1605-
"description": "an http get is performed to a given endpoint and the status/able to connect determines health.",
1605+
"description": "`httpGet` is performed to a given endpoint and the status/able to connect determines health.",
16061606
"type": "object",
16071607
"properties": {
16081608
"path": {
@@ -1616,16 +1616,16 @@
16161616
"format": "string"
16171617
},
16181618
"port": {
1619-
"description": "port on which the endpoint lives.",
1619+
"description": "Port on which the endpoint lives.",
16201620
"type": "integer"
16211621
},
16221622
"scheme": {
1623-
"description": "http or https, defaults to http",
1623+
"description": "HTTP or HTTPS, defaults to HTTP",
16241624
"type": "string",
16251625
"format": "string"
16261626
},
16271627
"httpHeaders": {
1628-
"description": "headers the proxy will pass on to make the request. allows repeated headers.",
1628+
"description": "Headers the proxy will pass on to make the request. Allows repeated headers.",
16291629
"type": "array",
16301630
"items": {
16311631
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPHeader"
@@ -1666,16 +1666,16 @@
16661666
}
16671667
},
16681668
"istio.networking.v1alpha3.TCPHealthCheckConfig": {
1669-
"description": "health is determined by if the proxy is able to connect.",
1669+
"description": "Health is determined by if the proxy is able to connect.",
16701670
"type": "object",
16711671
"properties": {
16721672
"host": {
1673-
"description": "host to connect to, defaults to localhost",
1673+
"description": "Host to connect to, defaults to localhost",
16741674
"type": "string",
16751675
"format": "string"
16761676
},
16771677
"port": {
1678-
"description": "port of host",
1678+
"description": "Port of host",
16791679
"type": "integer"
16801680
}
16811681
}

‎networking/v1alpha3/workload_group.gen.json

+10-10
Original file line numberDiff line numberDiff line change
@@ -98,22 +98,22 @@
9898
"format": "int32"
9999
},
100100
"timeoutSeconds": {
101-
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1.",
101+
"description": "Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1 second.",
102102
"type": "integer",
103103
"format": "int32"
104104
},
105105
"periodSeconds": {
106-
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1.",
106+
"description": "How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1 second.",
107107
"type": "integer",
108108
"format": "int32"
109109
},
110110
"successThreshold": {
111-
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1.",
111+
"description": "Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1 second.",
112112
"type": "integer",
113113
"format": "int32"
114114
},
115115
"failureThreshold": {
116-
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3.",
116+
"description": "Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3 seconds.",
117117
"type": "integer",
118118
"format": "int32"
119119
}
@@ -201,16 +201,16 @@
201201
"format": "string"
202202
},
203203
"port": {
204-
"description": "port on which the endpoint lives.",
204+
"description": "Port on which the endpoint lives.",
205205
"type": "integer"
206206
},
207207
"scheme": {
208-
"description": "http or https, defaults to http",
208+
"description": "HTTP or HTTPS, defaults to HTTP",
209209
"type": "string",
210210
"format": "string"
211211
},
212212
"httpHeaders": {
213-
"description": "headers the proxy will pass on to make the request. allows repeated headers.",
213+
"description": "Headers the proxy will pass on to make the request. Allows repeated headers.",
214214
"type": "array",
215215
"items": {
216216
"$ref": "#/components/schemas/istio.networking.v1alpha3.HTTPHeader"
@@ -222,12 +222,12 @@
222222
"type": "object",
223223
"properties": {
224224
"host": {
225-
"description": "host to connect to, defaults to localhost",
225+
"description": "Host to connect to, defaults to localhost",
226226
"type": "string",
227227
"format": "string"
228228
},
229229
"port": {
230-
"description": "port of host",
230+
"description": "Port of host",
231231
"type": "integer"
232232
}
233233
}
@@ -236,7 +236,7 @@
236236
"type": "object",
237237
"properties": {
238238
"command": {
239-
"description": "command to run. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
239+
"description": "Command to run. Exit status of 0 is treated as live/healthy and non-zero is unhealthy.",
240240
"type": "array",
241241
"items": {
242242
"type": "string",

0 commit comments

Comments
 (0)