forked from aws/amazon-ecs-agent
-
Notifications
You must be signed in to change notification settings - Fork 0
/
managed_daemon.go
392 lines (347 loc) · 12.5 KB
/
managed_daemon.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
// Copyright Amazon.com Inc. or its affiliates. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License"). You may
// not use this file except in compliance with the License. A copy of the
// License is located at
//
// http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file 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 manageddaemon
import (
"fmt"
"os"
"path/filepath"
"time"
"github.com/aws/amazon-ecs-agent/ecs-agent/acs/model/ecsacs"
dockercontainer "github.com/docker/docker/api/types/container"
)
const (
imageTarPath = "/var/lib/ecs/deps/daemons"
imageTagDefault = "latest"
defaultAgentCommunicationPathHostRoot = "/var/run/ecs"
defaultApplicationLogPathHostRoot = "/var/log/ecs/daemons"
defaultAgentCommunicationMount = "agentCommunicationMount"
defaultApplicationLogMount = "applicationLogMount"
)
type ManagedDaemon struct {
imageName string
imageTag string
healthCheckTest []string
healthCheckInterval time.Duration
healthCheckTimeout time.Duration
healthCheckRetries int
// Daemons require an agent <-> daemon mount
// identified by the volume name `agentCommunicationMount`
// the SourceVolumeHostPath will always be overridden to
// /var/run/ecs/<md.imageName>
agentCommunicationMount *MountPoint
// Daemons require an application log mount
// identified by the volume name `applicationLogMount`
// the SourceVolumeHostPath will always be overridden to
// /var/log/ecs/<md.imageName>
applicationLogMount *MountPoint
mountPoints []*MountPoint
environment map[string]string
loadedDaemonImageRef string
command []string
linuxParameters *ecsacs.LinuxParameters
privileged bool
}
// A valid managed daemon will require
// healthcheck and mount points to be added
func NewManagedDaemon(
imageName string,
imageTag string,
) *ManagedDaemon {
if imageTag == "" {
imageTag = imageTagDefault
}
// health check retries 0 is valid
newManagedDaemon := &ManagedDaemon{
imageName: imageName,
imageTag: imageTag,
healthCheckRetries: 0,
}
return newManagedDaemon
}
var ImportAll = defaultImportAll
// ImportAll function will parse/validate all managed daemon definitions
// defined in /var/lib/ecs/deps/daemons and will return an array
// of valid ManagedDeamon objects
func defaultImportAll() ([]*ManagedDaemon, error) {
// TODO parse taskdef json files in parameterized dir ie /deps/daemons
// TODO validate that each daemon's layers are loaded or that daemon has a corresponding image tar
ebsCsiTarFile := filepath.Join(imageTarPath, EbsCsiDriver, "ebs-csi-driver.tar")
if _, err := os.Stat(ebsCsiTarFile); err != nil {
return []*ManagedDaemon{}, nil
}
// found the EBS CSI tar file -- import
ebsManagedDaemon := NewManagedDaemon(EbsCsiDriver, "latest")
// add required mounts
ebsMounts := []*MountPoint{
&MountPoint{
SourceVolumeID: "agentCommunicationMount",
SourceVolume: "agentCommunicationMount",
SourceVolumeType: "host",
SourceVolumeHostPath: "/var/run/ecs/ebs-csi-driver/",
ContainerPath: "/csi-driver/",
},
&MountPoint{
SourceVolumeID: "applicationLogMount",
SourceVolume: "applicationLogMount",
SourceVolumeType: "host",
SourceVolumeHostPath: "/var/log/ecs/daemons/ebs-csi-driver/",
ContainerPath: "/var/log/",
},
&MountPoint{
SourceVolumeID: "sharedMounts",
SourceVolume: "sharedMounts",
SourceVolumeType: "host",
SourceVolumeHostPath: "/mnt/ecs/ebs",
ContainerPath: "/mnt/ecs/ebs",
PropagationShared: true,
},
&MountPoint{
SourceVolumeID: "devMount",
SourceVolume: "devMount",
SourceVolumeType: "host",
SourceVolumeHostPath: "/dev",
ContainerPath: "/dev",
PropagationShared: true,
},
}
if err := ebsManagedDaemon.SetMountPoints(ebsMounts); err != nil {
return nil, fmt.Errorf("Unable to import EBS ManagedDaemon: %s", err)
}
var thisCommand []string
thisCommand = append(thisCommand, "--endpoint=unix://csi-driver/csi-driver.sock")
thisCommand = append(thisCommand, "--log_file=/var/log/csi.log")
thisCommand = append(thisCommand, "--log_file_max_size=20")
thisCommand = append(thisCommand, "--logtostderr=false")
sysAdmin := "SYS_ADMIN"
addCapabilities := []*string{&sysAdmin}
kernelCapabilities := ecsacs.KernelCapabilities{Add: addCapabilities}
ebsLinuxParams := ecsacs.LinuxParameters{Capabilities: &kernelCapabilities}
ebsManagedDaemon.linuxParameters = &ebsLinuxParams
ebsManagedDaemon.command = thisCommand
ebsManagedDaemon.privileged = true
return []*ManagedDaemon{ebsManagedDaemon}, nil
}
func (md *ManagedDaemon) GetLinuxParameters() *ecsacs.LinuxParameters {
return md.linuxParameters
}
func (md *ManagedDaemon) GetPrivileged() bool {
return md.privileged
}
func (md *ManagedDaemon) GetImageName() string {
return md.imageName
}
func (md *ManagedDaemon) GetImageTag() string {
return md.imageTag
}
func (md *ManagedDaemon) GetImageRef() string {
return (fmt.Sprintf("%s:%s", md.imageName, md.imageTag))
}
func (md *ManagedDaemon) GetImageTarPath() string {
return (fmt.Sprintf("%s/%s/%s.tar", imageTarPath, md.imageName, md.imageName))
}
func (md *ManagedDaemon) GetAgentCommunicationMount() *MountPoint {
return md.agentCommunicationMount
}
func (md *ManagedDaemon) GetApplicationLogMount() *MountPoint {
return md.applicationLogMount
}
func (md *ManagedDaemon) GetCommand() []string {
return md.command
}
// returns list of mountpoints without the
// agentCommunicationMount and applicationLogMount
func (md *ManagedDaemon) GetFilteredMountPoints() []*MountPoint {
filteredMounts := make([]*MountPoint, len(md.mountPoints))
copy(filteredMounts, md.mountPoints)
return filteredMounts
}
// returns list of mountpoints which (re)integrates
// agentCommunicationMount and applicationLogMount
// these will always include host mount file overrides
func (md *ManagedDaemon) GetMountPoints() []*MountPoint {
allMounts := make([]*MountPoint, len(md.mountPoints))
copy(allMounts, md.mountPoints)
allMounts = append(allMounts, md.agentCommunicationMount)
allMounts = append(allMounts, md.applicationLogMount)
return allMounts
}
func (md *ManagedDaemon) GetEnvironment() map[string]string {
return md.environment
}
func (md *ManagedDaemon) GetLoadedDaemonImageRef() string {
return md.loadedDaemonImageRef
}
func (md *ManagedDaemon) SetHealthCheck(
healthCheckTest []string,
healthCheckInterval time.Duration,
healthCheckTimeout time.Duration,
healthCheckRetries int) {
md.healthCheckInterval = healthCheckInterval
md.healthCheckTimeout = healthCheckTimeout
md.healthCheckRetries = healthCheckRetries
md.healthCheckTest = make([]string, len(healthCheckTest))
copy(md.healthCheckTest, healthCheckTest)
}
// filter mount points for agentCommunicationMount
// set required mounts
// and override host paths in favor of agent defaults
// when a duplicate SourceVolumeID is given, the last Mount wins
func (md *ManagedDaemon) SetMountPoints(mountPoints []*MountPoint) error {
var mountPointMap = make(map[string]*MountPoint)
for _, mp := range mountPoints {
if mp.SourceVolumeID == defaultAgentCommunicationMount {
mp.SourceVolumeHostPath = fmt.Sprintf("%s/%s/", defaultAgentCommunicationPathHostRoot, md.imageName)
md.agentCommunicationMount = mp
} else if mp.SourceVolumeID == defaultApplicationLogMount {
mp.SourceVolumeHostPath = fmt.Sprintf("%s/%s/", defaultApplicationLogPathHostRoot, md.imageName)
md.applicationLogMount = mp
} else {
mountPointMap[mp.SourceVolumeID] = mp
}
}
mountResult := []*MountPoint{}
for _, mp := range mountPointMap {
mountResult = append(mountResult, mp)
}
md.mountPoints = mountResult
return nil
}
// Used to set or to update the agentCommunicationMount
func (md *ManagedDaemon) SetAgentCommunicationMount(mp *MountPoint) error {
if mp.SourceVolumeID == defaultAgentCommunicationMount {
mp.SourceVolumeHostPath = fmt.Sprintf("%s/%s/", defaultAgentCommunicationPathHostRoot, md.imageName)
md.agentCommunicationMount = mp
return nil
} else {
return fmt.Errorf("AgentCommunicationMount %s must have a SourceVolumeID of %s", mp.SourceVolumeID, defaultAgentCommunicationMount)
}
}
// Used to set or to update the applicationLogMount
func (md *ManagedDaemon) SetApplicationLogMount(mp *MountPoint) error {
if mp.SourceVolumeID == defaultApplicationLogMount {
mp.SourceVolumeHostPath = fmt.Sprintf("%s/%s/", defaultApplicationLogPathHostRoot, md.imageName)
md.applicationLogMount = mp
return nil
} else {
return fmt.Errorf("ApplicationLogMount %s must have a SourceVolumeID of %s", mp.SourceVolumeID, defaultApplicationLogMount)
}
}
func (md *ManagedDaemon) SetEnvironment(environment map[string]string) {
md.environment = make(map[string]string)
for key, val := range environment {
md.environment[key] = val
}
}
func (md *ManagedDaemon) SetLoadedDaemonImageRef(loadedImageRef string) {
md.loadedDaemonImageRef = loadedImageRef
}
func (md *ManagedDaemon) SetPrivileged(isPrivileged bool) {
md.privileged = isPrivileged
}
// AddMountPoint will add by MountPoint.SourceVolume
// which is unique to the task and is a required field
// and will throw an error if an existing
// MountPoint.SourceVolume is found
func (md *ManagedDaemon) AddMountPoint(mp *MountPoint) error {
mountIndex := md.GetMountPointIndex(mp)
if mountIndex != -1 {
return fmt.Errorf("MountPoint already exists at index %d", mountIndex)
}
md.mountPoints = append(md.mountPoints, mp)
return nil
}
// UpdateMountPoint will update by
// MountPoint.SourceVolume which is unique to the task
// and will throw an error if the MountPoint.SourceVolume
// is not found
func (md *ManagedDaemon) UpdateMountPointBySourceVolume(mp *MountPoint) error {
mountIndex := md.GetMountPointIndex(mp)
if mountIndex == -1 {
return fmt.Errorf("MountPoint %s not found; will not update", mp.SourceVolume)
}
md.mountPoints[mountIndex] = mp
return nil
}
// UpdateMountPoint will delete by
// MountPoint.SourceVolume which is unique to the task
// and will throw an error if the MountPoint.SourceVolume
// is not found
func (md *ManagedDaemon) DeleteMountPoint(mp *MountPoint) error {
mountIndex := md.GetMountPointIndex(mp)
if mountIndex == -1 {
return fmt.Errorf("MountPoint %s not found; will not delete", mp.SourceVolume)
}
md.mountPoints = append(md.mountPoints[:mountIndex], md.mountPoints[mountIndex+1:]...)
return nil
}
// GetMountPointIndex will return index of a mountpoint or -1
// search by the unique MountPoint.SourceVolume field
func (md *ManagedDaemon) GetMountPointIndex(mp *MountPoint) int {
sourceVolume := mp.SourceVolume
for i, mount := range md.mountPoints {
if mount.SourceVolume == sourceVolume {
return i
}
}
return -1
}
// AddEnvVar will add by envKey
// and will throw an error if an existing
// envKey is found
func (md *ManagedDaemon) AddEnvVar(envKey string, envVal string) error {
_, exists := md.environment[envKey]
if !exists {
md.environment[envKey] = envVal
return nil
}
return fmt.Errorf("EnvKey: %s already exists; will not add EnvVal: %s", envKey, envVal)
}
// Updates environment varable by evnKey
// and will throw an error if the envKey
// is not found
func (md *ManagedDaemon) UpdateEnvVar(envKey string, envVal string) error {
_, ok := md.environment[envKey]
if !ok {
return fmt.Errorf("EnvKey: %s not found; will not update EnvVal: %s", envKey, envVal)
}
md.environment[envKey] = envVal
return nil
}
// Deletes environment variable by envKey
// and will throw an error if the envKey
// is not found
func (md *ManagedDaemon) DeleteEnvVar(envKey string) error {
_, ok := md.environment[envKey]
if !ok {
return fmt.Errorf("EnvKey: %s not found; will not delete", envKey)
}
delete(md.environment, envKey)
return nil
}
// Generates a DockerHealthConfig object from the
// ManagedDaeemon Health Check fields
func (md *ManagedDaemon) GetDockerHealthConfig() *dockercontainer.HealthConfig {
return &dockercontainer.HealthConfig{
Test: md.healthCheckTest,
Interval: md.healthCheckInterval,
Timeout: md.healthCheckTimeout,
Retries: md.healthCheckRetries,
}
}
// Validates that all required fields are present and valid
func (md *ManagedDaemon) IsValidManagedDaemon() bool {
isValid := true
isValid = isValid && (md.agentCommunicationMount != nil)
isValid = isValid && (md.applicationLogMount != nil)
return isValid
}