forked from openshift/origin
-
Notifications
You must be signed in to change notification settings - Fork 1
/
helper.go
246 lines (223 loc) · 7.16 KB
/
helper.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
package dockerhelper
import (
"bytes"
"errors"
"fmt"
"io"
"net"
"net/url"
"regexp"
"strconv"
"github.com/docker/engine-api/client"
"github.com/docker/engine-api/types"
"github.com/golang/glog"
"github.com/openshift/imagebuilder/imageprogress"
starterrors "github.com/openshift/origin/pkg/oc/bootstrap/docker/errors"
)
const openShiftInsecureCIDR = "172.30.0.0/16"
// Helper provides utility functions to help with Docker
type Helper struct {
client Interface
info *types.Info
}
// NewHelper creates a new Helper
func NewHelper(client Interface) *Helper {
return &Helper{
client: client,
}
}
func (h *Helper) Client() Interface {
return h.client
}
func (h *Helper) dockerInfo() (*types.Info, error) {
if h.info != nil {
return h.info, nil
}
if h.client == nil {
return nil, fmt.Errorf("the Docker engine API client is not initialized")
}
glog.V(5).Infof("Retrieving Docker daemon info")
info, err := h.client.Info()
if err != nil {
glog.V(2).Infof("Could not retrieve Docker info: %v", err)
return nil, err
}
glog.V(5).Infof("Docker daemon info: %#v", info)
h.info = info
return h.info, nil
}
func (h *Helper) CgroupDriver() (string, error) {
info, err := h.dockerInfo()
if err != nil {
return "", err
}
return info.CgroupDriver, nil
}
// InsecureRegistryIsConfigured checks to see if the Docker daemon has an appropriate insecure registry argument set so that our services can access the registry
//hasEntries specifies if Docker daemon has entries at all
func (h *Helper) InsecureRegistryIsConfigured() (configured bool, hasEntries bool, error error) {
info, err := h.dockerInfo()
if err != nil {
return false, false, err
}
registryConfig := NewRegistryConfig(info)
if !registryConfig.HasCustomInsecureRegistryCIDRs() {
return false, false, nil
}
containsRegistryCIDR, err := registryConfig.ContainsInsecureRegistryCIDR(openShiftInsecureCIDR)
if err != nil {
return false, true, err
}
return containsRegistryCIDR, true, nil
}
var (
fedoraPackage = regexp.MustCompile("\\.fc[0-9_]*\\.")
rhelPackage = regexp.MustCompile("\\.el[0-9_]*\\.")
)
// DockerRoot returns the root directory for Docker
func (h *Helper) DockerRoot() (string, error) {
info, err := h.dockerInfo()
if err != nil {
return "", err
}
return info.DockerRootDir, nil
}
// Version returns the Docker API version and whether it is a Red Hat distro version
func (h *Helper) APIVersion() (string, bool, error) {
glog.V(5).Infof("Retrieving Docker version")
version, err := h.client.ServerVersion()
if err != nil {
glog.V(2).Infof("Error retrieving version: %v", err)
return "", false, err
}
glog.V(5).Infof("Docker version results: %#v", version)
if len(version.APIVersion) == 0 {
return "", false, errors.New("did not get an API version")
}
glog.V(5).Infof("APIVersion: %s", version.APIVersion)
isRedHat := false
kernelVersion := version.KernelVersion
if len(kernelVersion) > 0 {
isRedHat = fedoraPackage.MatchString(kernelVersion) || rhelPackage.MatchString(kernelVersion)
}
return version.APIVersion, isRedHat, nil
}
func (h *Helper) GetDockerProxySettings() (httpProxy, httpsProxy, noProxy string, err error) {
info, err := h.dockerInfo()
if err != nil {
return "", "", "", err
}
return info.HTTPProxy, info.HTTPSProxy, info.NoProxy, nil
}
// CheckAndPull checks whether a Docker image exists. If not, it pulls it.
func (h *Helper) CheckAndPull(image string, out io.Writer) error {
glog.V(5).Infof("Inspecting Docker image %q", image)
imageMeta, _, err := h.client.ImageInspectWithRaw(image, false)
if err == nil {
glog.V(5).Infof("Image %q found: %#v", image, imageMeta)
return nil
}
if !client.IsErrImageNotFound(err) {
return starterrors.NewError("unexpected error inspecting image %s", image).WithCause(err)
}
glog.V(5).Infof("Image %q not found. Pulling", image)
fmt.Fprintf(out, "Pulling image %s\n", image)
logProgress := func(s string) {
fmt.Fprintf(out, "%s\n", s)
}
pw := imageprogress.NewPullWriter(logProgress)
defer pw.Close()
outputStream := pw.(io.Writer)
if glog.V(5) {
outputStream = out
}
err = h.client.ImagePull(image, types.ImagePullOptions{}, outputStream)
if err != nil {
return starterrors.NewError("error pulling Docker image %s", image).WithCause(err)
}
fmt.Fprintf(out, "Image pull complete\n")
return nil
}
// GetContainerState returns whether a container exists and if it does whether it's running
func (h *Helper) GetContainerState(id string) (*types.ContainerJSON, bool, error) {
glog.V(5).Infof("Inspecting docker container %q", id)
container, err := h.client.ContainerInspect(id)
if err != nil {
if client.IsErrContainerNotFound(err) {
glog.V(5).Infof("Container %q was not found", id)
return nil, false, nil
}
glog.V(5).Infof("An error occurred inspecting container %q: %v", id, err)
return nil, false, err
}
glog.V(5).Infof("Container inspect result: %#v", container)
running := container.State != nil && container.State.Running
glog.V(5).Infof("Container running = %v", running)
return container, running, nil
}
// RemoveContainer removes the container with the given id
func (h *Helper) RemoveContainer(id string) error {
glog.V(5).Infof("Removing container %q", id)
err := h.client.ContainerRemove(id, types.ContainerRemoveOptions{})
if err != nil {
return starterrors.NewError("cannot delete container %s", id).WithCause(err)
}
glog.V(5).Infof("Removed container %q", id)
return nil
}
// HostIP returns the IP of the Docker host if connecting via TCP
func (h *Helper) HostIP() string {
// By default, if the Docker client uses tcp, then use the Docker daemon's address
endpoint := h.client.Endpoint()
u, err := url.Parse(endpoint)
if err == nil && (u.Scheme == "tcp" || u.Scheme == "http" || u.Scheme == "https") {
glog.V(2).Infof("Using the Docker host %s for the server IP", endpoint)
if host, _, serr := net.SplitHostPort(u.Host); serr == nil {
return host
}
return u.Host
}
glog.V(5).Infof("Cannot use Docker endpoint (%s) because it is not using one of the following protocols: tcp, http, https", endpoint)
return ""
}
func (h *Helper) ContainerLog(container string, numLines int) string {
outBuf := &bytes.Buffer{}
if err := h.client.ContainerLogs(container, types.ContainerLogsOptions{Tail: strconv.Itoa(numLines)}, outBuf, outBuf); err != nil {
glog.V(2).Infof("Error getting container %q log: %v", container, err)
}
return outBuf.String()
}
func (h *Helper) StopAndRemoveContainer(container string) error {
err := h.client.ContainerStop(container, 10)
if err != nil {
glog.V(2).Infof("Cannot stop container %s: %v", container, err)
}
return h.RemoveContainer(container)
}
func (h *Helper) ListContainerNames() ([]string, error) {
containers, err := h.client.ContainerList(types.ContainerListOptions{
All: true,
})
if err != nil {
return nil, err
}
names := []string{}
for _, c := range containers {
names = append(names, c.Names...)
}
return names, nil
}
// UserNamespaceEnabled checks whether docker daemon is running in user
// namespace mode.
func (h *Helper) UserNamespaceEnabled() (bool, error) {
info, err := h.dockerInfo()
if err != nil {
return false, err
}
for _, val := range info.SecurityOptions {
if val == "name=userns" {
return true, nil
}
}
return false, nil
}