/
libcarina.go
473 lines (398 loc) · 12 KB
/
libcarina.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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
package libcarina
import (
"archive/zip"
"bytes"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"path"
"regexp"
"strings"
"github.com/pkg/errors"
"github.com/rackspace/gophercloud"
"github.com/rackspace/gophercloud/rackspace"
)
// UserAgentPrefix is the default user agent string, consumers should append their application version to `CarinaClient.UserAgent`.
const UserAgentPrefix = "libcarina/" + LibVersion
// CarinaClient accesses Carina directly
type CarinaClient struct {
Client *http.Client
Username string
Token string
Endpoint string
UserAgent string
}
// HTTPErr is returned when API requests are not successful
type HTTPErr struct {
Method string
URL string
StatusCode int
Status string
Body string
}
// CarinaGenericErrorResponse represents the response returned by Carina when a request fails
type CarinaGenericErrorResponse struct {
Errors []CarinaError `json:"errors"`
}
// CarinaError represents an error message from the Carina API
type CarinaError struct {
Code string `json:"code"`
Detail string `json:"detail"`
RequestID string `json:"request_id"`
Status int `json:"status"`
Title string `json:"title"`
}
// CarinaUnacceptableErrorResonse represents the response returned by Carina when the StatusCode is 406
type CarinaUnacceptableErrorResonse struct {
Errors []CarinaUnacceptableError `json:"errors"`
}
// CarinaUnacceptableError represents a 406 response from the Carina API
type CarinaUnacceptableError struct {
CarinaError
MaxVersion string `json:"max_version"`
MinVersion string `json:"min_version"`
}
// genericError is a multi-purpose error formatter for generic errors from the Carina API
func (err HTTPErr) genericError() string {
var carinaResp CarinaGenericErrorResponse
jsonErr := json.Unmarshal([]byte(err.Body), &carinaResp)
if jsonErr != nil {
return fmt.Sprintf("%s %s (%d)", err.Method, err.URL, err.StatusCode)
}
var errorMessages bytes.Buffer
for _, carinaErr := range carinaResp.Errors {
errorMessages.WriteString("\nMessage: ")
errorMessages.WriteString(carinaErr.Title)
errorMessages.WriteString(" - ")
errorMessages.WriteString(carinaErr.Detail)
}
return fmt.Sprintf("%s %s (%d)%s", err.Method, err.URL, err.StatusCode, errorMessages.String())
}
// unacceptableError is a error formatter for parsing a 406 response from the Carina API
func (err HTTPErr) unacceptableError() string {
var carinaResp CarinaUnacceptableErrorResonse
jsonErr := json.Unmarshal([]byte(err.Body), &carinaResp)
if jsonErr != nil {
return err.genericError()
}
var errorMessages bytes.Buffer
for _, carinaErr := range carinaResp.Errors {
errorMessages.WriteString("\nMessage: ")
errorMessages.WriteString(carinaErr.Title)
errorMessages.WriteString(" - The client supports ")
errorMessages.WriteString(SupportedAPIVersion)
errorMessages.WriteString(" while the server supports ")
errorMessages.WriteString(carinaErr.MinVersion)
errorMessages.WriteString(" - ")
errorMessages.WriteString(carinaErr.MaxVersion)
errorMessages.WriteString(".")
}
return fmt.Sprintf("%s %s (%d)%s", err.Method, err.URL, err.StatusCode, errorMessages.String())
}
// Error routes to either genericError or other, more-specific, response formatters to give provide a user-friendly error
func (err HTTPErr) Error() string {
switch err.StatusCode {
default:
return err.genericError()
case 406:
return err.unacceptableError()
}
}
// NewClient create an authenticated CarinaClient
func NewClient(username string, apikey string, region string, authEndpointOverride string, cachedToken string, cachedEndpoint string) (*CarinaClient, error) {
authEndpoint := rackspace.RackspaceUSIdentity
if authEndpointOverride != "" {
authEndpoint = authEndpointOverride
}
verifyToken := func() error {
req, err := http.NewRequest("HEAD", authEndpoint+"tokens/"+cachedToken, nil)
if err != nil {
return errors.WithStack(err)
}
req.Header.Add("Accept", "application/json")
req.Header.Add("X-Auth-Token", cachedToken)
req.Header.Add("User-Agent", UserAgentPrefix)
httpClient := &http.Client{}
resp, err := httpClient.Do(req)
if err != nil {
return errors.WithStack(err)
}
defer resp.Body.Close()
if resp.StatusCode != 200 {
return fmt.Errorf("Cached token is invalid")
}
return nil
}
// Attempt to authenticate with the cached token first, falling back on the apikey
if cachedToken == "" || verifyToken() != nil {
ao := &gophercloud.AuthOptions{
Username: username,
APIKey: apikey,
IdentityEndpoint: authEndpoint,
}
provider, err := rackspace.AuthenticatedClient(*ao)
if err != nil {
return nil, errors.WithStack(err)
}
cachedToken = provider.TokenID
eo := gophercloud.EndpointOpts{Region: region}
eo.ApplyDefaults(CarinaEndpointType)
url, err := provider.EndpointLocator(eo)
if err != nil {
return nil, errors.WithStack(err)
}
cachedEndpoint = strings.TrimRight(url, "/")
}
return &CarinaClient{
Client: &http.Client{},
Username: username,
Token: cachedToken,
Endpoint: cachedEndpoint,
UserAgent: UserAgentPrefix,
}, nil
}
// NewRequest handles a request using auth used by Carina
func (c *CarinaClient) NewRequest(method string, uri string, body io.Reader) (*http.Response, error) {
req, err := http.NewRequest(method, c.Endpoint+uri, body)
if err != nil {
return nil, errors.WithStack(err)
}
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("X-Auth-Token", c.Token)
req.Header.Set("User-Agent", c.UserAgent)
req.Header.Add("API-Version", CarinaEndpointType+" "+SupportedAPIVersion)
resp, err := c.Client.Do(req)
if err != nil {
return nil, errors.WithStack(err)
}
if resp.StatusCode >= 400 {
err := HTTPErr{
Method: req.Method,
URL: req.URL.String(),
StatusCode: resp.StatusCode,
Status: resp.Status,
}
defer resp.Body.Close()
b, _ := ioutil.ReadAll(resp.Body)
err.Body = string(b)
return nil, errors.WithStack(err)
}
return resp, nil
}
// List the current clusters
func (c *CarinaClient) List() ([]*Cluster, error) {
resp, err := c.NewRequest("GET", "/clusters", nil)
if err != nil {
return nil, err
}
var result struct {
Clusters []*Cluster `json:"clusters"`
}
defer resp.Body.Close()
err = json.NewDecoder(resp.Body).Decode(&result)
if err != nil {
return nil, errors.WithStack(err)
}
return result.Clusters, nil
}
func clusterFromResponse(resp *http.Response, err error) (*Cluster, error) {
if err != nil {
return nil, errors.WithStack(err)
}
cluster := &Cluster{}
defer resp.Body.Close()
err = json.NewDecoder(resp.Body).Decode(&cluster)
if err != nil {
return nil, errors.WithStack(err)
}
return cluster, nil
}
func isClusterID(token string) bool {
r := regexp.MustCompile("^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$")
return r.MatchString(token)
}
func (c *CarinaClient) lookupClusterName(token string) (string, error) {
if !isClusterID(token) {
return token, nil
}
clusters, err := c.List()
if err != nil {
return "", err
}
var name string
for _, cluster := range clusters {
if strings.ToLower(cluster.ID) == strings.ToLower(token) {
name = cluster.Name
break
}
}
if name == "" {
return "", HTTPErr{
StatusCode: http.StatusNotFound,
Status: "404 NOT FOUND",
Body: `{"message": "Cluster "` + token + ` not found"}`}
}
return name, nil
}
func (c *CarinaClient) lookupClusterID(token string) (string, error) {
if isClusterID(token) {
return token, nil
}
clusters, err := c.List()
if err != nil {
return "", err
}
var id string
for _, cluster := range clusters {
if strings.ToLower(cluster.Name) == strings.ToLower(token) {
if id != "" {
return "", fmt.Errorf("The cluster (%s) is not unique. Retry the request using the cluster id", token)
}
id = cluster.ID
}
}
if id == "" {
return "", HTTPErr{
StatusCode: http.StatusNotFound,
Status: "404 NOT FOUND",
Body: `{"message": "Cluster "` + token + ` not found"}`}
}
return id, nil
}
// ListClusterTypes returns a list of cluster types
func (c *CarinaClient) ListClusterTypes() ([]*ClusterType, error) {
resp, err := c.NewRequest("GET", "/cluster_types", nil)
if err != nil {
return nil, err
}
var result struct {
Types []*ClusterType `json:"cluster_types"`
}
defer resp.Body.Close()
err = json.NewDecoder(resp.Body).Decode(&result)
if err != nil {
return nil, errors.WithStack(err)
}
return result.Types, nil
}
// Get a cluster by cluster by its name or id
func (c *CarinaClient) Get(token string) (*Cluster, error) {
id, err := c.lookupClusterID(token)
if err != nil {
return nil, err
}
uri := path.Join("/clusters", id)
resp, err := c.NewRequest("GET", uri, nil)
return clusterFromResponse(resp, err)
}
// Create a new cluster with cluster options
func (c *CarinaClient) Create(clusterOpts *CreateClusterOpts) (*Cluster, error) {
clusterOptsJSON, err := json.Marshal(clusterOpts)
if err != nil {
return nil, errors.WithStack(err)
}
body := bytes.NewReader(clusterOptsJSON)
resp, err := c.NewRequest("POST", "/clusters", body)
return clusterFromResponse(resp, err)
}
// Resize a cluster with resize task options
func (c *CarinaClient) Resize(token string, nodes int) (*Cluster, error) {
id, err := c.lookupClusterID(token)
if err != nil {
return nil, err
}
resizeOpts := newResizeOpts(nodes)
resizeOptsJSON, err := json.Marshal(resizeOpts)
if err != nil {
return nil, errors.WithStack(err)
}
body := bytes.NewReader(resizeOptsJSON)
uri := path.Join("/clusters", id, "tasks")
resp, err := c.NewRequest("POST", uri, body)
if err != nil {
return nil, err
}
defer resp.Body.Close()
return c.Get(token)
}
// GetCredentials returns a Credentials struct for the given cluster name
func (c *CarinaClient) GetCredentials(token string) (*CredentialsBundle, error) {
id, err := c.lookupClusterID(token)
if err != nil {
return nil, err
}
name, err := c.lookupClusterName(token)
if err != nil {
return nil, err
}
uri := path.Join("/clusters", id, "credentials/zip")
resp, err := c.NewRequest("GET", uri, nil)
if err != nil {
return nil, err
}
// Read the body as a zip file
buf := &bytes.Buffer{}
_, err = io.Copy(buf, resp.Body)
if err != nil {
return nil, errors.WithStack(err)
}
b := bytes.NewReader(buf.Bytes())
zipr, err := zip.NewReader(b, int64(b.Len()))
if err != nil {
return nil, errors.WithStack(err)
}
// Fetch the contents for each file in the zipfile
creds := NewCredentialsBundle()
for _, zf := range zipr.File {
_, fname := path.Split(zf.Name)
fi := zf.FileInfo()
if fi.IsDir() {
// Explicitly skip past directories (the UUID directory from a previous release)
continue
}
rc, err := zf.Open()
if err != nil {
return nil, errors.WithStack(err)
}
b, err := ioutil.ReadAll(rc)
if err != nil {
return nil, errors.WithStack(err)
}
creds.Files[fname] = b
}
appendClusterName(name, creds)
return creds, nil
}
// Set the CLUSTER_NAME environment variable in the scripts
func appendClusterName(name string, creds *CredentialsBundle) {
addStmt := func(fileName string, stmt string) {
script := creds.Files[fileName]
script = append(script, []byte(stmt)...)
creds.Files[fileName] = script
}
for fileName := range creds.Files {
switch fileName {
case "docker.env", "kubectl.env":
addStmt(fileName, fmt.Sprintf("\nexport CARINA_CLUSTER_NAME=%s\n", name))
case "docker.fish", "kubectl.fish":
addStmt(fileName, fmt.Sprintf("\nset -x CARINA_CLUSTER_NAME %s\n", name))
case "docker.ps1", "kubectl.ps1":
addStmt(fileName, fmt.Sprintf("\n$env:CARINA_CLUSTER_NAME=\"%s\"\n", name))
case "docker.cmd", "kubectl.cmd":
addStmt(fileName, fmt.Sprintf("\nset CARINA_CLUSTER_NAME=%s\n", name))
}
}
}
// Delete nukes a cluster out of existence
func (c *CarinaClient) Delete(token string) (*Cluster, error) {
id, err := c.lookupClusterID(token)
if err != nil {
return nil, err
}
uri := path.Join("/clusters", id)
resp, err := c.NewRequest("DELETE", uri, nil)
return clusterFromResponse(resp, err)
}