/
V1.purs
832 lines (747 loc) · 48.9 KB
/
V1.purs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
module Kubernetes.Api.Meta.V1 where
import Prelude
import Prelude
import Control.Alt ((<|>))
import Data.Generic.Rep (class Generic)
import Data.Generic.Rep.Show (genericShow)
import Data.Maybe (Maybe(Just,Nothing))
import Data.Newtype (class Newtype)
import Data.Tuple (Tuple(Tuple))
import Foreign.Class (class Decode, class Encode, decode, encode)
import Foreign.Generic (defaultOptions, genericDecode, genericEncode)
import Foreign.Generic.Types (Options)
import Foreign.Index (readProp)
import Foreign.Object (Object)
import Foreign.Object as Object
import Kubernetes.Default (class Default)
import Kubernetes.Json (assertPropEq, decodeMaybe, encodeMaybe, jsonOptions)
import Kubernetes.Api.Runtime as Runtime
-- | APIGroup contains the name, the supported versions, and the preferred version of a group.
-- |
-- | Fields:
-- | - `name`: name is the name of the group.
-- | - `preferredVersion`: preferredVersion is the version preferred by the API server, which probably is the storage version.
-- | - `serverAddressByClientCIDRs`: a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
-- | - `versions`: versions are the versions supported in this group.
newtype APIGroup = APIGroup
{ name :: (Maybe String)
, preferredVersion :: (Maybe GroupVersionForDiscovery)
, serverAddressByClientCIDRs :: (Maybe (Array ServerAddressByClientCIDR))
, versions :: (Maybe (Array GroupVersionForDiscovery)) }
derive instance newtypeAPIGroup :: Newtype APIGroup _
derive instance genericAPIGroup :: Generic APIGroup _
instance showAPIGroup :: Show APIGroup where show a = genericShow a
instance decodeAPIGroup :: Decode APIGroup where
decode a = do
assertPropEq "apiVersion" "v1" a
assertPropEq "kind" "APIGroup" a
name <- decodeMaybe "name" a
preferredVersion <- decodeMaybe "preferredVersion" a
serverAddressByClientCIDRs <- decodeMaybe "serverAddressByClientCIDRs" a
versions <- decodeMaybe "versions" a
pure $ APIGroup { name, preferredVersion, serverAddressByClientCIDRs, versions }
instance encodeAPIGroup :: Encode APIGroup where
encode (APIGroup a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encode "v1")
, Tuple "kind" (encode "APIGroup")
, Tuple "name" (encodeMaybe a.name)
, Tuple "preferredVersion" (encodeMaybe a.preferredVersion)
, Tuple "serverAddressByClientCIDRs" (encodeMaybe a.serverAddressByClientCIDRs)
, Tuple "versions" (encodeMaybe a.versions) ]
instance defaultAPIGroup :: Default APIGroup where
default = APIGroup
{ name: Nothing
, preferredVersion: Nothing
, serverAddressByClientCIDRs: Nothing
, versions: Nothing }
-- | APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.
-- |
-- | Fields:
-- | - `groups`: groups is a list of APIGroup.
newtype APIGroupList = APIGroupList
{ groups :: (Maybe (Array APIGroup)) }
derive instance newtypeAPIGroupList :: Newtype APIGroupList _
derive instance genericAPIGroupList :: Generic APIGroupList _
instance showAPIGroupList :: Show APIGroupList where show a = genericShow a
instance decodeAPIGroupList :: Decode APIGroupList where
decode a = do
assertPropEq "apiVersion" "v1" a
groups <- decodeMaybe "groups" a
assertPropEq "kind" "APIGroupList" a
pure $ APIGroupList { groups }
instance encodeAPIGroupList :: Encode APIGroupList where
encode (APIGroupList a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encode "v1")
, Tuple "groups" (encodeMaybe a.groups)
, Tuple "kind" (encode "APIGroupList") ]
instance defaultAPIGroupList :: Default APIGroupList where
default = APIGroupList
{ groups: Nothing }
-- | APIResource specifies the name of a resource and whether it is namespaced.
-- |
-- | Fields:
-- | - `categories`: categories is a list of the grouped resources this resource belongs to (e.g. 'all')
-- | - `group`: group is the preferred group of the resource. Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale".
-- | - `kind`: kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')
-- | - `name`: name is the plural name of the resource.
-- | - `namespaced`: namespaced indicates if a resource is namespaced or not.
-- | - `shortNames`: shortNames is a list of suggested short names of the resource.
-- | - `singularName`: singularName is the singular name of the resource. This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.
-- | - `verbs`: verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)
-- | - `version`: version is the preferred version of the resource. Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)".
newtype APIResource = APIResource
{ categories :: (Maybe (Array String))
, group :: (Maybe String)
, kind :: (Maybe String)
, name :: (Maybe String)
, namespaced :: (Maybe Boolean)
, shortNames :: (Maybe (Array String))
, singularName :: (Maybe String)
, verbs :: (Maybe (Array String))
, version :: (Maybe String) }
derive instance newtypeAPIResource :: Newtype APIResource _
derive instance genericAPIResource :: Generic APIResource _
instance showAPIResource :: Show APIResource where show a = genericShow a
instance decodeAPIResource :: Decode APIResource where
decode a = do
categories <- decodeMaybe "categories" a
group <- decodeMaybe "group" a
kind <- decodeMaybe "kind" a
name <- decodeMaybe "name" a
namespaced <- decodeMaybe "namespaced" a
shortNames <- decodeMaybe "shortNames" a
singularName <- decodeMaybe "singularName" a
verbs <- decodeMaybe "verbs" a
version <- decodeMaybe "version" a
pure $ APIResource { categories, group, kind, name, namespaced, shortNames, singularName, verbs, version }
instance encodeAPIResource :: Encode APIResource where
encode (APIResource a) = encode $ Object.fromFoldable $
[ Tuple "categories" (encodeMaybe a.categories)
, Tuple "group" (encodeMaybe a.group)
, Tuple "kind" (encodeMaybe a.kind)
, Tuple "name" (encodeMaybe a.name)
, Tuple "namespaced" (encodeMaybe a.namespaced)
, Tuple "shortNames" (encodeMaybe a.shortNames)
, Tuple "singularName" (encodeMaybe a.singularName)
, Tuple "verbs" (encodeMaybe a.verbs)
, Tuple "version" (encodeMaybe a.version) ]
instance defaultAPIResource :: Default APIResource where
default = APIResource
{ categories: Nothing
, group: Nothing
, kind: Nothing
, name: Nothing
, namespaced: Nothing
, shortNames: Nothing
, singularName: Nothing
, verbs: Nothing
, version: Nothing }
-- | APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.
-- |
-- | Fields:
-- | - `groupVersion`: groupVersion is the group and version this APIResourceList is for.
-- | - `resources`: resources contains the name of the resources and if they are namespaced.
newtype APIResourceList = APIResourceList
{ groupVersion :: (Maybe String)
, resources :: (Maybe (Array APIResource)) }
derive instance newtypeAPIResourceList :: Newtype APIResourceList _
derive instance genericAPIResourceList :: Generic APIResourceList _
instance showAPIResourceList :: Show APIResourceList where show a = genericShow a
instance decodeAPIResourceList :: Decode APIResourceList where
decode a = do
assertPropEq "apiVersion" "v1" a
groupVersion <- decodeMaybe "groupVersion" a
assertPropEq "kind" "APIResourceList" a
resources <- decodeMaybe "resources" a
pure $ APIResourceList { groupVersion, resources }
instance encodeAPIResourceList :: Encode APIResourceList where
encode (APIResourceList a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encode "v1")
, Tuple "groupVersion" (encodeMaybe a.groupVersion)
, Tuple "kind" (encode "APIResourceList")
, Tuple "resources" (encodeMaybe a.resources) ]
instance defaultAPIResourceList :: Default APIResourceList where
default = APIResourceList
{ groupVersion: Nothing
, resources: Nothing }
-- | APIVersions lists the versions that are available, to allow clients to discover the API at /api, which is the root path of the legacy v1 API.
-- |
-- | Fields:
-- | - `serverAddressByClientCIDRs`: a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.
-- | - `versions`: versions are the api versions that are available.
newtype APIVersions = APIVersions
{ serverAddressByClientCIDRs :: (Maybe (Array ServerAddressByClientCIDR))
, versions :: (Maybe (Array String)) }
derive instance newtypeAPIVersions :: Newtype APIVersions _
derive instance genericAPIVersions :: Generic APIVersions _
instance showAPIVersions :: Show APIVersions where show a = genericShow a
instance decodeAPIVersions :: Decode APIVersions where
decode a = do
assertPropEq "apiVersion" "v1" a
assertPropEq "kind" "APIVersions" a
serverAddressByClientCIDRs <- decodeMaybe "serverAddressByClientCIDRs" a
versions <- decodeMaybe "versions" a
pure $ APIVersions { serverAddressByClientCIDRs, versions }
instance encodeAPIVersions :: Encode APIVersions where
encode (APIVersions a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encode "v1")
, Tuple "kind" (encode "APIVersions")
, Tuple "serverAddressByClientCIDRs" (encodeMaybe a.serverAddressByClientCIDRs)
, Tuple "versions" (encodeMaybe a.versions) ]
instance defaultAPIVersions :: Default APIVersions where
default = APIVersions
{ serverAddressByClientCIDRs: Nothing
, versions: Nothing }
-- | DeleteOptions may be provided when deleting an API object.
-- |
-- | Fields:
-- | - `gracePeriodSeconds`: The duration in seconds before the object should be deleted. Value must be non-negative integer. The value zero indicates delete immediately. If this value is nil, the default grace period for the specified type will be used. Defaults to a per object value if not specified. zero means delete immediately.
-- | - `orphanDependents`: Deprecated: please use the PropagationPolicy, this field will be deprecated in 1.7. Should the dependent objects be orphaned. If true/false, the "orphan" finalizer will be added to/removed from the object's finalizers list. Either this field or PropagationPolicy may be set, but not both.
-- | - `preconditions`: Must be fulfilled before a deletion is carried out. If not possible, a 409 Conflict status will be returned.
-- | - `propagationPolicy`: Whether and how garbage collection will be performed. Either this field or OrphanDependents may be set, but not both. The default policy is decided by the existing finalizer set in the metadata.finalizers and the resource-specific default policy. Acceptable values are: 'Orphan' - orphan the dependents; 'Background' - allow the garbage collector to delete the dependents in the background; 'Foreground' - a cascading policy that deletes all dependents in the foreground.
newtype DeleteOptions = DeleteOptions
{ gracePeriodSeconds :: (Maybe Int)
, orphanDependents :: (Maybe Boolean)
, preconditions :: (Maybe Preconditions)
, propagationPolicy :: (Maybe String) }
derive instance newtypeDeleteOptions :: Newtype DeleteOptions _
derive instance genericDeleteOptions :: Generic DeleteOptions _
instance showDeleteOptions :: Show DeleteOptions where show a = genericShow a
instance decodeDeleteOptions :: Decode DeleteOptions where
decode a = do
assertPropEq "apiVersion" "v1" a
gracePeriodSeconds <- decodeMaybe "gracePeriodSeconds" a
assertPropEq "kind" "DeleteOptions" a
orphanDependents <- decodeMaybe "orphanDependents" a
preconditions <- decodeMaybe "preconditions" a
propagationPolicy <- decodeMaybe "propagationPolicy" a
pure $ DeleteOptions { gracePeriodSeconds, orphanDependents, preconditions, propagationPolicy }
instance encodeDeleteOptions :: Encode DeleteOptions where
encode (DeleteOptions a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encode "v1")
, Tuple "gracePeriodSeconds" (encodeMaybe a.gracePeriodSeconds)
, Tuple "kind" (encode "DeleteOptions")
, Tuple "orphanDependents" (encodeMaybe a.orphanDependents)
, Tuple "preconditions" (encodeMaybe a.preconditions)
, Tuple "propagationPolicy" (encodeMaybe a.propagationPolicy) ]
instance defaultDeleteOptions :: Default DeleteOptions where
default = DeleteOptions
{ gracePeriodSeconds: Nothing
, orphanDependents: Nothing
, preconditions: Nothing
, propagationPolicy: Nothing }
-- | GroupVersion contains the "group/version" and "version" string of a version. It is made a struct to keep extensibility.
-- |
-- | Fields:
-- | - `groupVersion`: groupVersion specifies the API group and version in the form "group/version"
-- | - `version`: version specifies the version in the form of "version". This is to save the clients the trouble of splitting the GroupVersion.
newtype GroupVersionForDiscovery = GroupVersionForDiscovery
{ groupVersion :: (Maybe String)
, version :: (Maybe String) }
derive instance newtypeGroupVersionForDiscovery :: Newtype GroupVersionForDiscovery _
derive instance genericGroupVersionForDiscovery :: Generic GroupVersionForDiscovery _
instance showGroupVersionForDiscovery :: Show GroupVersionForDiscovery where show a = genericShow a
instance decodeGroupVersionForDiscovery :: Decode GroupVersionForDiscovery where
decode a = do
groupVersion <- decodeMaybe "groupVersion" a
version <- decodeMaybe "version" a
pure $ GroupVersionForDiscovery { groupVersion, version }
instance encodeGroupVersionForDiscovery :: Encode GroupVersionForDiscovery where
encode (GroupVersionForDiscovery a) = encode $ Object.fromFoldable $
[ Tuple "groupVersion" (encodeMaybe a.groupVersion)
, Tuple "version" (encodeMaybe a.version) ]
instance defaultGroupVersionForDiscovery :: Default GroupVersionForDiscovery where
default = GroupVersionForDiscovery
{ groupVersion: Nothing
, version: Nothing }
-- | Initializer is information about an initializer that has not yet completed.
-- |
-- | Fields:
-- | - `name`: name of the process that is responsible for initializing this object.
newtype Initializer = Initializer
{ name :: (Maybe String) }
derive instance newtypeInitializer :: Newtype Initializer _
derive instance genericInitializer :: Generic Initializer _
instance showInitializer :: Show Initializer where show a = genericShow a
instance decodeInitializer :: Decode Initializer where
decode a = do
name <- decodeMaybe "name" a
pure $ Initializer { name }
instance encodeInitializer :: Encode Initializer where
encode (Initializer a) = encode $ Object.fromFoldable $
[ Tuple "name" (encodeMaybe a.name) ]
instance defaultInitializer :: Default Initializer where
default = Initializer
{ name: Nothing }
-- | Initializers tracks the progress of initialization.
-- |
-- | Fields:
-- | - `pending`: Pending is a list of initializers that must execute in order before this object is visible. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.
-- | - `result`: If result is set with the Failure field, the object will be persisted to storage and then deleted, ensuring that other clients can observe the deletion.
newtype Initializers = Initializers
{ pending :: (Maybe (Array Initializer))
, result :: (Maybe Status) }
derive instance newtypeInitializers :: Newtype Initializers _
derive instance genericInitializers :: Generic Initializers _
instance showInitializers :: Show Initializers where show a = genericShow a
instance decodeInitializers :: Decode Initializers where
decode a = do
pending <- decodeMaybe "pending" a
result <- decodeMaybe "result" a
pure $ Initializers { pending, result }
instance encodeInitializers :: Encode Initializers where
encode (Initializers a) = encode $ Object.fromFoldable $
[ Tuple "pending" (encodeMaybe a.pending)
, Tuple "result" (encodeMaybe a.result) ]
instance defaultInitializers :: Default Initializers where
default = Initializers
{ pending: Nothing
, result: Nothing }
-- | A label selector is a label query over a set of resources. The result of matchLabels and matchExpressions are ANDed. An empty label selector matches all objects. A null label selector matches no objects.
-- |
-- | Fields:
-- | - `matchExpressions`: matchExpressions is a list of label selector requirements. The requirements are ANDed.
-- | - `matchLabels`: matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
newtype LabelSelector = LabelSelector
{ matchExpressions :: (Maybe (Array LabelSelectorRequirement))
, matchLabels :: (Maybe (Object String)) }
derive instance newtypeLabelSelector :: Newtype LabelSelector _
derive instance genericLabelSelector :: Generic LabelSelector _
instance showLabelSelector :: Show LabelSelector where show a = genericShow a
instance decodeLabelSelector :: Decode LabelSelector where
decode a = do
matchExpressions <- decodeMaybe "matchExpressions" a
matchLabels <- decodeMaybe "matchLabels" a
pure $ LabelSelector { matchExpressions, matchLabels }
instance encodeLabelSelector :: Encode LabelSelector where
encode (LabelSelector a) = encode $ Object.fromFoldable $
[ Tuple "matchExpressions" (encodeMaybe a.matchExpressions)
, Tuple "matchLabels" (encodeMaybe a.matchLabels) ]
instance defaultLabelSelector :: Default LabelSelector where
default = LabelSelector
{ matchExpressions: Nothing
, matchLabels: Nothing }
-- | A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values.
-- |
-- | Fields:
-- | - `key`: key is the label key that the selector applies to.
-- | - `operator`: operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
-- | - `values`: values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
newtype LabelSelectorRequirement = LabelSelectorRequirement
{ key :: (Maybe String)
, operator :: (Maybe String)
, values :: (Maybe (Array String)) }
derive instance newtypeLabelSelectorRequirement :: Newtype LabelSelectorRequirement _
derive instance genericLabelSelectorRequirement :: Generic LabelSelectorRequirement _
instance showLabelSelectorRequirement :: Show LabelSelectorRequirement where show a = genericShow a
instance decodeLabelSelectorRequirement :: Decode LabelSelectorRequirement where
decode a = do
key <- decodeMaybe "key" a
operator <- decodeMaybe "operator" a
values <- decodeMaybe "values" a
pure $ LabelSelectorRequirement { key, operator, values }
instance encodeLabelSelectorRequirement :: Encode LabelSelectorRequirement where
encode (LabelSelectorRequirement a) = encode $ Object.fromFoldable $
[ Tuple "key" (encodeMaybe a.key)
, Tuple "operator" (encodeMaybe a.operator)
, Tuple "values" (encodeMaybe a.values) ]
instance defaultLabelSelectorRequirement :: Default LabelSelectorRequirement where
default = LabelSelectorRequirement
{ key: Nothing
, operator: Nothing
, values: Nothing }
-- | ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
-- |
-- | Fields:
-- | - `continue`: continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response.
-- | - `resourceVersion`: String that identifies the server's internal version of this object that can be used by clients to determine when objects have changed. Value must be treated as opaque by clients and passed unmodified back to the server. Populated by the system. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
-- | - `selfLink`: selfLink is a URL representing this object. Populated by the system. Read-only.
newtype ListMeta = ListMeta
{ continue :: (Maybe String)
, resourceVersion :: (Maybe String)
, selfLink :: (Maybe String) }
derive instance newtypeListMeta :: Newtype ListMeta _
derive instance genericListMeta :: Generic ListMeta _
instance showListMeta :: Show ListMeta where show a = genericShow a
instance decodeListMeta :: Decode ListMeta where
decode a = do
continue <- decodeMaybe "continue" a
resourceVersion <- decodeMaybe "resourceVersion" a
selfLink <- decodeMaybe "selfLink" a
pure $ ListMeta { continue, resourceVersion, selfLink }
instance encodeListMeta :: Encode ListMeta where
encode (ListMeta a) = encode $ Object.fromFoldable $
[ Tuple "continue" (encodeMaybe a.continue)
, Tuple "resourceVersion" (encodeMaybe a.resourceVersion)
, Tuple "selfLink" (encodeMaybe a.selfLink) ]
instance defaultListMeta :: Default ListMeta where
default = ListMeta
{ continue: Nothing
, resourceVersion: Nothing
, selfLink: Nothing }
newtype MicroTime = MicroTime String
derive instance newtypeMicroTime :: Newtype MicroTime _
derive instance genericMicroTime :: Generic MicroTime _
instance showMicroTime :: Show MicroTime where show a = genericShow a
instance decodeMicroTime :: Decode MicroTime where
decode a = genericDecode jsonOptions a
instance encodeMicroTime :: Encode MicroTime where
encode a = genericEncode jsonOptions a
-- | ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
-- |
-- | Fields:
-- | - `annotations`: Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations
-- | - `clusterName`: The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.
-- | - `creationTimestamp`: CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.
-- |
-- | Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
-- | - `deletionGracePeriodSeconds`: Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only.
-- | - `deletionTimestamp`: DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.
-- |
-- | Populated by the system when a graceful deletion is requested. Read-only. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
-- | - `finalizers`: Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.
-- | - `generateName`: GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.
-- |
-- | If this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).
-- |
-- | Applied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency
-- | - `generation`: A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.
-- | - `initializers`: An initializer is a controller which enforces some system invariant at object creation time. This field is a list of initializers that have not yet acted on this object. If nil or empty, this object has been completely initialized. Otherwise, the object is considered uninitialized and is hidden (in list/watch and get calls) from clients that haven't explicitly asked to observe uninitialized objects.
-- |
-- | When an object is created, the system will populate this list with the current set of initializers. Only privileged users may set or modify this list. Once it is empty, it may not be modified further by any user.
-- | - `labels`: Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels
-- | - `name`: Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names
-- | - `namespace`: Namespace defines the space within each name must be unique. An empty namespace is equivalent to the "default" namespace, but "default" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.
-- |
-- | Must be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces
-- | - `ownerReferences`: List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller.
-- | - `resourceVersion`: An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.
-- |
-- | Populated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency
-- | - `selfLink`: SelfLink is a URL representing this object. Populated by the system. Read-only.
-- | - `uid`: UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.
-- |
-- | Populated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
newtype ObjectMeta = ObjectMeta
{ annotations :: (Maybe (Object String))
, clusterName :: (Maybe String)
, creationTimestamp :: (Maybe Time)
, deletionGracePeriodSeconds :: (Maybe Int)
, deletionTimestamp :: (Maybe Time)
, finalizers :: (Maybe (Array String))
, generateName :: (Maybe String)
, generation :: (Maybe Int)
, initializers :: (Maybe Initializers)
, labels :: (Maybe (Object String))
, name :: (Maybe String)
, namespace :: (Maybe String)
, ownerReferences :: (Maybe (Array OwnerReference))
, resourceVersion :: (Maybe String)
, selfLink :: (Maybe String)
, uid :: (Maybe String) }
derive instance newtypeObjectMeta :: Newtype ObjectMeta _
derive instance genericObjectMeta :: Generic ObjectMeta _
instance showObjectMeta :: Show ObjectMeta where show a = genericShow a
instance decodeObjectMeta :: Decode ObjectMeta where
decode a = do
annotations <- decodeMaybe "annotations" a
clusterName <- decodeMaybe "clusterName" a
creationTimestamp <- decodeMaybe "creationTimestamp" a
deletionGracePeriodSeconds <- decodeMaybe "deletionGracePeriodSeconds" a
deletionTimestamp <- decodeMaybe "deletionTimestamp" a
finalizers <- decodeMaybe "finalizers" a
generateName <- decodeMaybe "generateName" a
generation <- decodeMaybe "generation" a
initializers <- decodeMaybe "initializers" a
labels <- decodeMaybe "labels" a
name <- decodeMaybe "name" a
namespace <- decodeMaybe "namespace" a
ownerReferences <- decodeMaybe "ownerReferences" a
resourceVersion <- decodeMaybe "resourceVersion" a
selfLink <- decodeMaybe "selfLink" a
uid <- decodeMaybe "uid" a
pure $ ObjectMeta { annotations, clusterName, creationTimestamp, deletionGracePeriodSeconds, deletionTimestamp, finalizers, generateName, generation, initializers, labels, name, namespace, ownerReferences, resourceVersion, selfLink, uid }
instance encodeObjectMeta :: Encode ObjectMeta where
encode (ObjectMeta a) = encode $ Object.fromFoldable $
[ Tuple "annotations" (encodeMaybe a.annotations)
, Tuple "clusterName" (encodeMaybe a.clusterName)
, Tuple "creationTimestamp" (encodeMaybe a.creationTimestamp)
, Tuple "deletionGracePeriodSeconds" (encodeMaybe a.deletionGracePeriodSeconds)
, Tuple "deletionTimestamp" (encodeMaybe a.deletionTimestamp)
, Tuple "finalizers" (encodeMaybe a.finalizers)
, Tuple "generateName" (encodeMaybe a.generateName)
, Tuple "generation" (encodeMaybe a.generation)
, Tuple "initializers" (encodeMaybe a.initializers)
, Tuple "labels" (encodeMaybe a.labels)
, Tuple "name" (encodeMaybe a.name)
, Tuple "namespace" (encodeMaybe a.namespace)
, Tuple "ownerReferences" (encodeMaybe a.ownerReferences)
, Tuple "resourceVersion" (encodeMaybe a.resourceVersion)
, Tuple "selfLink" (encodeMaybe a.selfLink)
, Tuple "uid" (encodeMaybe a.uid) ]
instance defaultObjectMeta :: Default ObjectMeta where
default = ObjectMeta
{ annotations: Nothing
, clusterName: Nothing
, creationTimestamp: Nothing
, deletionGracePeriodSeconds: Nothing
, deletionTimestamp: Nothing
, finalizers: Nothing
, generateName: Nothing
, generation: Nothing
, initializers: Nothing
, labels: Nothing
, name: Nothing
, namespace: Nothing
, ownerReferences: Nothing
, resourceVersion: Nothing
, selfLink: Nothing
, uid: Nothing }
-- | OwnerReference contains enough information to let you identify an owning object. Currently, an owning object must be in the same namespace, so there is no namespace field.
-- |
-- | Fields:
-- | - `apiVersion`: API version of the referent.
-- | - `blockOwnerDeletion`: If true, AND if the owner has the "foregroundDeletion" finalizer, then the owner cannot be deleted from the key-value store until this reference is removed. Defaults to false. To set this field, a user needs "delete" permission of the owner, otherwise 422 (Unprocessable Entity) will be returned.
-- | - `controller`: If true, this reference points to the managing controller.
-- | - `kind`: Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
-- | - `name`: Name of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#names
-- | - `uid`: UID of the referent. More info: http://kubernetes.io/docs/user-guide/identifiers#uids
newtype OwnerReference = OwnerReference
{ apiVersion :: (Maybe String)
, blockOwnerDeletion :: (Maybe Boolean)
, controller :: (Maybe Boolean)
, kind :: (Maybe String)
, name :: (Maybe String)
, uid :: (Maybe String) }
derive instance newtypeOwnerReference :: Newtype OwnerReference _
derive instance genericOwnerReference :: Generic OwnerReference _
instance showOwnerReference :: Show OwnerReference where show a = genericShow a
instance decodeOwnerReference :: Decode OwnerReference where
decode a = do
apiVersion <- decodeMaybe "apiVersion" a
blockOwnerDeletion <- decodeMaybe "blockOwnerDeletion" a
controller <- decodeMaybe "controller" a
kind <- decodeMaybe "kind" a
name <- decodeMaybe "name" a
uid <- decodeMaybe "uid" a
pure $ OwnerReference { apiVersion, blockOwnerDeletion, controller, kind, name, uid }
instance encodeOwnerReference :: Encode OwnerReference where
encode (OwnerReference a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encodeMaybe a.apiVersion)
, Tuple "blockOwnerDeletion" (encodeMaybe a.blockOwnerDeletion)
, Tuple "controller" (encodeMaybe a.controller)
, Tuple "kind" (encodeMaybe a.kind)
, Tuple "name" (encodeMaybe a.name)
, Tuple "uid" (encodeMaybe a.uid) ]
instance defaultOwnerReference :: Default OwnerReference where
default = OwnerReference
{ apiVersion: Nothing
, blockOwnerDeletion: Nothing
, controller: Nothing
, kind: Nothing
, name: Nothing
, uid: Nothing }
-- | Preconditions must be fulfilled before an operation (update, delete, etc.) is carried out.
-- |
-- | Fields:
-- | - `uid`: Specifies the target UID.
newtype Preconditions = Preconditions
{ uid :: (Maybe String) }
derive instance newtypePreconditions :: Newtype Preconditions _
derive instance genericPreconditions :: Generic Preconditions _
instance showPreconditions :: Show Preconditions where show a = genericShow a
instance decodePreconditions :: Decode Preconditions where
decode a = do
uid <- decodeMaybe "uid" a
pure $ Preconditions { uid }
instance encodePreconditions :: Encode Preconditions where
encode (Preconditions a) = encode $ Object.fromFoldable $
[ Tuple "uid" (encodeMaybe a.uid) ]
instance defaultPreconditions :: Default Preconditions where
default = Preconditions
{ uid: Nothing }
-- | ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.
-- |
-- | Fields:
-- | - `clientCIDR`: The CIDR with which clients can match their IP to figure out the server address that they should use.
-- | - `serverAddress`: Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.
newtype ServerAddressByClientCIDR = ServerAddressByClientCIDR
{ clientCIDR :: (Maybe String)
, serverAddress :: (Maybe String) }
derive instance newtypeServerAddressByClientCIDR :: Newtype ServerAddressByClientCIDR _
derive instance genericServerAddressByClientCIDR :: Generic ServerAddressByClientCIDR _
instance showServerAddressByClientCIDR :: Show ServerAddressByClientCIDR where show a = genericShow a
instance decodeServerAddressByClientCIDR :: Decode ServerAddressByClientCIDR where
decode a = do
clientCIDR <- decodeMaybe "clientCIDR" a
serverAddress <- decodeMaybe "serverAddress" a
pure $ ServerAddressByClientCIDR { clientCIDR, serverAddress }
instance encodeServerAddressByClientCIDR :: Encode ServerAddressByClientCIDR where
encode (ServerAddressByClientCIDR a) = encode $ Object.fromFoldable $
[ Tuple "clientCIDR" (encodeMaybe a.clientCIDR)
, Tuple "serverAddress" (encodeMaybe a.serverAddress) ]
instance defaultServerAddressByClientCIDR :: Default ServerAddressByClientCIDR where
default = ServerAddressByClientCIDR
{ clientCIDR: Nothing
, serverAddress: Nothing }
-- | Status is a return value for calls that don't return other objects.
-- |
-- | Fields:
-- | - `code`: Suggested HTTP return code for this status, 0 if not set.
-- | - `details`: Extended data associated with the reason. Each reason may define its own extended details. This field is optional and the data returned is not guaranteed to conform to any schema except that defined by the reason type.
-- | - `message`: A human-readable description of the status of this operation.
-- | - `metadata`: Standard list metadata. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
-- | - `reason`: A machine-readable description of why this operation is in the "Failure" status. If this value is empty there is no information available. A Reason clarifies an HTTP status code but does not override it.
-- | - `status`: Status of the operation. One of: "Success" or "Failure". More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status
newtype Status = Status
{ code :: (Maybe Int)
, details :: (Maybe StatusDetails)
, message :: (Maybe String)
, metadata :: (Maybe ListMeta)
, reason :: (Maybe String)
, status :: (Maybe String) }
derive instance newtypeStatus :: Newtype Status _
derive instance genericStatus :: Generic Status _
instance showStatus :: Show Status where show a = genericShow a
instance decodeStatus :: Decode Status where
decode a = do
assertPropEq "apiVersion" "v1" a
code <- decodeMaybe "code" a
details <- decodeMaybe "details" a
assertPropEq "kind" "Status" a
message <- decodeMaybe "message" a
metadata <- decodeMaybe "metadata" a
reason <- decodeMaybe "reason" a
status <- decodeMaybe "status" a
pure $ Status { code, details, message, metadata, reason, status }
instance encodeStatus :: Encode Status where
encode (Status a) = encode $ Object.fromFoldable $
[ Tuple "apiVersion" (encode "v1")
, Tuple "code" (encodeMaybe a.code)
, Tuple "details" (encodeMaybe a.details)
, Tuple "kind" (encode "Status")
, Tuple "message" (encodeMaybe a.message)
, Tuple "metadata" (encodeMaybe a.metadata)
, Tuple "reason" (encodeMaybe a.reason)
, Tuple "status" (encodeMaybe a.status) ]
instance defaultStatus :: Default Status where
default = Status
{ code: Nothing
, details: Nothing
, message: Nothing
, metadata: Nothing
, reason: Nothing
, status: Nothing }
-- | StatusCause provides more information about an api.Status failure, including cases when multiple errors are encountered.
-- |
-- | Fields:
-- | - `field`: The field of the resource that has caused this error, as named by its JSON serialization. May include dot and postfix notation for nested attributes. Arrays are zero-indexed. Fields may appear more than once in an array of causes due to fields having multiple errors. Optional.
-- |
-- | Examples:
-- | "name" - the field "name" on the current resource
-- | "items[0].name" - the field "name" on the first array entry in "items"
-- | - `message`: A human-readable description of the cause of the error. This field may be presented as-is to a reader.
-- | - `reason`: A machine-readable description of the cause of the error. If this value is empty there is no information available.
newtype StatusCause = StatusCause
{ field :: (Maybe String)
, message :: (Maybe String)
, reason :: (Maybe String) }
derive instance newtypeStatusCause :: Newtype StatusCause _
derive instance genericStatusCause :: Generic StatusCause _
instance showStatusCause :: Show StatusCause where show a = genericShow a
instance decodeStatusCause :: Decode StatusCause where
decode a = do
field <- decodeMaybe "field" a
message <- decodeMaybe "message" a
reason <- decodeMaybe "reason" a
pure $ StatusCause { field, message, reason }
instance encodeStatusCause :: Encode StatusCause where
encode (StatusCause a) = encode $ Object.fromFoldable $
[ Tuple "field" (encodeMaybe a.field)
, Tuple "message" (encodeMaybe a.message)
, Tuple "reason" (encodeMaybe a.reason) ]
instance defaultStatusCause :: Default StatusCause where
default = StatusCause
{ field: Nothing
, message: Nothing
, reason: Nothing }
-- | StatusDetails is a set of additional properties that MAY be set by the server to provide additional information about a response. The Reason field of a Status object defines what attributes will be set. Clients must ignore fields that do not match the defined type of each attribute, and should assume that any attribute may be empty, invalid, or under defined.
-- |
-- | Fields:
-- | - `causes`: The Causes array includes more details associated with the StatusReason failure. Not all StatusReasons may provide detailed causes.
-- | - `group`: The group attribute of the resource associated with the status StatusReason.
-- | - `kind`: The kind attribute of the resource associated with the status StatusReason. On some operations may differ from the requested resource Kind. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
-- | - `name`: The name attribute of the resource associated with the status StatusReason (when there is a single name which can be described).
-- | - `retryAfterSeconds`: If specified, the time in seconds before the operation should be retried. Some errors may indicate the client must take an alternate action - for those errors this field may indicate how long to wait before taking the alternate action.
-- | - `uid`: UID of the resource. (when there is a single resource which can be described). More info: http://kubernetes.io/docs/user-guide/identifiers#uids
newtype StatusDetails = StatusDetails
{ causes :: (Maybe (Array StatusCause))
, group :: (Maybe String)
, kind :: (Maybe String)
, name :: (Maybe String)
, retryAfterSeconds :: (Maybe Int)
, uid :: (Maybe String) }
derive instance newtypeStatusDetails :: Newtype StatusDetails _
derive instance genericStatusDetails :: Generic StatusDetails _
instance showStatusDetails :: Show StatusDetails where show a = genericShow a
instance decodeStatusDetails :: Decode StatusDetails where
decode a = do
causes <- decodeMaybe "causes" a
group <- decodeMaybe "group" a
kind <- decodeMaybe "kind" a
name <- decodeMaybe "name" a
retryAfterSeconds <- decodeMaybe "retryAfterSeconds" a
uid <- decodeMaybe "uid" a
pure $ StatusDetails { causes, group, kind, name, retryAfterSeconds, uid }
instance encodeStatusDetails :: Encode StatusDetails where
encode (StatusDetails a) = encode $ Object.fromFoldable $
[ Tuple "causes" (encodeMaybe a.causes)
, Tuple "group" (encodeMaybe a.group)
, Tuple "kind" (encodeMaybe a.kind)
, Tuple "name" (encodeMaybe a.name)
, Tuple "retryAfterSeconds" (encodeMaybe a.retryAfterSeconds)
, Tuple "uid" (encodeMaybe a.uid) ]
instance defaultStatusDetails :: Default StatusDetails where
default = StatusDetails
{ causes: Nothing
, group: Nothing
, kind: Nothing
, name: Nothing
, retryAfterSeconds: Nothing
, uid: Nothing }
newtype Time = Time String
derive instance newtypeTime :: Newtype Time _
derive instance genericTime :: Generic Time _
instance showTime :: Show Time where show a = genericShow a
instance decodeTime :: Decode Time where
decode a = genericDecode jsonOptions a
instance encodeTime :: Encode Time where
encode a = genericEncode jsonOptions a
-- | Event represents a single event to a watched resource.
-- |
-- | Fields:
-- | - `_type`
-- | - `object`: Object is:
-- | * If Type is Added or Modified: the new state of the object.
-- | * If Type is Deleted: the state of the object immediately before deletion.
-- | * If Type is Error: *Status is recommended; other types may make sense
-- | depending on context.
newtype WatchEvent = WatchEvent
{ _type :: (Maybe String)
, object :: (Maybe Runtime.RawExtension) }
derive instance newtypeWatchEvent :: Newtype WatchEvent _
derive instance genericWatchEvent :: Generic WatchEvent _
instance showWatchEvent :: Show WatchEvent where show a = genericShow a
instance decodeWatchEvent :: Decode WatchEvent where
decode a = do
_type <- decodeMaybe "_type" a
object <- decodeMaybe "object" a
pure $ WatchEvent { _type, object }
instance encodeWatchEvent :: Encode WatchEvent where
encode (WatchEvent a) = encode $ Object.fromFoldable $
[ Tuple "_type" (encodeMaybe a._type)
, Tuple "object" (encodeMaybe a.object) ]
instance defaultWatchEvent :: Default WatchEvent where
default = WatchEvent
{ _type: Nothing
, object: Nothing }