-
Notifications
You must be signed in to change notification settings - Fork 159
/
container_utils.go
262 lines (231 loc) · 8.1 KB
/
container_utils.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
package flink
import (
"fmt"
"hash/fnv"
"math/rand"
"github.com/benlaurie/objecthash/go/objecthash"
"github.com/lyft/flinkk8soperator/pkg/apis/app/v1beta1"
"github.com/lyft/flinkk8soperator/pkg/controller/common"
"github.com/lyft/flinkk8soperator/pkg/controller/config"
"github.com/lyft/flinkk8soperator/pkg/controller/k8"
"github.com/pkg/errors"
appsv1 "k8s.io/api/apps/v1"
v1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/util/json"
)
const (
AppName = "APP_NAME"
AwsMetadataServiceTimeoutKey = "AWS_METADATA_SERVICE_TIMEOUT"
AwsMetadataServiceNumAttemptsKey = "AWS_METADATA_SERVICE_NUM_ATTEMPTS"
AwsMetadataServiceTimeout = "5"
AwsMetadataServiceNumAttempts = "20"
OperatorFlinkConfig = "FLINK_PROPERTIES"
HostName = "HOST_NAME"
HostIP = "HOST_IP"
FlinkDeploymentTypeEnv = "FLINK_DEPLOYMENT_TYPE"
FlinkDeploymentType = "flink-deployment-type"
FlinkDeploymentTypeJobmanager = "jobmanager"
FlinkDeploymentTypeTaskmanager = "taskmanager"
FlinkAppHash = "flink-app-hash"
PodDeploymentSelector = "pod-deployment-selector"
FlinkJobProperties = "flink-job-properties"
RestartNonce = "restart-nonce"
FlinkApplicationVersionEnv = "FLINK_APPLICATION_VERSION"
FlinkApplicationVersion = "flink-application-version"
)
func getFlinkContainerName(containerName string) string {
cfg := config.GetConfig()
containerNameFormat := cfg.ContainerNameFormat
if containerNameFormat != "" {
return fmt.Sprintf(containerNameFormat, containerName)
}
return containerName
}
func GetCommonAppLabels(app *v1beta1.FlinkApplication) map[string]string {
labels := common.DuplicateMap(k8.GetAppLabel(app.Name))
if v1beta1.IsBlueGreenDeploymentMode(app.Status.DeploymentMode) {
labels[FlinkApplicationVersion] = string(app.Status.UpdatingVersion)
}
return labels
}
func getCommonAnnotations(app *v1beta1.FlinkApplication) map[string]string {
annotations := common.DuplicateMap(app.Annotations)
annotations[FlinkJobProperties] = fmt.Sprintf(
"jarName: %s\nparallelism: %d\nentryClass:%s\nprogramArgs:\"%s\"",
app.Spec.JarName, app.Spec.Parallelism, app.Spec.EntryClass, app.Spec.ProgramArgs)
if app.Spec.RestartNonce != "" {
annotations[RestartNonce] = app.Spec.RestartNonce
}
if v1beta1.IsBlueGreenDeploymentMode(app.Status.DeploymentMode) {
annotations[FlinkApplicationVersion] = string(app.Status.UpdatingVersion)
}
return annotations
}
func GetAWSServiceEnv() []v1.EnvVar {
return []v1.EnvVar{
{
Name: AwsMetadataServiceTimeoutKey,
Value: AwsMetadataServiceTimeout,
},
{
Name: AwsMetadataServiceNumAttemptsKey,
Value: AwsMetadataServiceNumAttempts,
},
}
}
func getFlinkEnv(app *v1beta1.FlinkApplication) ([]v1.EnvVar, error) {
env := []v1.EnvVar{}
appName := app.Name
flinkConfig, err := renderFlinkConfig(app)
if err != nil {
return nil, errors.Wrap(err, "Failed to serialize flink configuration")
}
env = append(env, []v1.EnvVar{
{
Name: AppName,
Value: appName,
},
{
Name: OperatorFlinkConfig,
Value: flinkConfig,
},
{
Name: HostName,
ValueFrom: &v1.EnvVarSource{
FieldRef: &v1.ObjectFieldSelector{
FieldPath: "metadata.name",
},
},
},
{
Name: HostIP,
ValueFrom: &v1.EnvVarSource{
FieldRef: &v1.ObjectFieldSelector{
FieldPath: "status.podIP",
},
},
},
}...)
return env, nil
}
func GetFlinkContainerEnv(app *v1beta1.FlinkApplication) []v1.EnvVar {
env := []v1.EnvVar{}
env = append(env, GetAWSServiceEnv()...)
flinkEnv, err := getFlinkEnv(app)
if err == nil {
env = append(env, flinkEnv...)
}
env = append(env, GetDeploySpecificEnv(app)...)
return env
}
func ImagePullPolicy(app *v1beta1.FlinkApplication) v1.PullPolicy {
if app.Spec.ImagePullPolicy == "" {
return v1.PullIfNotPresent
}
return app.Spec.ImagePullPolicy
}
func fromHashToByteArray(input [32]byte) []byte {
output := make([]byte, 32)
for idx, val := range input {
output[idx] = val
}
return output
}
// Generate a deterministic hash in bytes for the pb object
func ComputeDeploymentHash(deployment appsv1.Deployment) ([]byte, error) {
// json marshalling includes:
// - omitting empty values which supports backwards compatibility of old protobuf definitions
jsonObj, err := json.Marshal(deployment)
if err != nil {
return nil, err
}
// Deterministically hash the JSON object to a byte array. The library will sort the map keys of the JSON object
// so that we do not run into the issues from json marshalling.
hash, err := objecthash.CommonJSONHash(string(jsonObj))
if err != nil {
return nil, err
}
return fromHashToByteArray(hash), err
}
// Returns an 8 character hash sensitive to the application name, labels, annotations, and spec.
// TODO: we may need to add collision-avoidance to this
func HashForApplication(app *v1beta1.FlinkApplication) string {
// we round-trip through json to normalize the deployment objects
jmDeployment := jobmanagerTemplate(app)
jmDeployment.OwnerReferences = make([]metav1.OwnerReference, 0)
tmDeployment := taskmanagerTemplate(app)
tmDeployment.OwnerReferences = make([]metav1.OwnerReference, 0)
jmHashBytes, err := ComputeDeploymentHash(*jmDeployment)
if err != nil {
// the hasher cannot actually throw an error on write
panic(fmt.Sprintf("got error trying when computing hash %v", err))
}
tmHashBytes, err := ComputeDeploymentHash(*tmDeployment)
if err != nil {
// the hasher cannot actually throw an error on write
panic(fmt.Sprintf("got error trying when computing hash %v", err))
}
hasher := fnv.New32a()
_, err = hasher.Write(jmHashBytes)
if err != nil {
// the hasher cannot actually throw an error on write
panic(fmt.Sprintf("got error trying when writing to hasher %v", err))
}
_, err = hasher.Write(tmHashBytes)
if err != nil {
// the hasher cannot actually throw an error on write
panic(fmt.Sprintf("got error trying when writing to hasher %v", err))
}
return fmt.Sprintf("%08x", hasher.Sum32())
}
func InjectOperatorCustomizedConfig(deployment *appsv1.Deployment, app *v1beta1.FlinkApplication, hash string, deploymentType string) {
var newContainers []v1.Container
for _, container := range deployment.Spec.Template.Spec.Containers {
var newEnv []v1.EnvVar
for _, env := range container.Env {
if env.Name == OperatorFlinkConfig {
if isHAEnabled(app.Spec.FlinkConfig) {
env.Value = fmt.Sprintf("%s\nhigh-availability.cluster-id: %s-%s\n", env.Value, app.Name, hash)
if deploymentType == FlinkDeploymentTypeJobmanager {
env.Value = fmt.Sprintf("%sjobmanager.rpc.address: $HOST_IP\n", env.Value)
}
} else {
env.Value = fmt.Sprintf("%s\njobmanager.rpc.address: %s\n", env.Value, VersionedJobManagerServiceName(app, hash))
}
if deploymentType == FlinkDeploymentTypeTaskmanager {
env.Value = fmt.Sprintf("%staskmanager.host: $HOST_IP\n", env.Value)
}
// backward compatibility: https://github.com/lyft/flinkk8soperator/issues/135
newEnv = append(newEnv, v1.EnvVar{Name: "OPERATOR_FLINK_CONFIG", Value: env.Value})
}
newEnv = append(newEnv, env)
}
container.Env = newEnv
newContainers = append(newContainers, container)
}
deployment.Spec.Template.Spec.Containers = newContainers
}
// Injects labels and environment variables required for blue green deploys
func GetDeploySpecificEnv(app *v1beta1.FlinkApplication) []v1.EnvVar {
if !v1beta1.IsBlueGreenDeploymentMode(app.Status.DeploymentMode) {
return []v1.EnvVar{}
}
return []v1.EnvVar{
{
Name: FlinkApplicationVersionEnv,
Value: string(app.Status.UpdatingVersion),
},
}
}
// Generates random 8 character string that connects pods to deployments, and which uniquely identifies *this*
// deployment that we're creating now. We used to rely on the hash for this, but that is not stable in the case of
// in-place scale up.
func RandomPodDeploymentSelector() string {
alphabet := "abcdefghijklmnopkqrstuvwxyz0123456789"
s := make([]byte, 8)
for i := range s {
s[i] = alphabet[rand.Int31n(int32(len(alphabet)))]
}
return string(s)
}