forked from kubernetes-retired/service-catalog
/
types.go
1480 lines (1235 loc) · 61.2 KB
/
types.go
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
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Copyright 2016 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package v1beta1
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
)
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ClusterServiceBroker represents an entity that provides
// ClusterServiceClasses for use in the service catalog.
// +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,URL:.spec.url
type ClusterServiceBroker struct {
metav1.TypeMeta `json:",inline"`
// Non-namespaced. The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the broker.
// +optional
Spec ClusterServiceBrokerSpec `json:"spec,omitempty"`
// Status represents the current status of a broker.
// +optional
Status ClusterServiceBrokerStatus `json:"status,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ClusterServiceBrokerList is a list of Brokers.
type ClusterServiceBrokerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ClusterServiceBroker `json:"items"`
}
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServiceBroker represents an entity that provides
// ServiceClasses for use in the service catalog.
// +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,URL:.spec.url
type ServiceBroker struct {
metav1.TypeMeta `json:",inline"`
// The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the broker.
// +optional
Spec ServiceBrokerSpec `json:"spec,omitempty"`
// Status represents the current status of a broker.
// +optional
Status ServiceBrokerStatus `json:"status,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServiceBrokerList is a list of Brokers.
type ServiceBrokerList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ServiceBroker `json:"items"`
}
// CommonServiceBrokerSpec represents a description of a Broker.
type CommonServiceBrokerSpec struct {
// URL is the address used to communicate with the ServiceBroker.
URL string `json:"url"`
// InsecureSkipTLSVerify disables TLS certificate verification when communicating with this Broker.
// This is strongly discouraged. You should use the CABundle instead.
// +optional
InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
// CABundle is a PEM encoded CA bundle which will be used to validate a Broker's serving certificate.
// +optional
CABundle []byte `json:"caBundle,omitempty"`
// RelistBehavior specifies the type of relist behavior the catalog should
// exhibit when relisting ServiceClasses available from a broker.
// +optional
RelistBehavior ServiceBrokerRelistBehavior `json:"relistBehavior"`
// RelistDuration is the frequency by which a controller will relist the
// broker when the RelistBehavior is set to ServiceBrokerRelistBehaviorDuration.
// Users are cautioned against configuring low values for the RelistDuration,
// as this can easily overload the controller manager in an environment with
// many brokers. The actual interval is intrinsically governed by the
// configured resync interval of the controller, which acts as a minimum bound.
// For example, with a resync interval of 5m and a RelistDuration of 2m, relists
// will occur at the resync interval of 5m.
RelistDuration *metav1.Duration `json:"relistDuration,omitempty"`
// RelistRequests is a strictly increasing, non-negative integer counter that
// can be manually incremented by a user to manually trigger a relist.
// +optional
RelistRequests int64 `json:"relistRequests"`
// CatalogRestrictions is a set of restrictions on which of a broker's services
// and plans have resources created for them.
// +optional
CatalogRestrictions *CatalogRestrictions `json:"catalogRestrictions,omitempty"`
}
// CatalogRestrictions is a set of restrictions on which of a broker's services
// and plans have resources created for them.
//
// Some examples of this object are as follows:
//
// This is an example of a whitelist on service externalName.
// Goal: Only list Services with the externalName of FooService and BarService,
// Solution: restrictions := ServiceCatalogRestrictions{
// ServiceClass: ["spec.externalName in (FooService, BarService)"]
// }
//
// This is an example of a blacklist on service externalName.
// Goal: Allow all services except the ones with the externalName of FooService and BarService,
// Solution: restrictions := ServiceCatalogRestrictions{
// ServiceClass: ["spec.externalName notin (FooService, BarService)"]
// }
//
// This whitelists plans called "Demo", and blacklists (but only a single element in
// the list) a service and a plan.
// Goal: Allow all plans with the externalName demo, but not AABBCC, and not a specific service by name,
// Solution: restrictions := ServiceCatalogRestrictions{
// ServiceClass: ["name!=AABBB-CCDD-EEGG-HIJK"]
// ServicePlan: ["spec.externalName in (Demo)", "name!=AABBCC"]
// }
//
// CatalogRestrictions strings have a special format similar to Label Selectors,
// except the catalog supports only a very specific property set.
//
// The predicate format is expected to be `<property><conditional><requirement>`
// Check the *Requirements type definition for which <property> strings will be allowed.
// <conditional> is allowed to be one of the following: ==, !=, in, notin
// <requirement> will be a string value if `==` or `!=` are used.
// <requirement> will be a set of string values if `in` or `notin` are used.
// Multiple predicates are allowed to be chained with a comma (,)
//
// ServiceClass allowed property names:
// name - the value set to [Cluster]ServiceClass.Name
// spec.externalName - the value set to [Cluster]ServiceClass.Spec.ExternalName
// spec.externalID - the value set to [Cluster]ServiceClass.Spec.ExternalID
// ServicePlan allowed property names:
// name - the value set to [Cluster]ServicePlan.Name
// spec.externalName - the value set to [Cluster]ServicePlan.Spec.ExternalName
// spec.externalID - the value set to [Cluster]ServicePlan.Spec.ExternalID
// spec.free - the value set to [Cluster]ServicePlan.Spec.Free
// spec.serviceClass.name - the value set to ServicePlan.Spec.ServiceClassRef.Name
// spec.clusterServiceClass.name - the value set to ClusterServicePlan.Spec.ClusterServiceClassRef.Name
type CatalogRestrictions struct {
// ServiceClass represents a selector for plans, used to filter catalog re-lists.
ServiceClass []string `json:"serviceClass,omitempty"`
// ServicePlan represents a selector for classes, used to filter catalog re-lists.
ServicePlan []string `json:"servicePlan,omitempty"`
}
// ClusterServiceBrokerSpec represents a description of a Broker.
type ClusterServiceBrokerSpec struct {
CommonServiceBrokerSpec `json:",inline"`
// AuthInfo contains the data that the service catalog should use to authenticate
// with the ClusterServiceBroker.
AuthInfo *ClusterServiceBrokerAuthInfo `json:"authInfo,omitempty"`
}
// ServiceBrokerSpec represents a description of a Broker.
type ServiceBrokerSpec struct {
CommonServiceBrokerSpec `json:",inline"`
// AuthInfo contains the data that the service catalog should use to authenticate
// with the ServiceBroker.
AuthInfo *ServiceBrokerAuthInfo `json:"authInfo,omitempty"`
}
// ServiceBrokerRelistBehavior represents a type of broker relist behavior.
type ServiceBrokerRelistBehavior string
const (
// ServiceBrokerRelistBehaviorDuration indicates that the broker will be
// relisted automatically after the specified duration has passed.
ServiceBrokerRelistBehaviorDuration ServiceBrokerRelistBehavior = "Duration"
// ServiceBrokerRelistBehaviorManual indicates that the broker is only
// relisted when the spec of the broker changes.
ServiceBrokerRelistBehaviorManual ServiceBrokerRelistBehavior = "Manual"
)
// ClusterServiceBrokerAuthInfo is a union type that contains information on
// one of the authentication methods the service catalog and brokers may
// support, according to the OpenServiceBroker API specification
// (https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md).
type ClusterServiceBrokerAuthInfo struct {
// ClusterBasicAuthConfigprovides configuration for basic authentication.
Basic *ClusterBasicAuthConfig `json:"basic,omitempty"`
// ClusterBearerTokenAuthConfig provides configuration to send an opaque value as a bearer token.
// The value is referenced from the 'token' field of the given secret. This value should only
// contain the token value and not the `Bearer` scheme.
Bearer *ClusterBearerTokenAuthConfig `json:"bearer,omitempty"`
}
// ClusterBasicAuthConfig provides config for the basic authentication of
// cluster scoped brokers.
type ClusterBasicAuthConfig struct {
// SecretRef is a reference to a Secret containing information the
// catalog should use to authenticate to this ServiceBroker.
//
// Required at least one of the fields:
// - Secret.Data["username"] - username used for authentication
// - Secret.Data["password"] - password or token needed for authentication
SecretRef *ObjectReference `json:"secretRef,omitempty"`
}
// ClusterBearerTokenAuthConfig provides config for the bearer token
// authentication of cluster scoped brokers.
type ClusterBearerTokenAuthConfig struct {
// SecretRef is a reference to a Secret containing information the
// catalog should use to authenticate to this ServiceBroker.
//
// Required field:
// - Secret.Data["token"] - bearer token for authentication
SecretRef *ObjectReference `json:"secretRef,omitempty"`
}
// ServiceBrokerAuthInfo is a union type that contains information on
// one of the authentication methods the service catalog and brokers may
// support, according to the OpenServiceBroker API specification
// (https://github.com/openservicebrokerapi/servicebroker/blob/master/spec.md).
type ServiceBrokerAuthInfo struct {
// BasicAuthConfig provides configuration for basic authentication.
Basic *BasicAuthConfig `json:"basic,omitempty"`
// BearerTokenAuthConfig provides configuration to send an opaque value as a bearer token.
// The value is referenced from the 'token' field of the given secret. This value should only
// contain the token value and not the `Bearer` scheme.
Bearer *BearerTokenAuthConfig `json:"bearer,omitempty"`
}
// BasicAuthConfig provides config for the basic authentication of
// cluster scoped brokers.
type BasicAuthConfig struct {
// SecretRef is a reference to a Secret containing information the
// catalog should use to authenticate to this ServiceBroker.
//
// Required at least one of the fields:
// - Secret.Data["username"] - username used for authentication
// - Secret.Data["password"] - password or token needed for authentication
SecretRef *LocalObjectReference `json:"secretRef,omitempty"`
}
// BearerTokenAuthConfig provides config for the bearer token
// authentication of cluster scoped brokers.
type BearerTokenAuthConfig struct {
// SecretRef is a reference to a Secret containing information the
// catalog should use to authenticate to this ServiceBroker.
//
// Required field:
// - Secret.Data["token"] - bearer token for authentication
SecretRef *LocalObjectReference `json:"secretRef,omitempty"`
}
const (
// BasicAuthUsernameKey is the key of the username for SecretTypeBasicAuth secrets
BasicAuthUsernameKey = "username"
// BasicAuthPasswordKey is the key of the password or token for SecretTypeBasicAuth secrets
BasicAuthPasswordKey = "password"
// BearerTokenKey is the key of the bearer token for SecretTypeBearerTokenAuth secrets
BearerTokenKey = "token"
)
// CommonServiceBrokerStatus represents the current status of a Broker.
type CommonServiceBrokerStatus struct {
Conditions []ServiceBrokerCondition `json:"conditions"`
// ReconciledGeneration is the 'Generation' of the ClusterServiceBrokerSpec that
// was last processed by the controller. The reconciled generation is updated
// even if the controller failed to process the spec.
ReconciledGeneration int64 `json:"reconciledGeneration"`
// OperationStartTime is the time at which the current operation began.
OperationStartTime *metav1.Time `json:"operationStartTime,omitempty"`
// LastCatalogRetrievalTime is the time the Catalog was last fetched from
// the Service Broker
LastCatalogRetrievalTime *metav1.Time `json:"lastCatalogRetrievalTime,omitempty"`
}
// ClusterServiceBrokerStatus represents the current status of a
// ClusterServiceBroker.
type ClusterServiceBrokerStatus struct {
CommonServiceBrokerStatus `json:",inline"`
}
// ServiceBrokerStatus the current status of a ServiceBroker.
type ServiceBrokerStatus struct {
CommonServiceBrokerStatus `json:",inline"`
}
// ServiceBrokerCondition contains condition information for a Broker.
type ServiceBrokerCondition struct {
// Type of the condition, currently ('Ready').
Type ServiceBrokerConditionType `json:"type"`
// Status of the condition, one of ('True', 'False', 'Unknown').
Status ConditionStatus `json:"status"`
// LastTransitionTime is the timestamp corresponding to the last status
// change of this condition.
LastTransitionTime metav1.Time `json:"lastTransitionTime"`
// Reason is a brief machine readable explanation for the condition's last
// transition.
Reason string `json:"reason"`
// Message is a human readable description of the details of the last
// transition, complementing reason.
Message string `json:"message"`
}
// ServiceBrokerConditionType represents a broker condition value.
type ServiceBrokerConditionType string
const (
// ServiceBrokerConditionReady represents the fact that a given broker condition
// is in ready state.
ServiceBrokerConditionReady ServiceBrokerConditionType = "Ready"
// ServiceBrokerConditionFailed represents information about a final failure
// that should not be retried.
ServiceBrokerConditionFailed ServiceBrokerConditionType = "Failed"
)
// ConditionStatus represents a condition's status.
type ConditionStatus string
// These are valid condition statuses. "ConditionTrue" means a resource is in
// the condition; "ConditionFalse" means a resource is not in the condition;
// "ConditionUnknown" means kubernetes can't decide if a resource is in the
// condition or not. In the future, we could add other intermediate
// conditions, e.g. ConditionDegraded.
const (
// ConditionTrue represents the fact that a given condition is true
ConditionTrue ConditionStatus = "True"
// ConditionFalse represents the fact that a given condition is false
ConditionFalse ConditionStatus = "False"
// ConditionUnknown represents the fact that a given condition is unknown
ConditionUnknown ConditionStatus = "Unknown"
)
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ClusterServiceClassList is a list of ClusterServiceClasses.
type ClusterServiceClassList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ClusterServiceClass `json:"items"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ClusterServiceClass represents an offering in the service catalog.
// +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,EXTERNAL NAME:.spec.externalName,BROKER:.spec.clusterServiceBrokerName,BINDABLE:.spec.bindable,PLAN UPDATABLE:.spec.planUpdatable
type ClusterServiceClass struct {
metav1.TypeMeta `json:",inline"`
// Non-namespaced. The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the cluster service class.
// +optional
Spec ClusterServiceClassSpec `json:"spec,omitempty"`
// Status represents the current status of the cluster service class.
// +optional
Status ClusterServiceClassStatus `json:"status,omitempty"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServiceClassList is a list of ServiceClasses.
type ServiceClassList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ServiceClass `json:"items"`
}
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServiceClass represents a namespaced offering in the service catalog.
type ServiceClass struct {
metav1.TypeMeta `json:",inline"`
// The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the service class.
// +optional
Spec ServiceClassSpec `json:"spec,omitempty"`
// Status represents the current status of a service class.
// +optional
Status ServiceClassStatus `json:"status,omitempty"`
}
// ServiceClassStatus represents status information about a ServiceClass.
type ServiceClassStatus struct {
CommonServiceClassStatus `json:",inline"`
}
// ClusterServiceClassStatus represents status information about a
// ClusterServiceClass.
type ClusterServiceClassStatus struct {
CommonServiceClassStatus `json:",inline"`
}
// CommonServiceClassStatus represents common status information between
// cluster scoped and namespace scoped ServiceClasses.
type CommonServiceClassStatus struct {
// RemovedFromBrokerCatalog indicates that the broker removed the service from its
// catalog.
RemovedFromBrokerCatalog bool `json:"removedFromBrokerCatalog"`
}
// CommonServiceClassSpec represents details about a ServiceClass
type CommonServiceClassSpec struct {
// ExternalName is the name of this object that the Service Broker
// exposed this Service Class as. Mutable.
ExternalName string `json:"externalName"`
// ExternalID is the identity of this object for use with the OSB API.
//
// Immutable.
ExternalID string `json:"externalID"`
// Description is a short description of this ServiceClass.
Description string `json:"description"`
// Bindable indicates whether a user can create bindings to an
// ServiceInstance provisioned from this service. ServicePlan
// has an optional field called Bindable which overrides the value of
// this field.
Bindable bool `json:"bindable"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// BindingRetrievable indicates whether fetching a binding via a GET on
// its endpoint is supported for all plans.
BindingRetrievable bool `json:"bindingRetrievable"`
// PlanUpdatable indicates whether instances provisioned from this
// ServiceClass may change ServicePlans after being
// provisioned.
PlanUpdatable bool `json:"planUpdatable"`
// ExternalMetadata is a blob of information about the
// ServiceClass, meant to be user-facing content and display
// instructions. This field may contain platform-specific conventional
// values.
ExternalMetadata *runtime.RawExtension `json:"externalMetadata,omitempty"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// Tags is a list of strings that represent different classification
// attributes of the ServiceClass. These are used in Cloud
// Foundry in a way similar to Kubernetes labels, but they currently
// have no special meaning in Kubernetes.
Tags []string `json:"tags,omitempty"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// Requires exposes a list of Cloud Foundry-specific 'permissions'
// that must be granted to an instance of this service within Cloud
// Foundry. These 'permissions' have no meaning within Kubernetes and an
// ServiceInstance provisioned from this ServiceClass will not
// work correctly.
Requires []string `json:"requires,omitempty"`
// DefaultProvisionParameters are default parameters passed to the broker
// when an instance of this class is provisioned. Any parameters defined on
// the plan and instance are merged with these defaults, with
// plan and then instance-defined parameters taking precedence over the class
// defaults.
DefaultProvisionParameters *runtime.RawExtension `json:"defaultProvisionParameters,omitempty"`
}
// ClusterServiceClassSpec represents the details about a ClusterServiceClass
type ClusterServiceClassSpec struct {
CommonServiceClassSpec `json:",inline"`
// ClusterServiceBrokerName is the reference to the Broker that provides this
// ClusterServiceClass.
//
// Immutable.
ClusterServiceBrokerName string `json:"clusterServiceBrokerName"`
}
// ServiceClassSpec represents the details about a ServiceClass
type ServiceClassSpec struct {
CommonServiceClassSpec `json:",inline"`
// ServiceBrokerName is the reference to the Broker that provides this
// ServiceClass.
//
// Immutable.
ServiceBrokerName string `json:"serviceBrokerName"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ClusterServicePlanList is a list of ClusterServicePlans.
type ClusterServicePlanList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ClusterServicePlan `json:"items"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ClusterServicePlan represents a tier of a ServiceClass.
// +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,EXTERNAL NAME:.spec.externalName,BROKER:.spec.clusterServiceBrokerName,CLASS:.spec.clusterServiceClassRef.name
type ClusterServicePlan struct {
metav1.TypeMeta `json:",inline"`
// Non-namespaced. The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the service plan.
// +optional
Spec ClusterServicePlanSpec `json:"spec,omitempty"`
// Status represents the current status of the service plan.
// +optional
Status ClusterServicePlanStatus `json:"status,omitempty"`
}
// CommonServicePlanSpec represents details that are shared by both
// a ClusterServicePlan and a namespaced ServicePlan
type CommonServicePlanSpec struct {
// ExternalName is the name of this object that the Service Broker
// exposed this Service Plan as. Mutable.
ExternalName string `json:"externalName"`
// ExternalID is the identity of this object for use with the OSB API.
//
// Immutable.
ExternalID string `json:"externalID"`
// Description is a short description of this ServicePlan.
Description string `json:"description"`
// Bindable indicates whether a user can create bindings to an
// ServiceInstance using this ServicePlan. If set, overrides
// the value of the corresponding ServiceClassSpec Bindable field.
Bindable *bool `json:"bindable,omitempty"`
// Free indicates whether this plan is available at no cost.
Free bool `json:"free"`
// ExternalMetadata is a blob of information about the plan, meant to be
// user-facing content and display instructions. This field may contain
// platform-specific conventional values.
ExternalMetadata *runtime.RawExtension `json:"externalMetadata,omitempty"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// InstanceCreateParameterSchema is the schema for the parameters
// that may be supplied when provisioning a new ServiceInstance on this plan.
InstanceCreateParameterSchema *runtime.RawExtension `json:"instanceCreateParameterSchema,omitempty"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// InstanceUpdateParameterSchema is the schema for the parameters
// that may be updated once an ServiceInstance has been provisioned on
// this plan. This field only has meaning if the corresponding ServiceClassSpec is
// PlanUpdatable.
InstanceUpdateParameterSchema *runtime.RawExtension `json:"instanceUpdateParameterSchema,omitempty"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// ServiceBindingCreateParameterSchema is the schema for the parameters that
// may be supplied binding to a ServiceInstance on this plan.
ServiceBindingCreateParameterSchema *runtime.RawExtension `json:"serviceBindingCreateParameterSchema,omitempty"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.when a bind operation stored in the
// Secret when binding to a ServiceInstance on this plan.
// The ResponseSchema feature gate needs to be enabled for this field to
// be populated.
//
// ServiceBindingCreateResponseSchema is the schema for the response that
// will be returned by the broker when binding to a ServiceInstance on this plan.
// The schema also contains the sub-schema for the credentials part of the
// broker's response, which allows clients to see what the credentials
// will look like even before the binding operation is performed.
ServiceBindingCreateResponseSchema *runtime.RawExtension `json:"serviceBindingCreateResponseSchema,omitempty"`
// DefaultProvisionParameters are default parameters passed to the broker
// when an instance of this plan is provisioned. Any parameters defined on
// the instance are merged with these defaults, with instance-defined
// parameters taking precedence over defaults.
DefaultProvisionParameters *runtime.RawExtension `json:"defaultProvisionParameters,omitempty"`
}
// ClusterServicePlanSpec represents details about a ClusterServicePlan.
type ClusterServicePlanSpec struct {
// CommonServicePlanSpec contains the common details of this ClusterServicePlan
CommonServicePlanSpec `json:",inline"`
// ClusterServiceBrokerName is the name of the ClusterServiceBroker
// that offers this ClusterServicePlan.
ClusterServiceBrokerName string `json:"clusterServiceBrokerName"`
// ClusterServiceClassRef is a reference to the service class that
// owns this plan.
ClusterServiceClassRef ClusterObjectReference `json:"clusterServiceClassRef"`
}
// ClusterServicePlanStatus represents status information about a
// ClusterServicePlan.
type ClusterServicePlanStatus struct {
CommonServicePlanStatus `json:",inline"`
}
// CommonServicePlanStatus represents status information about a
// ClusterServicePlan or a ServicePlan.
type CommonServicePlanStatus struct {
// RemovedFromBrokerCatalog indicates that the broker removed the plan
// from its catalog.
RemovedFromBrokerCatalog bool `json:"removedFromBrokerCatalog"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServicePlanList is a list of rServicePlans.
type ServicePlanList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ServicePlan `json:"items"`
}
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServicePlan represents a tier of a ServiceClass.
// +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,EXTERNAL NAME:.spec.externalName,BROKER:.spec.serviceBrokerName,CLASS:.spec.serviceClassRef.name
type ServicePlan struct {
metav1.TypeMeta `json:",inline"`
// Non-namespaced. The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the service plan.
// +optional
Spec ServicePlanSpec `json:"spec,omitempty"`
// Status represents the current status of the service plan.
// +optional
Status ServicePlanStatus `json:"status,omitempty"`
}
// ServicePlanSpec represents details about a ServicePlan.
type ServicePlanSpec struct {
// CommonServicePlanSpec contains the common details of this ServicePlan
CommonServicePlanSpec `json:",inline"`
// ServiceBrokerName is the name of the ServiceBroker
// that offers this ServicePlan.
ServiceBrokerName string `json:"serviceBrokerName"`
// ServiceClassRef is a reference to the service class that
// owns this plan.
ServiceClassRef LocalObjectReference `json:"serviceClassRef"`
}
// ServicePlanStatus represents status information about a
// ServicePlan.
type ServicePlanStatus struct {
CommonServicePlanStatus `json:",inline"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServiceInstanceList is a list of instances.
type ServiceInstanceList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ServiceInstance `json:"items"`
}
// UserInfo holds information about the user that last changed a resource's spec.
type UserInfo struct {
Username string `json:"username"`
UID string `json:"uid"`
Groups []string `json:"groups,omitempty"`
Extra map[string]ExtraValue `json:"extra,omitempty"`
}
// ExtraValue contains additional information about a user that may be
// provided by the authenticator.
type ExtraValue []string
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ServiceInstance represents a provisioned instance of a ServiceClass.
// Currently, the spec field cannot be changed once a ServiceInstance is
// created. Spec changes submitted by users will be ignored.
//
// In the future, this will be allowed and will represent the intention that
// the ServiceInstance should have the plan and/or parameters updated at the
// ClusterServiceBroker.
// +k8s:openapi-gen=x-kubernetes-print-columns:custom-columns=NAME:.metadata.name,CLASS:.spec.clusterServiceClassExternalName,PLAN:.spec.clusterServicePlanExternalName
type ServiceInstance struct {
metav1.TypeMeta `json:",inline"`
// The name of this resource in etcd is in ObjectMeta.Name.
// More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#metadata
// +optional
metav1.ObjectMeta `json:"metadata,omitempty"`
// Spec defines the behavior of the service instance.
// +optional
Spec ServiceInstanceSpec `json:"spec,omitempty"`
// Status represents the current status of a service instance.
// +optional
Status ServiceInstanceStatus `json:"status,omitempty"`
}
// PlanReference defines the user specification for the desired
// (Cluster)ServicePlan and (Cluster)ServiceClass. Because there are
// multiple ways to specify the desired Class/Plan, this structure specifies the
// allowed ways to specify the intent. Note: a user may specify either cluster
// scoped OR namespace scoped identifiers, but NOT both, as they are mutually
// exclusive.
//
// Currently supported ways:
// - ClusterServiceClassExternalName and ClusterServicePlanExternalName
// - ClusterServiceClassExternalID and ClusterServicePlanExternalID
// - ClusterServiceClassName and ClusterServicePlanName
// - ServiceClassExternalName and ServicePlanExternalName
// - ServiceClassExternalID and ServicePlanExternalID
// - ServiceClassName and ServicePlanName
//
// For any of these ways, if a ClusterServiceClass only has one plan
// then the corresponding service plan field is optional.
type PlanReference struct {
// ClusterServiceClassExternalName is the human-readable name of the
// service as reported by the ClusterServiceBroker. Note that if the
// ClusterServiceBroker changes the name of the ClusterServiceClass,
// it will not be reflected here, and to see the current name of the
// ClusterServiceClass, you should follow the ClusterServiceClassRef below.
//
// Immutable.
ClusterServiceClassExternalName string `json:"clusterServiceClassExternalName,omitempty"`
// ClusterServicePlanExternalName is the human-readable name of the plan
// as reported by the ClusterServiceBroker. Note that if the
// ClusterServiceBroker changes the name of the ClusterServicePlan, it will
// not be reflected here, and to see the current name of the
// ClusterServicePlan, you should follow the ClusterServicePlanRef below.
ClusterServicePlanExternalName string `json:"clusterServicePlanExternalName,omitempty"`
// ClusterServiceClassExternalID is the ClusterServiceBroker's external id
// for the class.
//
// Immutable.
ClusterServiceClassExternalID string `json:"clusterServiceClassExternalID,omitempty"`
// ClusterServicePlanExternalID is the ClusterServiceBroker's external id for
// the plan.
ClusterServicePlanExternalID string `json:"clusterServicePlanExternalID,omitempty"`
// ClusterServiceClassName is the kubernetes name of the ClusterServiceClass.
//
// Immutable.
ClusterServiceClassName string `json:"clusterServiceClassName,omitempty"`
// ClusterServicePlanName is kubernetes name of the ClusterServicePlan.
ClusterServicePlanName string `json:"clusterServicePlanName,omitempty"`
// ServiceClassExternalName is the human-readable name of the
// service as reported by the ServiceBroker. Note that if the ServiceBroker
// changes the name of the ServiceClass, it will not be reflected here,
// and to see the current name of the ServiceClass, you should
// follow the ServiceClassRef below.
//
// Immutable.
ServiceClassExternalName string `json:"serviceClassExternalName,omitempty"`
// ServicePlanExternalName is the human-readable name of the plan
// as reported by the ServiceBroker. Note that if the ServiceBroker changes
// the name of the ServicePlan, it will not be reflected here, and to see
// the current name of the ServicePlan, you should follow the
// ServicePlanRef below.
ServicePlanExternalName string `json:"servicePlanExternalName,omitempty"`
// ServiceClassExternalID is the ServiceBroker's external id for the class.
//
// Immutable.
ServiceClassExternalID string `json:"serviceClassExternalID,omitempty"`
// ServicePlanExternalID is the ServiceBroker's external id for the plan.
ServicePlanExternalID string `json:"servicePlanExternalID,omitempty"`
// ServiceClassName is the kubernetes name of the ServiceClass.
//
// Immutable.
ServiceClassName string `json:"serviceClassName,omitempty"`
// ServicePlanName is kubernetes name of the ServicePlan.
ServicePlanName string `json:"servicePlanName,omitempty"`
}
// ServiceInstanceSpec represents the desired state of an Instance.
type ServiceInstanceSpec struct {
// Specification of what ServiceClass/ServicePlan is being provisioned.
PlanReference `json:",inline"`
// ClusterServiceClassRef is a reference to the ClusterServiceClass
// that the user selected. This is set by the controller based on the
// cluster-scoped values specified in the PlanReference.
ClusterServiceClassRef *ClusterObjectReference `json:"clusterServiceClassRef,omitempty"`
// ClusterServicePlanRef is a reference to the ClusterServicePlan
// that the user selected. This is set by the controller based on the
// cluster-scoped values specified in the PlanReference.
ClusterServicePlanRef *ClusterObjectReference `json:"clusterServicePlanRef,omitempty"`
// ServiceClassRef is a reference to the ServiceClass that the user selected.
// This is set by the controller based on the namespace-scoped values
// specified in the PlanReference.
ServiceClassRef *LocalObjectReference `json:"serviceClassRef,omitempty"`
// ServicePlanRef is a reference to the ServicePlan that the user selected.
// This is set by the controller based on the namespace-scoped values
// specified in the PlanReference.
ServicePlanRef *LocalObjectReference `json:"servicePlanRef,omitempty"`
// Parameters is a set of the parameters to be passed to the underlying
// broker. The inline YAML/JSON payload to be translated into equivalent
// JSON object. If a top-level parameter name exists in multiples sources
// among `Parameters` and `ParametersFrom` fields, it is considered to be
// a user error in the specification.
//
// The Parameters field is NOT secret or secured in any way and should
// NEVER be used to hold sensitive information. To set parameters that
// contain secret information, you should ALWAYS store that information
// in a Secret and use the ParametersFrom field.
//
// +optional
Parameters *runtime.RawExtension `json:"parameters,omitempty"`
// List of sources to populate parameters.
// If a top-level parameter name exists in multiples sources among
// `Parameters` and `ParametersFrom` fields, it is
// considered to be a user error in the specification
// +optional
ParametersFrom []ParametersFromSource `json:"parametersFrom,omitempty"`
// ExternalID is the identity of this object for use with the OSB SB API.
//
// Immutable.
// +optional
ExternalID string `json:"externalID"`
// Currently, this field is ALPHA: it may change or disappear at any time
// and its data will not be migrated.
//
// UserInfo contains information about the user that last modified this
// instance. This field is set by the API server and not settable by the
// end-user. User-provided values for this field are not saved.
// +optional
UserInfo *UserInfo `json:"userInfo,omitempty"`
// UpdateRequests is a strictly increasing, non-negative integer counter that
// can be manually incremented by a user to manually trigger an update. This
// allows for parameters to be updated with any out-of-band changes that have
// been made to the secrets from which the parameters are sourced.
// +optional
UpdateRequests int64 `json:"updateRequests"`
}
// ServiceInstanceStatus represents the current status of an Instance.
type ServiceInstanceStatus struct {
// Conditions is an array of ServiceInstanceConditions capturing aspects of an
// ServiceInstance's status.
Conditions []ServiceInstanceCondition `json:"conditions"`
// AsyncOpInProgress is set to true if there is an ongoing async operation
// against this Service Instance in progress.
AsyncOpInProgress bool `json:"asyncOpInProgress"`
// OrphanMitigationInProgress is set to true if there is an ongoing orphan
// mitigation operation against this ServiceInstance in progress.
OrphanMitigationInProgress bool `json:"orphanMitigationInProgress"`
// LastOperation is the string that the broker may have returned when
// an async operation started, it should be sent back to the broker
// on poll requests as a query param.
LastOperation *string `json:"lastOperation,omitempty"`
// DashboardURL is the URL of a web-based management user interface for
// the service instance.
DashboardURL *string `json:"dashboardURL,omitempty"`
// CurrentOperation is the operation the Controller is currently performing
// on the ServiceInstance.
CurrentOperation ServiceInstanceOperation `json:"currentOperation,omitempty"`
// ReconciledGeneration is the 'Generation' of the serviceInstanceSpec that
// was last processed by the controller. The reconciled generation is updated
// even if the controller failed to process the spec.
// Deprecated: use ObservedGeneration with conditions set to true to find
// whether generation was reconciled.
ReconciledGeneration int64 `json:"reconciledGeneration"`
// ObservedGeneration is the 'Generation' of the serviceInstanceSpec that
// was last processed by the controller. The observed generation is updated
// whenever the status is updated regardless of operation result.
ObservedGeneration int64 `json:"observedGeneration"`
// OperationStartTime is the time at which the current operation began.
OperationStartTime *metav1.Time `json:"operationStartTime,omitempty"`
// InProgressProperties is the properties state of the ServiceInstance when
// a Provision, Update or Deprovision is in progress.
InProgressProperties *ServiceInstancePropertiesState `json:"inProgressProperties,omitempty"`
// ExternalProperties is the properties state of the ServiceInstance which the
// broker knows about.
ExternalProperties *ServiceInstancePropertiesState `json:"externalProperties,omitempty"`
// ProvisionStatus describes whether the instance is in the provisioned state.
ProvisionStatus ServiceInstanceProvisionStatus `json:"provisionStatus"`
// DeprovisionStatus describes what has been done to deprovision the
// ServiceInstance.
DeprovisionStatus ServiceInstanceDeprovisionStatus `json:"deprovisionStatus"`
// DefaultProvisionParameters are the default parameters applied to this
// instance.
DefaultProvisionParameters *runtime.RawExtension `json:"defaultProvisionParameters,omitempty"`
}
// ServiceInstanceCondition contains condition information about an Instance.
type ServiceInstanceCondition struct {
// Type of the condition, currently ('Ready').
Type ServiceInstanceConditionType `json:"type"`
// Status of the condition, one of ('True', 'False', 'Unknown').
Status ConditionStatus `json:"status"`
// LastTransitionTime is the timestamp corresponding to the last status