Skip to content

Commit cd89bb9

Browse files
jiwonaidmarkmandel
jiwonaid
and
markmandel
authored
Fix "kubectl explain" output for Agones CRDs (agones-dev#2423)
Co-authored-by: Mark Mandel <markmandel@google.com>
1 parent 0a61a41 commit cd89bb9

7 files changed

Lines changed: 56 additions & 4 deletions

File tree

‎install/helm/agones/templates/crds/_gameserverspecschema.yaml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
{{/* schema for a gameserver spec */}}
1616
{{- define "gameserver.schema" }}
17+
description: 'GameServer is the data structure for a GameServer resource.'
1718
type: object
1819
required:
1920
- spec
@@ -23,6 +24,8 @@ properties:
2324
{{- include "io.k8s.apimachinery.pkg.apis.meta.v1.ObjectMeta" . | indent 4 }}
2425
{{- end}}
2526
spec:
27+
description: 'GameServerSpec is the spec for a GameServer resource. More info:
28+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer'
2629
type: object
2730
required:
2831
- template
@@ -90,7 +93,7 @@ properties:
9093
title: Parameters for the SDK Server (sidecar)
9194
properties:
9295
logLevel:
93-
type: string
96+
type: string
9497
description: |
9598
sdkServer log level parameter has three options:
9699
- "Info" (default) The SDK server will output all messages except for debug messages

‎install/helm/agones/templates/crds/_gameserverstatus.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
{{/* schema for a gameserver status */}}
1616
{{- define "gameserver.status" }}
1717
status:
18+
description: 'GameServerStatus is the status for a GameServer resource. More info:
19+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer'
1820
type: object
1921
title: The status values for the GameServer
2022
properties:

‎install/helm/agones/templates/crds/fleet.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,12 @@ spec:
5858
type: date
5959
schema:
6060
openAPIV3Schema:
61+
description: 'Fleet is the data structure for a Fleet resource'
6162
type: object
6263
properties:
6364
spec:
65+
description: 'FleetSpec is the spec for a Fleet. More info:
66+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.Fleet'
6467
type: object
6568
required:
6669
- template
@@ -99,6 +102,8 @@ spec:
99102
{{- $data := dict "metadata" true "podPreserveUnknownFields" .Values.gameservers.podPreserveUnknownFields }}
100103
{{- include "gameserver.schema" $data | indent 17 }}
101104
status:
105+
description: 'FleetStatus is the status of a Fleet. More info:
106+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.Fleet'
102107
type: object
103108
properties:
104109
replicas:

‎install/helm/agones/templates/crds/fleetautoscaler.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,12 @@ spec:
3939
storage: true
4040
schema:
4141
openAPIV3Schema:
42+
description: 'FleetAutoscaler is the data structure for a FleetAutoscaler resource.'
4243
type: object
4344
properties:
4445
spec:
46+
description: 'FleetAutoscalerSpec is the spec for a Fleet Scaler. More info:
47+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#autoscaling.agones.dev/v1.FleetAutoscaler'
4548
type: object
4649
required:
4750
- fleetName
@@ -122,6 +125,8 @@ spec:
122125
minimum: 0
123126
exclusiveMinimum: true
124127
status:
128+
description: 'FleetAutoscalerStatus defines the current status of a FleetAutoscaler. More info:
129+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#autoscaling.agones.dev/v1.FleetAutoscaler'
125130
type: object
126131
properties:
127132
currentReplicas:

‎install/helm/agones/templates/crds/gameserverallocationpolicy.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,12 @@ spec:
3838
storage: true
3939
schema:
4040
openAPIV3Schema:
41+
description: 'GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API.'
4142
type: object
4243
properties:
4344
spec:
45+
description: 'GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy. More info:
46+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#multicluster.agones.dev/v1.GameServerAllocationPolicy'
4447
type: object
4548
required:
4649
- priority

‎install/helm/agones/templates/crds/gameserverset.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,12 @@ spec:
5959
type: date
6060
schema:
6161
openAPIV3Schema:
62+
description: 'GameServerSet is the data structure for a set of GameServers.'
6263
type: object
6364
properties:
6465
spec:
66+
description: 'GameServerSetSpec the specification for GameServerSet. More info:
67+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServerSet'
6568
type: object
6669
required:
6770
- replicas
@@ -79,6 +82,8 @@ spec:
7982
{{- $data := dict "metadata" true "podPreserveUnknownFields" .Values.gameservers.podPreserveUnknownFields }}
8083
{{- include "gameserver.schema" $data | indent 18 }}
8184
status:
85+
description: 'GameServerSetStatus is the status of a GameServerSet. More info:
86+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServerSet'
8287
type: object
8388
properties:
8489
replicas:

‎install/yaml/install.yaml‎

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,12 @@ spec:
186186
type: date
187187
schema:
188188
openAPIV3Schema:
189+
description: 'Fleet is the data structure for a Fleet resource'
189190
type: object
190191
properties:
191192
spec:
193+
description: 'FleetSpec is the spec for a Fleet. More info:
194+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.Fleet'
192195
type: object
193196
required:
194197
- template
@@ -224,6 +227,7 @@ spec:
224227
- type: integer
225228
- type: string
226229
template:
230+
description: 'GameServer is the data structure for a GameServer resource.'
227231
type: object
228232
required:
229233
- spec
@@ -363,6 +367,8 @@ spec:
363367
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
364368
type: string
365369
spec:
370+
description: 'GameServerSpec is the spec for a GameServer resource. More info:
371+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer'
366372
type: object
367373
required:
368374
- template
@@ -4425,7 +4431,7 @@ spec:
44254431
title: Parameters for the SDK Server (sidecar)
44264432
properties:
44274433
logLevel:
4428-
type: string
4434+
type: string
44294435
description: |
44304436
sdkServer log level parameter has three options:
44314437
- "Info" (default) The SDK server will output all messages except for debug messages
@@ -4486,6 +4492,8 @@ spec:
44864492
title: The initial player capacity of this Game Server
44874493
minimum: 0
44884494
status:
4495+
description: 'FleetStatus is the status of a Fleet. More info:
4496+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.Fleet'
44894497
type: object
44904498
properties:
44914499
replicas:
@@ -4562,9 +4570,12 @@ spec:
45624570
storage: true
45634571
schema:
45644572
openAPIV3Schema:
4573+
description: 'FleetAutoscaler is the data structure for a FleetAutoscaler resource.'
45654574
type: object
45664575
properties:
45674576
spec:
4577+
description: 'FleetAutoscalerSpec is the spec for a Fleet Scaler. More info:
4578+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#autoscaling.agones.dev/v1.FleetAutoscaler'
45684579
type: object
45694580
required:
45704581
- fleetName
@@ -4645,6 +4656,8 @@ spec:
46454656
minimum: 0
46464657
exclusiveMinimum: true
46474658
status:
4659+
description: 'FleetAutoscalerStatus defines the current status of a FleetAutoscaler. More info:
4660+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#autoscaling.agones.dev/v1.FleetAutoscaler'
46484661
type: object
46494662
properties:
46504663
currentReplicas:
@@ -4719,11 +4732,14 @@ spec:
47194732
type: date
47204733
schema:
47214734
openAPIV3Schema:
4735+
description: 'GameServer is the data structure for a GameServer resource.'
47224736
type: object
47234737
required:
47244738
- spec
47254739
properties:
47264740
spec:
4741+
description: 'GameServerSpec is the spec for a GameServer resource. More info:
4742+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer'
47274743
type: object
47284744
required:
47294745
- template
@@ -8786,7 +8802,7 @@ spec:
87868802
title: Parameters for the SDK Server (sidecar)
87878803
properties:
87888804
logLevel:
8789-
type: string
8805+
type: string
87908806
description: |
87918807
sdkServer log level parameter has three options:
87928808
- "Info" (default) The SDK server will output all messages except for debug messages
@@ -8847,6 +8863,8 @@ spec:
88478863
title: The initial player capacity of this Game Server
88488864
minimum: 0
88498865
status:
8866+
description: 'GameServerStatus is the status for a GameServer resource. More info:
8867+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer'
88508868
type: object
88518869
title: The status values for the GameServer
88528870
properties:
@@ -8935,9 +8953,12 @@ spec:
89358953
storage: true
89368954
schema:
89378955
openAPIV3Schema:
8956+
description: 'GameServerAllocationPolicy is the Schema for the gameserverallocationpolicies API.'
89388957
type: object
89398958
properties:
89408959
spec:
8960+
description: 'GameServerAllocationPolicySpec defines the desired state of GameServerAllocationPolicy. More info:
8961+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#multicluster.agones.dev/v1.GameServerAllocationPolicy'
89418962
type: object
89428963
required:
89438964
- priority
@@ -9031,9 +9052,12 @@ spec:
90319052
type: date
90329053
schema:
90339054
openAPIV3Schema:
9055+
description: 'GameServerSet is the data structure for a set of GameServers.'
90349056
type: object
90359057
properties:
90369058
spec:
9059+
description: 'GameServerSetSpec the specification for GameServerSet. More info:
9060+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServerSet'
90379061
type: object
90389062
required:
90399063
- replicas
@@ -9048,6 +9072,7 @@ spec:
90489072
- Packed
90499073
- Distributed
90509074
template:
9075+
description: 'GameServer is the data structure for a GameServer resource.'
90519076
type: object
90529077
required:
90539078
- spec
@@ -9187,6 +9212,8 @@ spec:
91879212
Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
91889213
type: string
91899214
spec:
9215+
description: 'GameServerSpec is the spec for a GameServer resource. More info:
9216+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServer'
91909217
type: object
91919218
required:
91929219
- template
@@ -13249,7 +13276,7 @@ spec:
1324913276
title: Parameters for the SDK Server (sidecar)
1325013277
properties:
1325113278
logLevel:
13252-
type: string
13279+
type: string
1325313280
description: |
1325413281
sdkServer log level parameter has three options:
1325513282
- "Info" (default) The SDK server will output all messages except for debug messages
@@ -13310,6 +13337,8 @@ spec:
1331013337
title: The initial player capacity of this Game Server
1331113338
minimum: 0
1331213339
status:
13340+
description: 'GameServerSetStatus is the status of a GameServerSet. More info:
13341+
https://agones.dev/site/docs/reference/agones_crd_api_reference/#agones.dev/v1.GameServerSet'
1331313342
type: object
1331413343
properties:
1331513344
replicas:

0 commit comments

Comments
 (0)