/
service_binding.go
127 lines (110 loc) · 5.1 KB
/
service_binding.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
/*
* Copyright 2020 the original author or 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
*
* https://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 v1
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// ServiceBindingWorkloadReference defines a subset of corev1.ObjectReference with extensions
type ServiceBindingWorkloadReference struct {
// API version of the referent.
APIVersion string `json:"apiVersion"`
// Kind of the referent.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Kind string `json:"kind"`
// Name of the referent.
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name string `json:"name,omitempty"`
// Selector is a query that selects the workload or workloads to bind the service to
Selector *metav1.LabelSelector `json:"selector,omitempty"`
// Containers describes which containers in a Pod should be bound to
Containers []string `json:"containers,omitempty"`
}
// ServiceBindingServiceReference defines a subset of corev1.ObjectReference
type ServiceBindingServiceReference struct {
// API version of the referent.
APIVersion string `json:"apiVersion"`
// Kind of the referent.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
Kind string `json:"kind"`
// Name of the referent.
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name string `json:"name"`
}
// ServiceBindingSecretReference defines a mirror of corev1.LocalObjectReference
type ServiceBindingSecretReference struct {
// Name of the referent secret.
// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
Name string `json:"name"`
}
// EnvMapping defines a mapping from the value of a Secret entry to an environment variable
type EnvMapping struct {
// Name is the name of the environment variable
Name string `json:"name"`
// Key is the key in the Secret that will be exposed
Key string `json:"key"`
}
// ServiceBindingSpec defines the desired state of ServiceBinding
type ServiceBindingSpec struct {
// Name is the name of the service as projected into the workload container. Defaults to .metadata.name.
Name string `json:"name,omitempty"`
// Type is the type of the service as projected into the workload container
Type string `json:"type,omitempty"`
// Provider is the provider of the service as projected into the workload container
Provider string `json:"provider,omitempty"`
// Workload is a reference to an object
Workload ServiceBindingWorkloadReference `json:"workload"`
// Service is a reference to an object that fulfills the ProvisionedService duck type
Service ServiceBindingServiceReference `json:"service"`
// Env is the collection of mappings from Secret entries to environment variables
Env []EnvMapping `json:"env,omitempty"`
}
// These are valid conditions of ServiceBinding.
const (
// ServiceBindingReady means the ServiceBinding has projected the ProvisionedService
// secret and the Workload is ready to start. It does not indicate the condition
// of either the Service or the Workload resources referenced.
ServiceBindingConditionReady = "Ready"
)
// ServiceBindingStatus defines the observed state of ServiceBinding
type ServiceBindingStatus struct {
// ObservedGeneration is the 'Generation' of the ServiceBinding that
// was last processed by the controller.
ObservedGeneration int64 `json:"observedGeneration,omitempty"`
// Conditions are the conditions of this ServiceBinding
Conditions []metav1.Condition `json:"conditions,omitempty"`
// Binding exposes the projected secret for this ServiceBinding
Binding *ServiceBindingSecretReference `json:"binding,omitempty"`
}
// +kubebuilder:object:root=true
// +kubebuilder:storageversion
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Ready",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].status`
// +kubebuilder:printcolumn:name="Reason",type=string,JSONPath=`.status.conditions[?(@.type=="Ready")].reason`
// +kubebuilder:printcolumn:name="Age",type=date,JSONPath=`.metadata.creationTimestamp`
// ServiceBinding is the Schema for the servicebindings API
type ServiceBinding struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec ServiceBindingSpec `json:"spec,omitempty"`
Status ServiceBindingStatus `json:"status,omitempty"`
}
// +kubebuilder:object:root=true
// ServiceBindingList contains a list of ServiceBinding
type ServiceBindingList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []ServiceBinding `json:"items"`
}