-
Notifications
You must be signed in to change notification settings - Fork 98
/
get.go
261 lines (217 loc) · 7.29 KB
/
get.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
// Copyright 2024 The Carvel Authors.
// SPDX-License-Identifier: Apache-2.0
package installed
import (
"bufio"
"context"
"fmt"
"os"
"strings"
"github.com/cppforlife/color"
"github.com/cppforlife/go-cli-ui/ui"
uitable "github.com/cppforlife/go-cli-ui/ui/table"
"github.com/spf13/cobra"
cmdcore "github.com/vmware-tanzu/carvel-kapp-controller/cli/pkg/kctrl/cmd/core"
"github.com/vmware-tanzu/carvel-kapp-controller/cli/pkg/kctrl/logger"
kcv1alpha1 "github.com/vmware-tanzu/carvel-kapp-controller/pkg/apis/kappctrl/v1alpha1"
kcpkgv1alpha1 "github.com/vmware-tanzu/carvel-kapp-controller/pkg/apis/packaging/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
type GetOptions struct {
ui ui.UI
depsFactory cmdcore.DepsFactory
logger logger.Logger
NamespaceFlags cmdcore.NamespaceFlags
Name string
valuesFileOutput string
values bool
pkgCmdTreeOpts cmdcore.PackageCommandTreeOpts
columns *[]string
}
func NewGetOptions(ui ui.UI, depsFactory cmdcore.DepsFactory, logger logger.Logger, pkgCmdTreeOpts cmdcore.PackageCommandTreeOpts, columns *[]string) *GetOptions {
return &GetOptions{ui: ui, depsFactory: depsFactory, logger: logger, pkgCmdTreeOpts: pkgCmdTreeOpts, columns: columns}
}
func NewGetCmd(o *GetOptions, flagsFactory cmdcore.FlagsFactory) *cobra.Command {
cmd := &cobra.Command{
Use: "get",
Aliases: []string{"g"},
Short: "Get details for installed package",
Args: cobra.ExactArgs(1),
RunE: func(_ *cobra.Command, args []string) error { return o.Run(args) },
Example: cmdcore.Examples{
cmdcore.Example{"Get details for a package install",
[]string{"package", "installed", "get", "-i", "sample-pkg-install"},
},
cmdcore.Example{"View values being used by package install",
[]string{"package", "installed", "get", "-i", "sample-pkg-install", "--values"},
},
cmdcore.Example{"Download values being used by package install",
[]string{"package", "installed", "get", "-i", "sample-pkg-install", "--values-file-output", "values.yml"}},
}.Description("-i", o.pkgCmdTreeOpts),
SilenceUsage: true,
Annotations: map[string]string{"table": "",
cmdcore.PackageManagementCommandsHelpGroup.Key: cmdcore.PackageManagementCommandsHelpGroup.Value},
}
o.NamespaceFlags.SetWithPackageCommandTreeOpts(cmd, flagsFactory, o.pkgCmdTreeOpts)
if !o.pkgCmdTreeOpts.PositionalArgs {
cmd.Flags().StringVarP(&o.Name, "package-install", "i", "", "Set installed package name (required)")
} else {
cmd.Use = "get INSTALLED_PACKAGE_NAME"
cmd.Args = cobra.ExactArgs(1)
}
cmd.Flags().StringVar(&o.valuesFileOutput, "values-file-output", "", "File path for exporting configuration values file")
cmd.Flags().BoolVar(&o.values, "values", false, "Get values data for package install")
return cmd
}
func (o *GetOptions) Run(args []string) error {
if o.pkgCmdTreeOpts.PositionalArgs {
if len(args) > 0 {
o.Name = args[0]
}
}
if len(o.Name) == 0 {
return fmt.Errorf("Expected package install name to be non empty")
}
client, err := o.depsFactory.KappCtrlClient()
if err != nil {
return err
}
pkgi, err := client.PackagingV1alpha1().PackageInstalls(
o.NamespaceFlags.Name).Get(context.Background(), o.Name, metav1.GetOptions{})
if err != nil {
return err
}
if o.valuesFileOutput != "" {
err := o.downloadValuesData(pkgi)
if err != nil {
return err
}
return nil
}
if o.values {
err := o.showValuesData(pkgi)
if err != nil {
return err
}
return nil
}
status, isFailing := packageInstallStatus(pkgi)
errorMessageHeader := uitable.NewHeader("Useful Error Message")
errorMessageHeader.Hidden = len(pkgi.Status.UsefulErrorMessage) == 0
yttMessageHeader := uitable.NewHeader("Overlay secrets")
yttMessageHeader.Hidden = !hasYttOverlays(pkgi)
table := uitable.Table{
Transpose: true,
Header: []uitable.Header{
uitable.NewHeader("Namespace"),
uitable.NewHeader("Name"),
uitable.NewHeader("Package name"),
uitable.NewHeader("Package version"),
uitable.NewHeader("Status"),
yttMessageHeader,
uitable.NewHeader("Conditions"),
errorMessageHeader,
},
Rows: [][]uitable.Value{{
uitable.NewValueString(pkgi.Namespace),
uitable.NewValueString(pkgi.Name),
uitable.NewValueString(pkgi.Spec.PackageRef.RefName),
uitable.NewValueString(pkgi.Status.Version),
uitable.ValueFmt{V: uitable.NewValueString(status), Error: isFailing},
uitable.NewValueInterface(o.overlayList(*pkgi)),
uitable.NewValueInterface(pkgi.Status.Conditions),
uitable.NewValueString(color.RedString(pkgi.Status.UsefulErrorMessage)),
}},
}
return cmdcore.PrintTable(o.ui, table, o.columns)
}
func (o *GetOptions) getSecretData(pkgi *kcpkgv1alpha1.PackageInstall) ([]byte, error) {
if len(pkgi.Spec.Values) == 0 {
return nil, fmt.Errorf("No values have been supplied to package installation '%s' in namespace '%s'", o.Name, o.NamespaceFlags.Name)
}
if len(pkgi.Spec.Values) != 1 {
return nil, fmt.Errorf("Expected 1 values reference, found %d", len(pkgi.Spec.Values))
}
if pkgi.Spec.Values[0].SecretRef == nil {
return nil, fmt.Errorf("Values do not reference a Secret")
}
coreClient, err := o.depsFactory.CoreClient()
if err != nil {
return nil, err
}
secretName := pkgi.Spec.Values[0].SecretRef.Name
valuesSecret, err := coreClient.CoreV1().Secrets(o.NamespaceFlags.Name).Get(context.Background(), secretName, metav1.GetOptions{})
if err != nil {
return nil, err
}
if len(valuesSecret.Data) > 1 {
return nil, fmt.Errorf("Manually created values Secret has multiple keys")
}
// To get values data from any single key that is present
var dataKey string
for key := range valuesSecret.Data {
dataKey = key
}
data, ok := valuesSecret.Data[dataKey]
if !ok {
return nil, fmt.Errorf("Could not find key with values data in referenced secret")
}
return data, nil
}
func (o *GetOptions) downloadValuesData(pkgi *kcpkgv1alpha1.PackageInstall) error {
data, err := o.getSecretData(pkgi)
if err != nil {
return err
}
f, err := os.Create(o.valuesFileOutput)
if err != nil {
return err
}
defer f.Close()
w := bufio.NewWriter(f)
w.Write(data)
w.Flush()
return nil
}
func (o *GetOptions) showValuesData(pkgi *kcpkgv1alpha1.PackageInstall) error {
data, err := o.getSecretData(pkgi)
if err != nil {
return err
}
o.ui.PrintBlock(data)
return nil
}
func (o *GetOptions) overlayList(pkgi kcpkgv1alpha1.PackageInstall) []string {
secretList := []string{}
for annotation := range pkgi.Annotations {
if strings.HasPrefix(annotation, yttOverlayPrefix) {
secretList = append(secretList, pkgi.Annotations[annotation])
}
}
return secretList
}
// Returns pkgi status string and a bool indicating if it is a failure
// TODO: Add Paused/Canceled statuses at a warn level
func packageInstallStatus(pkgi *kcpkgv1alpha1.PackageInstall) (string, bool) {
if pkgi.Spec.Canceled {
return "Canceled", true
}
if pkgi.Spec.Paused {
return "Paused", true
}
for _, condition := range pkgi.Status.Conditions {
switch condition.Type {
case kcv1alpha1.ReconcileFailed:
return "Reconcile failed", true
case kcv1alpha1.ReconcileSucceeded:
return "Reconcile succeeded", false
case kcv1alpha1.DeleteFailed:
return "Deletion failed", true
case kcv1alpha1.Reconciling:
return "Reconciling", false
case kcv1alpha1.Deleting:
return "Deleting", false
}
}
return pkgi.Status.FriendlyDescription, false
}