/
cosi_bucket_access.go
341 lines (297 loc) · 11.8 KB
/
cosi_bucket_access.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
package cosi
import (
"context"
"encoding/json"
"fmt"
"time"
corev1 "k8s.io/api/core/v1"
"github.com/noobaa/noobaa-operator/v5/pkg/bundle"
"github.com/noobaa/noobaa-operator/v5/pkg/nb"
"github.com/noobaa/noobaa-operator/v5/pkg/options"
"github.com/noobaa/noobaa-operator/v5/pkg/system"
"github.com/noobaa/noobaa-operator/v5/pkg/util"
"github.com/spf13/cobra"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
nbv1 "github.com/noobaa/noobaa-operator/v5/pkg/apis/noobaa/v1alpha1"
"k8s.io/apimachinery/pkg/util/wait"
)
var ctx = context.TODO()
// CmdCOSIBucketAccessClaim returns a CLI command
func CmdCOSIBucketAccessClaim() *cobra.Command {
cmd := &cobra.Command{
Use: "accessclaim",
Short: "Manage cosi access claims",
}
cmd.AddCommand(
CmdCreateBucketAccessClaim(),
CmdDeleteBucketAccessClaim(),
CmdStatusBucketAccessClaim(),
CmdListBucketAccessClaim(),
)
return cmd
}
// CmdCreateBucketAccessClaim returns a CLI command
func CmdCreateBucketAccessClaim() *cobra.Command {
cmd := &cobra.Command{
Use: "create <bucket-access-claim-name>",
Short: "Create a COSI bucket access claim",
Run: RunCreateBucketAccessClaim,
}
cmd.Flags().String("app-namespace", "",
"Set the namespace of the application where the COSI bucket access claim should be created")
cmd.Flags().String("bucket-claim", "",
"Set the bucket claim name to which the user require access credentials")
cmd.Flags().String("bucket-access-class", "",
"Set bucket access class name to specify the bucket access policy")
cmd.Flags().String("creds-secret-name", "",
"Set the secret name in which COSI will set the access credentials to the bucket")
return cmd
}
// CmdDeleteBucketAccessClaim returns a CLI command
func CmdDeleteBucketAccessClaim() *cobra.Command {
cmd := &cobra.Command{
Use: "delete <bucket-access-claim-name>",
Short: "Delete a COSI bucket access claim",
Run: RunDeleteBucketAccessClaim,
}
cmd.Flags().String("app-namespace", "",
"Set the namespace of the application where the COSI bucket access claim exists")
return cmd
}
// CmdStatusBucketAccessClaim returns a CLI command
func CmdStatusBucketAccessClaim() *cobra.Command {
cmd := &cobra.Command{
Use: "status <bucket-access-claim-name>",
Short: "Status of a COSI bucket access claim",
Run: RunStatusBucketAccessClaim,
}
cmd.Flags().String("app-namespace", "",
"Set the namespace of the application where the COSI bucket access claim exists")
return cmd
}
// CmdListBucketAccessClaim returns a CLI command
func CmdListBucketAccessClaim() *cobra.Command {
cmd := &cobra.Command{
Use: "list",
Short: "List COSI bucket access claims",
Run: RunListBucketAccessClaim,
Args: cobra.NoArgs,
}
return cmd
}
// RunCreateBucketAccessClaim runs a CLI command
func RunCreateBucketAccessClaim(cmd *cobra.Command, args []string) {
log := util.Logger()
if len(args) != 1 || args[0] == "" {
log.Fatalf(`Missing expected arguments: <bucket-claim-name> %s`, cmd.UsageString())
}
name := args[0]
appNamespace, _ := cmd.Flags().GetString("app-namespace")
bucketClaimName := util.GetFlagStringOrPrompt(cmd, "bucket-claim")
bucketAccessClassName := util.GetFlagStringOrPrompt(cmd, "bucket-access-class")
credsSecretName := util.GetFlagStringOrPrompt(cmd, "creds-secret-name")
cosiBucketAccessClaim := util.KubeObject(bundle.File_deploy_cosi_bucket_access_claim_yaml).(*nbv1.COSIBucketAccessClaim)
cosiBucketAccessClaim.Name = name
cosiBucketAccessClaim.Namespace = options.Namespace
if appNamespace != "" {
cosiBucketAccessClaim.Namespace = appNamespace
}
cosiBucketAccessClaim.Spec.BucketClaimName = bucketClaimName
cosiBucketAccessClaim.Spec.CredentialsSecretName = credsSecretName
cosiBucketAccessClaim.Spec.BucketAccessClassName = bucketAccessClassName
bucketAccessClass := util.KubeObject(bundle.File_deploy_cosi_bucket_access_class_yaml).(*nbv1.COSIBucketAccessClass)
bucketAccessClass.Name = bucketAccessClassName
if !util.KubeCheck(bucketAccessClass) {
log.Fatalf(`❌ Could not get bucketAccessClass %q`, bucketAccessClass.Name)
}
bucketClaim := util.KubeObject(bundle.File_deploy_cosi_bucket_claim_yaml).(*nbv1.COSIBucketClaim)
bucketClaim.Name = bucketClaimName
bucketClaim.Namespace = cosiBucketAccessClaim.Namespace
if !util.KubeCheck(bucketClaim) {
log.Fatalf(`❌ Could not get BucketClaim %q`, bucketClaim.Name)
}
// NOTE - when/if extra parameters are supported in bucketAccessClass we will need to validate them here
if !util.KubeCreateFailExisting(cosiBucketAccessClaim) {
log.Fatalf(`❌ Could not create COSI bucket access claim %q in namespace %q (conflict)`, cosiBucketAccessClaim.Name, cosiBucketAccessClaim.Namespace)
}
log.Printf("")
util.PrintThisNoteWhenFinishedApplyingAndStartWaitLoop()
log.Printf("")
log.Printf("COSI bucket access claim Wait Ready:")
if WaitBucketAccessClaimReady(cosiBucketAccessClaim) {
log.Printf("")
log.Printf("")
RunStatusBucketAccessClaim(cmd, args)
}
}
// RunDeleteBucketAccessClaim runs a CLI command
func RunDeleteBucketAccessClaim(cmd *cobra.Command, args []string) {
log := util.Logger()
if len(args) != 1 || args[0] == "" {
log.Fatalf(`Missing expected arguments: <bucket-access-claim-name> %s`, cmd.UsageString())
}
appNamespace, _ := cmd.Flags().GetString("app-namespace")
cosiBucketAccessClaim := util.KubeObject(bundle.File_deploy_cosi_bucket_access_claim_yaml).(*nbv1.COSIBucketAccessClaim)
cosiBucketAccessClaim.Name = args[0]
cosiBucketAccessClaim.Namespace = options.Namespace
if appNamespace != "" {
cosiBucketAccessClaim.Namespace = appNamespace
}
if !util.KubeDelete(cosiBucketAccessClaim) {
log.Fatalf(`❌ Could not delete COSI bucket access claim %q in namespace %q`,
cosiBucketAccessClaim.Name, cosiBucketAccessClaim.Namespace)
}
}
// RunStatusBucketAccessClaim runs a CLI command
func RunStatusBucketAccessClaim(cmd *cobra.Command, args []string) {
log := util.Logger()
if len(args) != 1 || args[0] == "" {
log.Fatalf(`Missing expected arguments: <bucket-access-claim-name> %s`, cmd.UsageString())
}
appNamespace, _ := cmd.Flags().GetString("app-namespace")
cosiBucketAccessClaim := util.KubeObject(bundle.File_deploy_cosi_bucket_access_claim_yaml).(*nbv1.COSIBucketAccessClaim)
secret := util.KubeObject(bundle.File_deploy_internal_secret_empty_yaml).(*corev1.Secret)
cosiBucketAccessClaim.Name = args[0]
cosiBucketAccessClaim.Namespace = options.Namespace
secret.Namespace = options.Namespace
if appNamespace != "" {
cosiBucketAccessClaim.Namespace = appNamespace
secret.Namespace = appNamespace
}
if !util.KubeCheck(cosiBucketAccessClaim) {
log.Fatalf(`❌ Could not find COSI bucket access claim %q in namespace %q`, cosiBucketAccessClaim.Name, cosiBucketAccessClaim.Namespace)
}
bucketAccessClass := &nbv1.COSIBucketAccessClass{
TypeMeta: metav1.TypeMeta{Kind: "BucketAccessClass"},
ObjectMeta: metav1.ObjectMeta{
Name: cosiBucketAccessClaim.Spec.BucketAccessClassName,
},
}
if !util.KubeCheck(bucketAccessClass) {
log.Errorf(`❌ Could not get BucketAccessClass %s`, bucketAccessClass.Name)
}
secret.Name = cosiBucketAccessClaim.Spec.CredentialsSecretName
if !util.KubeCheck(secret) {
log.Fatalf(`❌ Could not find COSI bucket access claim secret %q in namespace %q`, secret.Name, cosiBucketAccessClaim.Namespace)
}
sysClient, err := system.Connect(true)
if err != nil {
util.Logger().Fatalf("❌ %s", err)
}
var a *nb.AccountInfo
if cosiBucketAccessClaim.Status.AccountID != "" {
nbClient := sysClient.NBClient
account, err := nbClient.ReadAccountAPI(nb.ReadAccountParams{Email: cosiBucketAccessClaim.Status.AccountID})
if err == nil {
a = &account
}
}
fmt.Printf("\n")
fmt.Printf("COSI BucketAccessClaim info:\n")
fmt.Printf(" %-22s : %t\n", "Bucket Access Granted", cosiBucketAccessClaim.Status.AccessGranted)
fmt.Printf(" %-22s : kubectl get -n %s bucketaccessclaim %s\n", "COSIBucketAccessClaim", cosiBucketAccessClaim.Namespace, cosiBucketAccessClaim.Name)
fmt.Printf(" %-22s : kubectl get bucketaccessclasses.objectstorage.k8s.io %s\n", "BucketAccessClass", bucketAccessClass.Name)
fmt.Printf("\n")
credsEnv := ""
bucketInfo := secret.StringData["BucketInfo"]
if bucketInfo != "" {
var bucketInfoObj nbv1.COSIBucketInfo
if err := json.Unmarshal([]byte(bucketInfo), &bucketInfoObj); err != nil {
log.Fatal("error deserializing secret BucketInfo")
}
accessKey := bucketInfoObj.Spec.S3.AccessKeyID
secretKey := bucketInfoObj.Spec.S3.AccessSecretKey
accessKeyProperty := "AWS_ACCESS_KEY_ID"
secretKeyProperty := "AWS_SECRET_ACCESS_KEY"
if options.ShowSecrets {
fmt.Printf(" %-22s : %s\n", accessKeyProperty, accessKey)
fmt.Printf(" %-22s : %s\n", accessKeyProperty, secretKey)
credsEnv += accessKeyProperty + "=" + accessKey + " "
credsEnv += secretKeyProperty + "=" + secretKey + " "
} else {
fmt.Printf(" %-22s : %s\n", accessKeyProperty, nb.MaskedString(accessKey))
fmt.Printf(" %-22s : %s\n", accessKeyProperty, nb.MaskedString(secretKey))
credsEnv += accessKeyProperty + "=" + string(nb.MaskedString(accessKey)) + " "
credsEnv += secretKeyProperty + "=" + string(nb.MaskedString(secretKey)) + " "
}
}
fmt.Printf("Shell commands:\n")
fmt.Printf(" %-22s : alias s3='%saws s3 --no-verify-ssl --endpoint-url %s'\n", "AWS S3 Alias", credsEnv, sysClient.S3URL.String())
fmt.Printf("\n")
if a != nil {
fmt.Printf("Account status:\n")
fmt.Printf(" %-22s : %s\n", "Name", a.Name)
fmt.Printf(" %-22s : %s\n", "Email", a.Email)
fmt.Printf(" %-22s : %s\n", "DefaultResource", a.DefaultResource)
fmt.Printf(" %-22s : %t\n", "S3Access", a.HasS3Access)
fmt.Printf(" %-22s : %t\n", "AllowBucketCreate", a.CanCreateBuckets)
fmt.Printf("\n")
}
}
// RunListBucketAccessClaim runs a CLI command
func RunListBucketAccessClaim(cmd *cobra.Command, args []string) {
list := &nbv1.COSIBucketAccessClaimList{
TypeMeta: metav1.TypeMeta{Kind: "BucketAccessClaim"},
}
if !util.KubeList(list) {
return
}
if len(list.Items) == 0 {
fmt.Printf("No COSI bucket access claims found.\n")
return
}
table := (&util.PrintTable{}).AddRow(
"NAMESPACE",
"NAME",
"ACCOUNT-NAME",
"BUCKET-CLAIM",
"BUCKET-ACCESS-CLASS",
"ACCESS-GRANTED",
)
for i := range list.Items {
cosiBucketAccessClaim := &list.Items[i]
table.AddRow(
cosiBucketAccessClaim.Namespace,
cosiBucketAccessClaim.Name,
cosiBucketAccessClaim.Status.AccountID,
cosiBucketAccessClaim.Spec.BucketClaimName,
cosiBucketAccessClaim.Spec.BucketAccessClassName,
fmt.Sprintf("%t", bool(cosiBucketAccessClaim.Status.AccessGranted)),
)
}
fmt.Print(table.String())
}
// WaitBucketAccessClaimReady waits until the cosi bucket claim status bucket ready changes to true
func WaitBucketAccessClaimReady(cosiBucketAccessClaim *nbv1.COSIBucketAccessClaim) bool {
log := util.Logger()
klient := util.KubeClient()
interval := time.Duration(3)
maxRetries := 60
retries := 0
err := wait.PollUntilContextCancel(ctx, interval*time.Second, true, func(ctx context.Context) (bool, error) {
if retries == maxRetries {
return false, fmt.Errorf("COSI bucket claim is not ready after max retries - %q", maxRetries)
}
retries++
err := klient.Get(util.Context(), util.ObjectKey(cosiBucketAccessClaim), cosiBucketAccessClaim)
if err != nil {
log.Printf("⏳ Failed to get COSI bucket access claim: %s", err)
return false, nil
}
CheckBucketAccessClaimPhase(cosiBucketAccessClaim)
if cosiBucketAccessClaim.Status.AccessGranted {
return true, nil
}
return false, nil
})
return (err == nil)
}
// CheckBucketAccessClaimPhase prints the phase and reason for it
func CheckBucketAccessClaimPhase(cosiBucketAccessClaim *nbv1.COSIBucketAccessClaim) {
log := util.Logger()
if cosiBucketAccessClaim.Status.AccessGranted {
log.Printf("✅ COSI bucket access claim %q granted", cosiBucketAccessClaim.Name)
} else {
log.Printf("⏳ COSI bucket access claim %q is not yet granted", cosiBucketAccessClaim.Name)
}
}