-
Notifications
You must be signed in to change notification settings - Fork 26
/
cli.go
322 lines (306 loc) · 8.7 KB
/
cli.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
// Copyright 2022 Google LLC
//
// 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
//
// https://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 app
import (
cfg "github.com/google/gke-policy-automation/internal/config"
cli "github.com/urfave/cli/v2"
)
type CliConfig struct {
ConfigFile string
SilentMode bool
JSONOutput bool
CredentialsFile string
DumpFile string
ClusterName string
ClusterLocation string
ProjectName string
GitRepository string
GitBranch string
GitDirectory string
LocalDirectory string
OutputFile string
DocumentationOutput string
DiscoveryEnabled bool
SccOrgNumber string
}
func NewPolicyAutomationCli(p PolicyAutomation) *cli.App {
app := &cli.App{
Name: "gke-policy",
Usage: "Manage GKE policies",
Commands: []*cli.Command{
createCheckCommand(p),
createDumpCommand(p),
createConfigureCommand(p),
createVersionCommand(p),
createGenerateCommand(p),
},
}
return app
}
func createCheckCommand(p PolicyAutomation) *cli.Command {
config := &CliConfig{}
return &cli.Command{
Name: "check",
Usage: "Check GKE clusters against best practices",
Flags: getCheckFlags(config),
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, cfg.SetCheckConfigDefaults, cfg.ValidateClusterCheckConfig); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.Check()
},
Subcommands: []*cli.Command{
{
Name: "best-practices",
Usage: "Check GKE clusters against best practices",
Flags: getCheckFlags(config),
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, cfg.SetCheckConfigDefaults, cfg.ValidateClusterCheckConfig); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.CheckBestPractices()
},
},
{
Name: "scalability",
Usage: "Check GKE clusters against scalability limits",
Flags: getCheckFlags(config),
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, cfg.SetScalabilityConfigDefaults, cfg.ValidateScalabilityCheckConfig); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.CheckScalability()
},
},
{
Name: "policies",
Usage: "Validates policy files from the defined source",
Flags: getCheckFlags(config),
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, cfg.SetPolicyConfigDefaults, cfg.ValidatePolicyCheckConfig); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.PolicyCheck()
},
},
},
}
}
func createDumpCommand(p PolicyAutomation) *cli.Command {
config := &CliConfig{}
return &cli.Command{
Name: "dump",
Usage: "Download and dump data",
Subcommands: []*cli.Command{
{
Name: "cluster",
Usage: "Download and dump GKE cluster configuration",
Flags: getDumpFlags(config),
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, cfg.SetCheckConfigDefaults, cfg.ValidateClusterDumpConfig); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.ClusterJSONData()
},
},
},
}
}
func createConfigureCommand(p PolicyAutomation) *cli.Command {
config := &CliConfig{}
return &cli.Command{
Name: "configure",
Usage: "Configure GKE Policy Automation environment",
Subcommands: []*cli.Command{
{
Name: "scc",
Usage: "Configure GKE Policy Automation in Security Command Center",
Flags: []cli.Flag{
&cli.StringFlag{
Name: "organization",
Aliases: []string{"o"},
Usage: "Organization number",
Destination: &config.SccOrgNumber,
},
},
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, nil, nil); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.ConfigureSCC(config.SccOrgNumber)
},
},
},
}
}
func createGenerateCommand(p PolicyAutomation) *cli.Command {
config := &CliConfig{}
return &cli.Command{
Name: "generate",
Usage: "Generate GKE Policy outputs.",
Subcommands: []*cli.Command{
{
Name: "policy-docs",
Usage: "Generate documentation for policy files",
Flags: (getPolicyDocumentationFlags(config)),
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(config, cfg.SetPolicyConfigDefaults, cfg.ValidateGeneratePolicyDocsConfig); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.PolicyGenerateDocumentation()
},
},
},
}
}
func createVersionCommand(p PolicyAutomation) *cli.Command {
return &cli.Command{
Name: "version",
Usage: "Shows application version",
Action: func(c *cli.Context) error {
defer p.Close()
if err := p.LoadCliConfig(&CliConfig{}, nil, nil); err != nil {
cli.ShowSubcommandHelp(c)
return err
}
return p.Version()
},
}
}
func getCommonFlags(config *CliConfig) []cli.Flag {
return []cli.Flag{
&cli.StringFlag{
Name: "config",
Aliases: []string{"c"},
Usage: "Path to the configuration file",
Destination: &config.ConfigFile,
},
&cli.BoolFlag{
Name: "silent",
Aliases: []string{"s"},
Usage: "Disables standard console output",
Destination: &config.SilentMode,
},
&cli.StringFlag{
Name: "creds",
Usage: "Path to GCP JSON credentials file",
Destination: &config.CredentialsFile,
},
}
}
func getClusterSourceFlags(config *CliConfig) []cli.Flag {
return []cli.Flag{
&cli.BoolFlag{
Name: "discovery",
Usage: "Enables cluster discovery on a given project",
Destination: &config.DiscoveryEnabled,
},
&cli.StringFlag{
Name: "dump",
Aliases: []string{"d"},
Usage: "Path to the JSON file with cluster data dump for local checks",
Destination: &config.DumpFile,
},
&cli.StringFlag{
Name: "project",
Aliases: []string{"p"},
Usage: "Name of a GCP project with a GKE cluster to check",
Destination: &config.ProjectName,
},
&cli.StringFlag{
Name: "name",
Aliases: []string{"n"},
Usage: "Name of a GKE cluster to check",
Destination: &config.ClusterName,
},
&cli.StringFlag{
Name: "location",
Aliases: []string{"l"},
Usage: "Location (region or zone) of a GKE cluster to check",
Destination: &config.ClusterLocation,
},
}
}
func getOutputFlags(config *CliConfig) []cli.Flag {
return []cli.Flag{
&cli.StringFlag{
Name: "out-file",
Aliases: []string{"f"},
Usage: "Path to the file for storing results",
Destination: &config.OutputFile,
},
&cli.BoolFlag{
Name: "json",
Usage: "Outputs results to standard console in JSON format",
Destination: &config.JSONOutput,
},
}
}
func getPolicySourceFlags(config *CliConfig) []cli.Flag {
return []cli.Flag{
&cli.StringFlag{
Name: "local-policy-dir",
Usage: "Local directory with GKE policies",
Destination: &config.LocalDirectory,
},
&cli.StringFlag{
Name: "git-policy-repo",
Usage: "GIT repository with GKE policies",
Destination: &config.GitRepository,
},
&cli.StringFlag{
Name: "git-policy-branch",
Usage: "Branch name for policies GIT repository",
Destination: &config.GitBranch,
},
&cli.StringFlag{
Name: "git-policy-dir",
Usage: "Directory name for policies from GIT repository",
Destination: &config.GitDirectory,
},
}
}
func getPolicyDocumentationFlags(config *CliConfig) []cli.Flag {
flags := getCommonFlags(config)
flags = append(flags, getPolicySourceFlags(config)...)
flags = append(flags, getOutputFlags(config)...)
return flags
}
func getCheckFlags(config *CliConfig) []cli.Flag {
flags := getCommonFlags(config)
flags = append(flags, getClusterSourceFlags(config)...)
flags = append(flags, getPolicySourceFlags(config)...)
flags = append(flags, getOutputFlags(config)...)
return flags
}
func getDumpFlags(config *CliConfig) []cli.Flag {
flags := getCommonFlags(config)
flags = append(flags, getClusterSourceFlags(config)...)
flags = append(flags, getOutputFlags(config)...)
return flags
}