/
exporter.go
183 lines (164 loc) · 6.76 KB
/
exporter.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
// Copyright 2020 Google Inc. 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.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License 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 ovfexporter
import (
"context"
"fmt"
"strings"
daisy "github.com/GoogleCloudPlatform/compute-daisy"
daisyCompute "github.com/GoogleCloudPlatform/compute-daisy/compute"
"google.golang.org/api/compute/v1"
"google.golang.org/api/option"
commondisk "github.com/GoogleCloudPlatform/compute-image-import/cli_tools/common/disk"
"github.com/GoogleCloudPlatform/compute-image-import/cli_tools/common/domain"
computeutils "github.com/GoogleCloudPlatform/compute-image-import/cli_tools/common/utils/compute"
"github.com/GoogleCloudPlatform/compute-image-import/cli_tools/common/utils/logging"
"github.com/GoogleCloudPlatform/compute-image-import/cli_tools/common/utils/logging/service"
storageutils "github.com/GoogleCloudPlatform/compute-image-import/cli_tools/common/utils/storage"
ovfexportdomain "github.com/GoogleCloudPlatform/compute-image-import/cli_tools/gce_ovf_export/domain"
"github.com/GoogleCloudPlatform/compute-image-import/proto/go/pb"
)
const (
// LogPrefix is prefix for OVF export log lines
LogPrefix = "[ovf-export]"
bytesPerGB = int64(1024 * 1024 * 1024)
)
// OVFExporter is responsible for exporting GCE VMs/GMIs to OVF/OVA
type OVFExporter struct {
storageClient domain.StorageClientInterface
computeClient daisyCompute.Client
mgce domain.MetadataGCEInterface
bucketIteratorCreator domain.BucketIteratorCreatorInterface
Logger logging.Logger
instanceDisksExporter ovfexportdomain.InstanceDisksExporter
instanceExportPreparer ovfexportdomain.InstanceExportPreparer
instanceExportCleaner ovfexportdomain.InstanceExportCleaner
params *ovfexportdomain.OVFExportArgs
// BuildID is ID of Cloud Build in which this OVF export runs in
BuildID string
inspector commondisk.Inspector
ovfDescriptorGenerator ovfexportdomain.OvfDescriptorGenerator
manifestFileGenerator ovfexportdomain.OvfManifestGenerator
exportedDisks []*ovfexportdomain.ExportedDisk
bootDiskInspectionResults *pb.InspectionResults
loggableBuilder *service.OvfExportLoggableBuilder
}
// NewOVFExporter creates an OVF exporter, including automatically populating dependencies,
// such as compute/storage clients.
func NewOVFExporter(params *ovfexportdomain.OVFExportArgs, logger logging.ToolLogger) (*OVFExporter, error) {
ctx := context.Background()
storageClient, err := storageutils.NewStorageClient(ctx, logger)
if err != nil {
return nil, err
}
computeClient, err := createComputeClient(&ctx, params)
if err != nil {
return nil, err
}
metadataGCE := &computeutils.MetadataGCE{}
paramValidator := NewOvfExportParamValidator(computeClient)
paramPopulator := NewPopulator(computeClient, metadataGCE, storageClient,
storageutils.NewResourceLocationRetriever(metadataGCE, computeClient),
storageutils.NewScratchBucketCreator(ctx, storageClient),
)
if err := validateAndPopulateParams(params, paramValidator, paramPopulator); err != nil {
return nil, err
}
inspector, err := commondisk.NewInspector(params.EnvironmentSettings("ovf-export-disk-inspect"), logger)
if err != nil {
return nil, daisy.Errf("Error creating disk inspector: %v", err)
}
return &OVFExporter{
storageClient: storageClient,
computeClient: computeClient,
mgce: metadataGCE,
bucketIteratorCreator: &storageutils.BucketIteratorCreator{},
Logger: logger,
params: params,
loggableBuilder: service.NewOvfExportLoggableBuilder(),
ovfDescriptorGenerator: NewOvfDescriptorGenerator(computeClient, storageClient, params.Project, params.Zone),
manifestFileGenerator: NewManifestFileGenerator(storageClient),
inspector: inspector,
instanceDisksExporter: NewInstanceDisksExporter(computeClient, storageClient, logger),
instanceExportPreparer: NewInstanceExportPreparer(logger),
instanceExportCleaner: NewInstanceExportCleaner(logger),
}, nil
}
// validateAndPopulateParams validate and populate OVF export params
func validateAndPopulateParams(params *ovfexportdomain.OVFExportArgs,
paramValidator ovfexportdomain.OvfExportParamValidator,
paramPopulator ovfexportdomain.OvfExportParamPopulator) error {
if err := paramValidator.ValidateAndParseParams(params); err != nil {
return err
}
if err := paramPopulator.Populate(params); err != nil {
return err
}
return nil
}
// creates a new Daisy Compute client
// TODO: consolidate with ovf_importer.createComputeClient
func createComputeClient(ctx *context.Context, params *ovfexportdomain.OVFExportArgs) (daisyCompute.Client, error) {
computeOptions := []option.ClientOption{option.WithCredentialsFile(params.Oauth)}
if params.Ce != "" {
computeOptions = append(computeOptions, option.WithEndpoint(params.Ce))
}
computeClient, err := daisyCompute.NewClient(*ctx, computeOptions...)
if err != nil {
return nil, err
}
return computeClient, nil
}
func getInstancePath(instance *compute.Instance, project string) string {
return fmt.Sprintf("projects/%s/zones/%s/instances/%s", project, instance.Zone[strings.LastIndex(instance.Zone, "/")+1:], strings.ToLower(instance.Name))
}
// Export runs OVF export
func (oe *OVFExporter) run(ctx context.Context) error {
oe.Logger.User("Starting OVF export.")
if oe.params.Timeout.Nanoseconds() > 0 {
var cancel func()
ctx, cancel = context.WithTimeout(ctx, oe.params.Timeout)
defer cancel()
}
//TODO: if machine image export, create instance from machine image and add it to cleanup
instance, err := oe.computeClient.GetInstance(oe.params.Project, oe.params.Zone, oe.params.InstanceName)
if err != nil {
return daisy.Errf("Error retrieving instance `%v`: %v", oe.params.InstanceName, err)
}
defer func() {
oe.cleanup(instance, err)
}()
if err = oe.prepare(ctx, instance); err != nil {
return err
}
if err := oe.exportDisks(ctx, instance); err != nil {
return err
}
if err := oe.inspectBootDisk(ctx); err != nil {
return err
}
if err = oe.generateDescriptor(ctx, instance); err != nil {
return err
}
if err = oe.generateManifest(ctx); err != nil {
return err
}
return nil
}
// Run runs OVF export.
func (oe *OVFExporter) Run(ctx context.Context) error {
var err error
err = oe.run(ctx)
return err
}