-
Notifications
You must be signed in to change notification settings - Fork 4
/
collect.go
455 lines (385 loc) · 17.3 KB
/
collect.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
package cmd
import (
"fmt"
"net/url"
"os"
"path/filepath"
"strings"
"time"
"github.com/spf13/pflag"
"github.com/pivotal-cf/om/api"
"github.com/gofrs/uuid"
"github.com/pivotal-cf/aqueduct-courier/network"
"github.com/pivotal-cf/aqueduct-courier/consumption"
ogCredhub "code.cloudfoundry.org/credhub-cli/credhub"
"code.cloudfoundry.org/credhub-cli/credhub/auth"
"github.com/pivotal-cf/aqueduct-courier/cf"
"github.com/pivotal-cf/aqueduct-courier/credhub"
"github.com/pivotal-cf/aqueduct-courier/coreconsumption"
"github.com/pivotal-cf/aqueduct-courier/operations"
"github.com/pivotal-cf/aqueduct-courier/opsmanager"
omNetwork "github.com/pivotal-cf/om/network"
"github.com/pivotal-cf/telemetry-utils/tar"
"github.com/pkg/errors"
"github.com/spf13/cobra"
"github.com/spf13/viper"
)
const (
ConfigFileKey = "CONFIG_FILE"
OpsManagerURLKey = "OPS_MANAGER_URL"
OpsManagerURLAliasKey = "TARGET"
OpsManagerUsernameKey = "OPS_MANAGER_USERNAME"
OpsManagerPasswordKey = "OPS_MANAGER_PASSWORD"
OpsManagerClientIdKey = "OPS_MANAGER_CLIENT_ID"
OpsManagerClientSecretKey = "OPS_MANAGER_CLIENT_SECRET"
OpsManagerTimeoutKey = "OPS_MANAGER_TIMEOUT"
OpsManagerRequestTimeoutKey = "OPS_MANAGER_REQUEST_TIMEOUT"
EnvTypeKey = "ENV_TYPE"
OutputPathKey = "OUTPUT_DIR"
SkipTlsVerifyKey = "INSECURE_SKIP_TLS_VERIFY"
SkipTlsVerifyKeyAlias = "SKIP_SSL_VALIDATION"
WithCredhubInfoKey = "WITH_CREDHUB_INFO"
UsageServiceURLKey = "USAGE_SERVICE_URL"
UsageServiceClientIDKey = "USAGE_SERVICE_CLIENT_ID"
UsageServiceClientSecretKey = "USAGE_SERVICE_CLIENT_SECRET"
UsageServiceTimeoutKey = "USAGE_SERVICE_TIMEOUT"
CfApiURLKey = "CF_API_URL"
UsageServiceSkipTlsVerifyKey = "USAGE_SERVICE_INSECURE_SKIP_TLS_VERIFY"
FoundationNicknameKey = "FOUNDATION_NICKNAME"
OperationalDataOnlyKey = "OPERATIONAL_DATA_ONLY"
ConfigFlag = "config"
OpsManagerURLFlag = "url"
OpsManagerURLAliasFlag = "target"
OpsManagerUsernameFlag = "username"
OpsManagerPasswordFlag = "password"
OpsManagerClientIdFlag = "client-id"
OpsManagerClientSecretFlag = "client-secret"
OpsManagerTimeoutFlag = "ops-manager-timeout"
OpsManagerRequestTimeoutFlag = "ops-manager-request-timeout"
CollectFromCredhubFlag = "with-credhub-info"
EnvTypeFlag = "env-type"
OutputPathFlag = "output-dir"
SkipTlsVerifyFlag = "insecure-skip-tls-verify"
SkipTlsVerifyAliasFlag = "skip-ssl-validation"
UsageServiceURLFlag = "usage-service-url"
UsageServiceClientIDFlag = "usage-service-client-id"
UsageServiceClientSecretFlag = "usage-service-client-secret"
UsageServiceTimeoutFlag = "usage-service-timeout"
CfApiURLFlag = "cf-api-url"
UsageServiceSkipTlsVerifyFlag = "usage-service-insecure-skip-tls-verify"
FoundationNicknameFlag = "foundation-nickname"
OperationalDataOnlyFlag = "operational-data-only"
EnvTypeSandbox = "sandbox"
EnvTypeDevelopment = "development"
EnvTypeQA = "qa"
EnvTypePreProduction = "pre-production"
EnvTypeProduction = "production"
OutputFilePrefix = "FoundationDetails_"
CredhubClientError = "Failed creating credhub client"
InvalidEnvTypeFailureFormat = "Invalid env-type %s. See help for the list of valid types."
InvalidAuthConfigurationMessage = "Invalid auth configuration. Requires username/password or client/secret to be set."
InvalidUsageConfigurationMessage = "Not all usage service configurations provided."
CreateTarFileFailureFormat = "Could not create tar file %s"
UsageServiceURLParsingError = "error parsing Usage Service URL"
GetUAAURLError = "error getting UAA URL"
)
var collectCmd = &cobra.Command{
Use: "collect",
Short: "Collects information from a PCF foundation",
Long: "Collects information from Operations Manager and outputs the content to the configured directory.\nOptionally collects information from Usage Service and/or Credhub.",
RunE: collect,
}
func init() {
bindFlagAndEnvVar(collectCmd, OpsManagerURLFlag, "", fmt.Sprintf("``Ops Manager URL [$%s]", OpsManagerURLKey), OpsManagerURLKey)
bindFlagAndEnvVar(collectCmd, OpsManagerURLAliasFlag, "", fmt.Sprintf("``Ops Manager URL [$%s]", OpsManagerURLAliasKey), OpsManagerURLAliasKey)
_ = collectCmd.Flags().MarkHidden(OpsManagerURLAliasFlag)
bindFlagAndEnvVar(collectCmd, OpsManagerUsernameFlag, "", fmt.Sprintf("``Ops Manager username [$%s]", OpsManagerUsernameKey), OpsManagerUsernameKey)
bindFlagAndEnvVar(collectCmd, OpsManagerPasswordFlag, "", fmt.Sprintf("``Ops Manager password [$%s]", OpsManagerPasswordKey), OpsManagerPasswordKey)
bindFlagAndEnvVar(collectCmd, OpsManagerClientIdFlag, "", fmt.Sprintf("``Ops Manager client id [$%s]", OpsManagerClientIdKey), OpsManagerClientIdKey)
bindFlagAndEnvVar(collectCmd, OpsManagerClientSecretFlag, "", fmt.Sprintf("``Ops Manager client secret [$%s]", OpsManagerClientSecretKey), OpsManagerClientSecretKey)
bindFlagAndEnvVar(collectCmd, EnvTypeFlag, "", fmt.Sprintf("``Specify environment type (sandbox, development, qa, pre-production, production) [$%s]", EnvTypeKey), EnvTypeKey)
bindFlagAndEnvVar(collectCmd, FoundationNicknameFlag, "", fmt.Sprintf("``Specify foundation nickname used in reporting by VMware [$%s]", FoundationNicknameKey), FoundationNicknameKey)
bindFlagAndEnvVar(collectCmd, OperationalDataOnlyFlag, false, fmt.Sprintf("``Collect only operational data [$%s]", OperationalDataOnlyKey), OperationalDataOnlyKey)
bindFlagAndEnvVar(collectCmd, OpsManagerTimeoutFlag, 30, fmt.Sprintf("``Timeout on network connection to Ops Manager in seconds [$%s]", OpsManagerTimeoutKey), OpsManagerTimeoutKey)
bindFlagAndEnvVar(collectCmd, OpsManagerRequestTimeoutFlag, 30, fmt.Sprintf("``Timeout on request fulfillment from Ops Manager in seconds [$%s]", OpsManagerRequestTimeoutKey), OpsManagerRequestTimeoutKey)
bindFlagAndEnvVar(collectCmd, SkipTlsVerifyFlag, false, fmt.Sprintf("``Skip TLS validation on http requests to Ops Manager [$%s]\n", SkipTlsVerifyKey), SkipTlsVerifyKey)
bindFlagAndEnvVar(collectCmd, SkipTlsVerifyAliasFlag, false, fmt.Sprintf("``Ops Manager URL [$%s]", SkipTlsVerifyKeyAlias), SkipTlsVerifyKeyAlias)
_ = collectCmd.Flags().MarkHidden(SkipTlsVerifyAliasFlag)
bindFlagAndEnvVar(collectCmd, CfApiURLFlag, "", fmt.Sprintf("``CF API URL for UAA authentication to access Usage Service [$%s]", CfApiURLKey), CfApiURLKey)
bindFlagAndEnvVar(collectCmd, UsageServiceURLFlag, "", fmt.Sprintf("``Usage Service URL [$%s]", UsageServiceURLKey), UsageServiceURLKey)
bindFlagAndEnvVar(collectCmd, UsageServiceClientIDFlag, "", fmt.Sprintf("``Usage Service client id [$%s]", UsageServiceClientIDKey), UsageServiceClientIDKey)
bindFlagAndEnvVar(collectCmd, UsageServiceClientSecretFlag, "", fmt.Sprintf("``Usage Service client secret [$%s]", UsageServiceClientSecretKey), UsageServiceClientSecretKey)
bindFlagAndEnvVar(collectCmd, UsageServiceSkipTlsVerifyFlag, false, fmt.Sprintf("``Skip TLS validation for Usage Service components [$%s]\n", UsageServiceSkipTlsVerifyKey), UsageServiceSkipTlsVerifyKey)
bindFlagAndEnvVar(collectCmd, UsageServiceTimeoutFlag, 30, fmt.Sprintf("``Timeout on request connection and fulfillment to Usage Service in seconds [$%s]", UsageServiceTimeoutKey), UsageServiceTimeoutKey)
bindFlagAndEnvVar(collectCmd, CollectFromCredhubFlag, false, fmt.Sprintf("Include CredHub certificate expiry information [$%s]\n", WithCredhubInfoKey), WithCredhubInfoKey)
bindFlagAndEnvVar(collectCmd, OutputPathFlag, "", fmt.Sprintf("``Local directory to write data [$%s]\n", OutputPathKey), OutputPathKey)
bindFlagAndEnvVar(collectCmd, ConfigFlag, "", fmt.Sprintf("``Config file for all other command line arguments, requires a file extension e.g. '.yml' or '.json' [$%s]\n", ConfigFileKey), ConfigFileKey)
collectCmd.Flags().BoolP("help", "h", false, "Help for the collect command\n")
collectCmd.Flags().SortFlags = false
collectCmd.Example = `
Collect Telemetry data from Ops Manager only:
telemetry-collector collect --url --username --password [or --client-id and
--client-secret] --env-type --output-dir
Collect Telemetry and Operational data:
telemetry-collector collect --url --username --password [or --client-id and
--client-secret] --usage-service-url --usage-service-client-id
--usage-service-client-secret --cf-api-url --env-type --output-dir
Collect Operational Data only:
telemetry-collector collect --url --username --password [or --client-id and
--client-secret] --usage-service-url --usage-service-client-id
--usage-service-client-secret --cf-api-url --env-type --output-dir
--operational-data-only`
customUsageTextTemplate := `
USAGE EXAMPLES
{{.Example}}
FLAGS
{{.LocalFlags.FlagUsages}}`
customHelpTextTemplate := fmt.Sprintf(`
Collects information from a single Ops Manager (and optionally from
Usage Service and/or Credhub) and outputs the content to the configured directory.
%s`, customUsageTextTemplate)
collectCmd.SetHelpTemplate(customHelpTextTemplate)
collectCmd.SetUsageTemplate(customUsageTextTemplate)
rootCmd.AddCommand(collectCmd)
}
func collect(c *cobra.Command, _ []string) error {
if useConfigFile() {
viper.SetConfigFile(viper.GetString(ConfigFlag))
err := viper.ReadInConfig()
if err != nil {
return fmt.Errorf("error reading config file: %s \n", err)
}
}
handleAliases(c)
if err := verifyRequiredConfig(OpsManagerURLFlag, EnvTypeFlag, OutputPathFlag); err != nil {
return err
}
if err := validateCredConfig(); err != nil {
return err
}
envType, err := validateAndNormalizeEnvType()
if err != nil {
return err
}
foundationNickname, err := validateAndNormalizeFoundationNickname()
if err != nil {
return err
}
c.SilenceUsage = true
tarFilePath := filepath.Join(
viper.GetString(OutputPathFlag),
fmt.Sprintf("%s%d.tar", OutputFilePrefix, time.Now().UTC().Unix()),
)
tarFile, err := os.Create(tarFilePath)
if err != nil {
return errors.Wrapf(err, CreateTarFileFailureFormat, tarFilePath)
}
defer tarFile.Close()
tarWriter := tar.NewTarWriter(tarFile)
operationalDataOnly := viper.GetBool(OperationalDataOnlyFlag)
collectExecutor, err := makeCollector(tarWriter, operationalDataOnly)
if err != nil {
tarFile.Close()
os.Remove(tarFilePath)
return err
}
err = collectExecutor.Collect(envType, version, foundationNickname)
if err != nil {
tarFile.Close()
os.Remove(tarFilePath)
return err
}
logger.Printf("Wrote output to %s\n", tarFilePath)
logger.Println("Success!")
return nil
}
func handleAliases(c *cobra.Command) {
if viper.GetString(OpsManagerURLFlag) == "" {
viper.RegisterAlias(OpsManagerURLFlag, OpsManagerURLAliasFlag)
}
var originalPassedAsFlag, aliasedPassedAsFlag bool
c.Flags().Visit(func(flag *pflag.Flag) {
switch flag.Name {
case SkipTlsVerifyFlag:
originalPassedAsFlag = true
case SkipTlsVerifyAliasFlag:
aliasedPassedAsFlag = true
}
})
if (!originalPassedAsFlag && os.Getenv(SkipTlsVerifyKey) == "") || aliasedPassedAsFlag {
viper.RegisterAlias(SkipTlsVerifyFlag, SkipTlsVerifyAliasFlag)
}
}
func useConfigFile() bool {
return viper.GetString(ConfigFlag) != ""
}
func anyUsageServiceConfigsProvided() bool {
return viper.GetString(CfApiURLFlag) != "" ||
viper.GetString(UsageServiceURLFlag) != "" ||
viper.GetString(UsageServiceClientIDFlag) != "" ||
viper.GetString(UsageServiceClientSecretFlag) != ""
}
func validateUsageServiceConfig() error {
if viper.GetString(CfApiURLFlag) == "" ||
viper.GetString(UsageServiceURLFlag) == "" ||
viper.GetString(UsageServiceClientIDFlag) == "" ||
viper.GetString(UsageServiceClientSecretFlag) == "" {
return errors.New(InvalidUsageConfigurationMessage)
}
return nil
}
func validateCredConfig() error {
noUsernamePasswordAuth := viper.GetString(OpsManagerUsernameFlag) == "" || viper.GetString(OpsManagerPasswordFlag) == ""
noClientSecretAuth := viper.GetString(OpsManagerClientIdFlag) == "" || viper.GetString(OpsManagerClientSecretFlag) == ""
if noUsernamePasswordAuth && noClientSecretAuth {
return errors.New(InvalidAuthConfigurationMessage)
}
return nil
}
func validateAndNormalizeEnvType() (string, error) {
validEnvTypes := []string{EnvTypeSandbox, EnvTypeDevelopment, EnvTypeQA, EnvTypePreProduction, EnvTypeProduction}
envType := strings.ToLower(viper.GetString(EnvTypeFlag))
for _, validType := range validEnvTypes {
if validType == envType {
return envType, nil
}
}
return "", errors.Errorf(InvalidEnvTypeFailureFormat, envType)
}
func validateAndNormalizeFoundationNickname() (string, error) {
foundationNickname := viper.GetString(FoundationNicknameFlag)
return foundationNickname, nil
}
type consumptionDataCollector interface {
Collect() ([]consumption.Data, error)
}
type coreConsumptionDataCollector interface {
Collect() ([]coreconsumption.Data, error)
}
func makeConsumptionCollector() (consumptionDataCollector, error) {
if anyUsageServiceConfigsProvided() {
err := validateUsageServiceConfig()
if err != nil {
return nil, err
}
client := network.NewClient(viper.GetBool(UsageServiceSkipTlsVerifyFlag))
cfApiClient := cf.NewClient(viper.GetString(CfApiURLFlag), client)
usageURL, err := url.Parse(viper.GetString(UsageServiceURLFlag))
if err != nil {
return nil, errors.New(UsageServiceURLParsingError)
}
uaaURL, err := cfApiClient.GetUAAURL()
if err != nil {
return nil, errors.Wrap(err, GetUAAURLError)
}
authedClient := cf.NewOAuthClient(
uaaURL,
viper.GetString(UsageServiceClientIDFlag),
viper.GetString(UsageServiceClientSecretFlag),
time.Duration(viper.GetInt(UsageServiceTimeoutFlag))*time.Second,
client,
)
consumptionService := &consumption.Service{
BaseURL: usageURL,
Client: authedClient,
}
consumptionCollector := consumption.NewDataCollector(
logger,
consumptionService,
viper.GetString(UsageServiceURLFlag),
)
return consumptionCollector, nil
}
return nil, nil
}
func makeCoreConsumptionCollector(operationalDataOnly bool, apiService api.Api) (coreConsumptionDataCollector, error) {
// FIXME
// This doesn't accurately support the case where only TKGi
// is installed (not TAS) and the user has opted into both
// data programs.
// In order to support that scenario, we would need to add
// an additional flag. Something like `--core-counts`. But
// after talking this through with the team, it was decided
// that adding a flag like this would create too much confusion.
// Instead, we've agreed to re-think our approach to data
// collection down the road where we might give users of
// of the tile the ability to specify exactly which APIs to
// collect from. That is, instead of the current 2 checkboxes:
// CEIP and Operational Data -- there would be 3: CEIP,
// Core Counts, and Usage Service
if anyUsageServiceConfigsProvided() || operationalDataOnly {
// collect data from api/v0/download_core_consumption
ccOmService := &coreconsumption.Service{
Requestor: apiService,
}
coreConsumptionCollector := coreconsumption.NewDataCollector(
logger,
ccOmService,
viper.GetString(OpsManagerURLFlag),
)
return coreConsumptionCollector, nil
}
return nil, nil
}
type credhubDataCollector interface {
Collect() (credhub.Data, error)
}
func makeCredhubCollector(omService *opsmanager.Service, credhubCollectionEnabled bool) (credhubDataCollector, error) {
if credhubCollectionEnabled {
chCreds, err := omService.BoshCredentials()
if err != nil {
return nil, err
}
credHubURL := "https://" + chCreds.Host + ":8844"
requestor, err := ogCredhub.New(
credHubURL,
ogCredhub.SkipTLSValidation(true),
ogCredhub.Auth(auth.UaaClientCredentials(chCreds.ClientID, chCreds.ClientSecret)),
)
if err != nil {
return nil, errors.Wrap(err, CredhubClientError)
}
credhubService := credhub.NewCredhubService(requestor)
return credhub.NewDataCollector(logger, credhubService, credHubURL), nil
} else {
return nil, nil
}
}
func makeCollector(tarWriter *tar.TarWriter, operationalDataOnly bool) (*operations.CollectExecutor, error) {
authedClient, _ := omNetwork.NewOAuthClient(
viper.GetString(OpsManagerURLFlag),
viper.GetString(OpsManagerUsernameFlag),
viper.GetString(OpsManagerPasswordFlag),
viper.GetString(OpsManagerClientIdFlag),
viper.GetString(OpsManagerClientSecretFlag),
viper.GetBool(SkipTlsVerifyFlag),
"",
time.Duration(viper.GetInt(OpsManagerTimeoutFlag))*time.Second,
time.Duration(viper.GetInt(OpsManagerRequestTimeoutFlag))*time.Second,
)
apiService := api.New(api.ApiInput{Client: authedClient})
omService := &opsmanager.Service{
Requestor: apiService,
}
omCollector := opsmanager.NewDataCollector(
logger,
omService,
viper.GetString(OpsManagerURLFlag),
apiService,
apiService,
operationalDataOnly,
)
consumptionCollector, err := makeConsumptionCollector()
if err != nil {
return nil, err
}
coreConsumptionCollector, err := makeCoreConsumptionCollector(operationalDataOnly, apiService)
if err != nil {
return nil, err
}
credhubCollector, err := makeCredhubCollector(omService, viper.GetBool(CollectFromCredhubFlag))
if err != nil {
return nil, err
}
return operations.NewCollector(omCollector, credhubCollector, consumptionCollector, coreConsumptionCollector, tarWriter, uuid.DefaultGenerator, operationalDataOnly), nil
}