-
Notifications
You must be signed in to change notification settings - Fork 2
/
volumeGenerator.go
261 lines (223 loc) · 8.03 KB
/
volumeGenerator.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
package resource
import (
"encoding/json"
"fmt"
"github.com/cloudogu/cesapp-lib/core"
k8sv1 "github.com/cloudogu/k8s-dogu-operator/api/v1"
"github.com/hashicorp/go-multierror"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
ctrl "sigs.k8s.io/controller-runtime"
)
// doguOperatorClient references the k8s-dogu-operator as a client for the creation of a resource.
const doguOperatorClient = "k8s-dogu-operator"
// configMapParamType describes a volume of type config map.
const configMapParamType volumeParamsType = "configmap"
// volumeParamsType describes the kind of volume the k8s-dogu-operator should create.
type volumeParamsType string
// volumeParams contains additional information for the k8s-dogu-operator to create a volume.
type volumeParams struct {
// Type describes the kind of volume the k8s-dogu-operator should create.
Type volumeParamsType
// Content contains the actual information that is needed to create a volume of a given Type.
// The structure of this information is therefore dependent on the Type.
// To describe a configmap, it could f.i. contain data of type volumeConfigMapContent.
Content interface{}
}
// volumeConfigMapContent contains information needed to create a volume of type configmap.
type volumeConfigMapContent struct {
// Name of the configmap to create.
Name string
}
func createVolumes(doguResource *k8sv1.Dogu, dogu *core.Dogu) ([]corev1.Volume, error) {
volumes := createStaticVolumes(doguResource)
volumesFromDogu, err := createDoguVolumes(dogu.Volumes, doguResource)
if err != nil {
return nil, err
}
volumes = append(volumes, volumesFromDogu...)
return volumes, nil
}
func createStaticVolumes(doguResource *k8sv1.Dogu) []corev1.Volume {
nodeMasterVolume := corev1.Volume{
Name: nodeMasterFile,
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{Name: nodeMasterFile},
},
},
}
mode := int32(0744)
privateVolume := corev1.Volume{
Name: doguResource.GetPrivateKeySecretName(),
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: doguResource.GetPrivateKeySecretName(),
DefaultMode: &mode,
},
},
}
// always reserve a volume for upgrade script actions, even if the dogu has no state because upgrade scripts
// do not always rely on a dogu state (f. e. checks on upgradability)
doguReservedVolume := corev1.Volume{
Name: doguResource.GetReservedVolumeName(),
VolumeSource: corev1.VolumeSource{
PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
ClaimName: doguResource.GetReservedPVCName(),
},
},
}
return []corev1.Volume{
nodeMasterVolume,
privateVolume,
doguReservedVolume,
}
}
func createDoguVolumes(doguVolumes []core.Volume, doguResource *k8sv1.Dogu) ([]corev1.Volume, error) {
var multiError error
var volumes []corev1.Volume
for _, doguVolume := range doguVolumes {
client, clientExists := doguVolume.GetClient(doguOperatorClient)
if clientExists {
volume, err := createVolumeByClient(doguVolume, client)
if err != nil {
multiError = multierror.Append(multiError, err)
continue
}
volumes = append(volumes, *volume)
}
}
dataVolumeCount := len(doguVolumes) - len(volumes)
if dataVolumeCount > 0 {
dataVolume := corev1.Volume{
Name: doguResource.GetDataVolumeName(),
VolumeSource: corev1.VolumeSource{
PersistentVolumeClaim: &corev1.PersistentVolumeClaimVolumeSource{
ClaimName: doguResource.Name,
},
},
}
volumes = append(volumes, dataVolume)
}
return volumes, multiError
}
func createVolumeByClient(doguVolume core.Volume, client *core.VolumeClient) (*corev1.Volume, error) {
clientParams := new(volumeParams)
err := convertGenericJsonObject(client.Params, clientParams)
if err != nil {
return nil, fmt.Errorf("failed to read %s client params of volume %s: %w", doguOperatorClient, doguVolume.Name, err)
}
switch clientParams.Type {
case configMapParamType:
configMapParamContent := new(volumeConfigMapContent)
err = convertGenericJsonObject(clientParams.Content, configMapParamContent)
if err != nil {
return nil, fmt.Errorf("failed to read %s client type content of volume %s: %w", configMapParamType, doguVolume.Name, err)
}
return &corev1.Volume{
Name: doguVolume.Name,
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{Name: configMapParamContent.Name},
},
},
}, nil
default:
return nil, fmt.Errorf("unsupported client param type %s in volume %s", clientParams.Type, doguVolume.Name)
}
}
// convertGenericJsonObject is necessary because go unmarshalls generic json objects as `map[string]interface{}`,
// and, therefore, a type assertion is not possible. This method marshals the generic object (`map[string]interface{}`)
// back into a string. This string is then unmarshalled back into a specific given struct.
func convertGenericJsonObject(genericObject interface{}, targetObject interface{}) error {
marshalledContent, err := json.Marshal(genericObject)
if err != nil {
return err
}
err = json.Unmarshal(marshalledContent, targetObject)
if err != nil {
return err
}
return nil
}
func createVolumeMounts(doguResource *k8sv1.Dogu, dogu *core.Dogu) []corev1.VolumeMount {
volumeMounts := createStaticVolumeMounts(doguResource)
return append(volumeMounts, createDoguVolumeMounts(doguResource, dogu)...)
}
func createStaticVolumeMounts(doguResource *k8sv1.Dogu) []corev1.VolumeMount {
doguVolumeMounts := []corev1.VolumeMount{
{
Name: nodeMasterFile,
ReadOnly: true,
MountPath: "/etc/ces/node_master",
SubPath: "node_master",
},
{
Name: doguResource.GetPrivateKeySecretName(),
ReadOnly: true,
MountPath: "/private",
},
{
Name: doguResource.GetReservedVolumeName(),
ReadOnly: false,
MountPath: DoguReservedPath,
},
}
return doguVolumeMounts
}
func createDoguVolumeMounts(doguResource *k8sv1.Dogu, dogu *core.Dogu) []corev1.VolumeMount {
var volumeMounts []corev1.VolumeMount
for _, doguVolume := range dogu.Volumes {
newVolume := createDoguVolumeMount(doguVolume, doguResource)
volumeMounts = append(volumeMounts, newVolume)
}
return volumeMounts
}
func createDoguVolumeMount(doguVolume core.Volume, doguResource *k8sv1.Dogu) corev1.VolumeMount {
_, clientExists := doguVolume.GetClient(doguOperatorClient)
if clientExists {
return corev1.VolumeMount{
Name: doguVolume.Name,
ReadOnly: false,
MountPath: doguVolume.Path,
}
}
return corev1.VolumeMount{
Name: doguResource.GetDataVolumeName(),
ReadOnly: false,
MountPath: doguVolume.Path,
SubPath: doguVolume.Name,
}
}
// CreateDoguPVC creates a persistent volume claim for the given dogu.
func (r *resourceGenerator) CreateDoguPVC(doguResource *k8sv1.Dogu) (*corev1.PersistentVolumeClaim, error) {
return r.createPVC(doguResource.Name, doguResource, doguResource.GetDataVolumeSize())
}
// CreateReservedPVC creates a persistent volume claim with a 10Mi storage for the given dogu.
// Used for example for upgrade operations.
func (r *resourceGenerator) CreateReservedPVC(doguResource *k8sv1.Dogu) (*corev1.PersistentVolumeClaim, error) {
return r.createPVC(doguResource.GetReservedPVCName(), doguResource, resource.MustParse("10Mi"))
}
func (r *resourceGenerator) createPVC(pvcName string, doguResource *k8sv1.Dogu, size resource.Quantity) (*corev1.PersistentVolumeClaim, error) {
pvc := &corev1.PersistentVolumeClaim{
ObjectMeta: metav1.ObjectMeta{
Name: pvcName,
Namespace: doguResource.Namespace,
Labels: GetAppLabel().Add(doguResource.GetDoguNameLabel()),
},
}
pvc.Spec = corev1.PersistentVolumeClaimSpec{
AccessModes: []corev1.PersistentVolumeAccessMode{corev1.ReadWriteOnce},
Resources: corev1.ResourceRequirements{
Requests: corev1.ResourceList{
corev1.ResourceStorage: size,
},
},
}
err := ctrl.SetControllerReference(doguResource, pvc, r.scheme)
if err != nil {
return nil, wrapControllerReferenceError(err)
}
return pvc, nil
}