/
metadata.go
336 lines (301 loc) · 10.4 KB
/
metadata.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
// Copyright 2015 Canonical Ltd.
// Licensed under the AGPLv3, see LICENCE file for details.
package imagemetadata
import (
"sort"
"strings"
"github.com/juju/errors"
"github.com/juju/loggo"
"github.com/juju/utils/series"
"github.com/juju/juju/apiserver/common"
"github.com/juju/juju/apiserver/facade"
"github.com/juju/juju/apiserver/params"
"github.com/juju/juju/environs"
"github.com/juju/juju/environs/config"
envmetadata "github.com/juju/juju/environs/imagemetadata"
"github.com/juju/juju/environs/simplestreams"
"github.com/juju/juju/permission"
"github.com/juju/juju/state"
"github.com/juju/juju/state/cloudimagemetadata"
"github.com/juju/juju/state/stateenvirons"
)
var logger = loggo.GetLogger("juju.apiserver.imagemetadata")
func init() {
common.RegisterStandardFacade("ImageMetadata", 2, NewAPI)
}
// API is the concrete implementation of the api end point
// for loud image metadata manipulations.
type API struct {
metadata metadataAcess
newEnviron func() (environs.Environ, error)
authorizer facade.Authorizer
}
// createAPI returns a new image metadata API facade.
func createAPI(
st metadataAcess,
newEnviron func() (environs.Environ, error),
resources facade.Resources,
authorizer facade.Authorizer,
) (*API, error) {
if !authorizer.AuthClient() && !authorizer.AuthModelManager() {
return nil, common.ErrPerm
}
return &API{
metadata: st,
newEnviron: newEnviron,
authorizer: authorizer,
}, nil
}
// NewAPI returns a new cloud image metadata API facade.
func NewAPI(
st *state.State,
resources facade.Resources,
authorizer facade.Authorizer,
) (*API, error) {
newEnviron := func() (environs.Environ, error) {
return stateenvirons.GetNewEnvironFunc(environs.New)(st)
}
return createAPI(getState(st), newEnviron, resources, authorizer)
}
// List returns all found cloud image metadata that satisfy
// given filter.
// Returned list contains metadata ordered by priority.
func (api *API) List(filter params.ImageMetadataFilter) (params.ListCloudImageMetadataResult, error) {
if api.authorizer.AuthClient() {
admin, err := api.authorizer.HasPermission(permission.SuperuserAccess, api.metadata.ControllerTag())
if err != nil {
return params.ListCloudImageMetadataResult{}, errors.Trace(err)
}
if !admin {
return params.ListCloudImageMetadataResult{}, common.ServerError(common.ErrPerm)
}
}
found, err := api.metadata.FindMetadata(cloudimagemetadata.MetadataFilter{
Region: filter.Region,
Series: filter.Series,
Arches: filter.Arches,
Stream: filter.Stream,
VirtType: filter.VirtType,
RootStorageType: filter.RootStorageType,
})
if err != nil {
return params.ListCloudImageMetadataResult{}, common.ServerError(err)
}
var all []params.CloudImageMetadata
addAll := func(ms []cloudimagemetadata.Metadata) {
for _, m := range ms {
all = append(all, parseMetadataToParams(m))
}
}
for _, ms := range found {
addAll(ms)
}
sort.Sort(metadataList(all))
return params.ListCloudImageMetadataResult{Result: all}, nil
}
// Save stores given cloud image metadata.
// It supports bulk calls.
func (api *API) Save(metadata params.MetadataSaveParams) (params.ErrorResults, error) {
all := make([]params.ErrorResult, len(metadata.Metadata))
if api.authorizer.AuthClient() {
admin, err := api.authorizer.HasPermission(permission.SuperuserAccess, api.metadata.ControllerTag())
if err != nil {
return params.ErrorResults{Results: all}, errors.Trace(err)
}
if !admin {
return params.ErrorResults{Results: all}, common.ServerError(common.ErrPerm)
}
}
if len(metadata.Metadata) == 0 {
return params.ErrorResults{Results: all}, nil
}
modelCfg, err := api.metadata.ModelConfig()
if err != nil {
return params.ErrorResults{}, errors.Annotatef(err, "getting model config")
}
for i, one := range metadata.Metadata {
md := api.parseMetadataListFromParams(one, modelCfg)
err := api.metadata.SaveMetadata(md)
all[i] = params.ErrorResult{Error: common.ServerError(err)}
}
return params.ErrorResults{Results: all}, nil
}
// Delete deletes cloud image metadata for given image ids.
// It supports bulk calls.
func (api *API) Delete(images params.MetadataImageIds) (params.ErrorResults, error) {
all := make([]params.ErrorResult, len(images.Ids))
if api.authorizer.AuthClient() {
admin, err := api.authorizer.HasPermission(permission.SuperuserAccess, api.metadata.ControllerTag())
if err != nil {
return params.ErrorResults{Results: all}, errors.Trace(err)
}
if !admin {
return params.ErrorResults{Results: all}, common.ServerError(common.ErrPerm)
}
}
for i, imageId := range images.Ids {
err := api.metadata.DeleteMetadata(imageId)
all[i] = params.ErrorResult{common.ServerError(err)}
}
return params.ErrorResults{Results: all}, nil
}
func parseMetadataToParams(p cloudimagemetadata.Metadata) params.CloudImageMetadata {
result := params.CloudImageMetadata{
ImageId: p.ImageId,
Stream: p.Stream,
Region: p.Region,
Version: p.Version,
Series: p.Series,
Arch: p.Arch,
VirtType: p.VirtType,
RootStorageType: p.RootStorageType,
RootStorageSize: p.RootStorageSize,
Source: p.Source,
Priority: p.Priority,
}
return result
}
func (api *API) parseMetadataListFromParams(p params.CloudImageMetadataList, cfg *config.Config) []cloudimagemetadata.Metadata {
results := make([]cloudimagemetadata.Metadata, len(p.Metadata))
for i, metadata := range p.Metadata {
results[i] = cloudimagemetadata.Metadata{
MetadataAttributes: cloudimagemetadata.MetadataAttributes{
Stream: metadata.Stream,
Region: metadata.Region,
Version: metadata.Version,
Series: metadata.Series,
Arch: metadata.Arch,
VirtType: metadata.VirtType,
RootStorageType: metadata.RootStorageType,
RootStorageSize: metadata.RootStorageSize,
Source: metadata.Source,
},
Priority: metadata.Priority,
ImageId: metadata.ImageId,
}
// TODO (anastasiamac 2016-08-24) This is a band-aid solution.
// Once correct value is read from simplestreams, this needs to go.
// Bug# 1616295
if results[i].Stream == "" {
results[i].Stream = cfg.ImageStream()
}
}
return results
}
// UpdateFromPublishedImages retrieves currently published image metadata and
// updates stored ones accordingly.
func (api *API) UpdateFromPublishedImages() error {
if api.authorizer.AuthClient() {
admin, err := api.authorizer.HasPermission(permission.SuperuserAccess, api.metadata.ControllerTag())
if err != nil {
return errors.Trace(err)
}
if !admin {
return common.ServerError(common.ErrPerm)
}
}
return api.retrievePublished()
}
func (api *API) retrievePublished() error {
env, err := api.newEnviron()
if err != nil {
return errors.Annotatef(err, "getting environ")
}
sources, err := environs.ImageMetadataSources(env)
if err != nil {
return errors.Annotatef(err, "getting cloud specific image metadata sources")
}
cons := envmetadata.NewImageConstraint(simplestreams.LookupParams{})
if inst, ok := env.(simplestreams.HasRegion); !ok {
// Published image metadata for some providers are in simple streams.
// Providers that do not rely on simplestreams, don't need to do anything here.
return nil
} else {
// If we can determine current region,
// we want only metadata specific to this region.
cloud, err := inst.Region()
if err != nil {
return errors.Annotatef(err, "getting cloud specific region information")
}
cons.CloudSpec = cloud
}
// We want all relevant metadata from all data sources.
for _, source := range sources {
logger.Debugf("looking in data source %v", source.Description())
metadata, info, err := envmetadata.Fetch([]simplestreams.DataSource{source}, cons)
if err != nil {
// Do not stop looking in other data sources if there is an issue here.
logger.Errorf("encountered %v while getting published images metadata from %v", err, source.Description())
continue
}
err = api.saveAll(info, source.Priority(), metadata)
if err != nil {
// Do not stop looking in other data sources if there is an issue here.
logger.Errorf("encountered %v while saving published images metadata from %v", err, source.Description())
}
}
return nil
}
func (api *API) saveAll(info *simplestreams.ResolveInfo, priority int, published []*envmetadata.ImageMetadata) error {
metadata, parseErrs := convertToParams(info, priority, published)
// Store converted metadata.
// Note that whether the metadata actually needs
// to be stored will be determined within this call.
errs, err := api.Save(metadata)
if err != nil {
return errors.Annotatef(err, "saving published images metadata")
}
return processErrors(append(errs.Results, parseErrs...))
}
// convertToParams converts model-specific images metadata to structured metadata format.
var convertToParams = func(info *simplestreams.ResolveInfo, priority int, published []*envmetadata.ImageMetadata) (params.MetadataSaveParams, []params.ErrorResult) {
metadata := []params.CloudImageMetadataList{{}}
errs := []params.ErrorResult{}
for _, p := range published {
s, err := series.VersionSeries(p.Version)
if err != nil {
errs = append(errs, params.ErrorResult{Error: common.ServerError(err)})
continue
}
m := params.CloudImageMetadata{
Source: info.Source,
ImageId: p.Id,
Stream: p.Stream,
Region: p.RegionName,
Arch: p.Arch,
VirtType: p.VirtType,
RootStorageType: p.Storage,
Series: s,
Priority: priority,
}
metadata[0].Metadata = append(metadata[0].Metadata, m)
}
return params.MetadataSaveParams{Metadata: metadata}, errs
}
func processErrors(errs []params.ErrorResult) error {
msgs := []string{}
for _, e := range errs {
if e.Error != nil && e.Error.Message != "" {
msgs = append(msgs, e.Error.Message)
}
}
if len(msgs) != 0 {
return errors.Errorf("saving some image metadata:\n%v", strings.Join(msgs, "\n"))
}
return nil
}
// metadataList is a convenience type enabling to sort
// a collection of Metadata in order of priority.
type metadataList []params.CloudImageMetadata
// Len implements sort.Interface
func (m metadataList) Len() int {
return len(m)
}
// Less implements sort.Interface and sorts image metadata by priority.
func (m metadataList) Less(i, j int) bool {
return m[i].Priority < m[j].Priority
}
// Swap implements sort.Interface
func (m metadataList) Swap(i, j int) {
m[i], m[j] = m[j], m[i]
}