Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add image/blob tagging functionality to ore #3915

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions mantle/cmd/ore/aliyun/tag-image.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
// Copyright 2017 CoreOS, Inc.
//
// 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 aliyun

import (
"fmt"
"os"
"strings"

"github.com/spf13/cobra"
)

var (
cmdTagImage = &cobra.Command{
Use: "tag-image --id <id> --tags foo=bar ...",
Short: "Tag an image",
Run: runTagImage,
}
id string
tags []string
region string
)

func init() {
// Initialize the command and its flags
Aliyun.AddCommand(cmdTagImage)
cmdTagImage.Flags().StringVar(&id, "id", "", "Aliyun Image ID")
cmdTagImage.Flags().StringVar(&region, "region", "", "Region")
cmdTagImage.Flags().StringSliceVar(&tags, "tags", []string{}, "list of key=value tags to attach to the Aliyun image")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be good to add --tags to ore aliyun create-image too for consistency.

Similarly for GCP and Azure.

For cost reporting purposes, I would expect us actually to want to set the tags on upload instead of as a postprocess step.

}

func runTagImage(cmd *cobra.Command, args []string) {
if id == "" {
fmt.Fprintf(os.Stderr, "Provide --id to tag\n")
os.Exit(1)
}

if region == "" {
fmt.Fprintf(os.Stderr, "Provide --region\n")
os.Exit(1)
}

tagMap := make(map[string]string)
for _, tag := range tags {
splitTag := strings.SplitN(tag, "=", 2)
if len(splitTag) != 2 {
fmt.Fprintf(os.Stderr, "invalid tag format; should be key=value, not %v\n", tag)
os.Exit(1)
}
key, value := splitTag[0], splitTag[1]
tagMap[key] = value
}

err := API.CreateTags(id, tagMap, region)
if err != nil {
fmt.Fprintf(os.Stderr, "couldn't create image tags: %v", err)
os.Exit(1)
}
}
69 changes: 69 additions & 0 deletions mantle/cmd/ore/aws/tag-image.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Copyright 2017 CoreOS, Inc.
//
// 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 aws

import (
"fmt"
"os"
"strings"

"github.com/spf13/cobra"
)

var (
cmdTagImage = &cobra.Command{
Use: "tag-image --ami <ami_id> --tags foo=bar ...",
Short: "Tag an AMI",
Run: runTagImage,
}
tags []string
)

func init() {
// Initialize the command and its flags
AWS.AddCommand(cmdTagImage)
cmdTagImage.Flags().StringVar(&amiID, "ami", "", "AWS AMI ID")
cmdTagImage.Flags().StringVar(&region, "region", "", "Region")
cmdTagImage.Flags().StringSliceVar(&tags, "tags", []string{}, "list of key=value tags to attach to the AMI")
}

func runTagImage(cmd *cobra.Command, args []string) {
if amiID == "" {
fmt.Fprintf(os.Stderr, "Provide --ami to tag\n")
os.Exit(1)
}

if region == "" {
fmt.Fprintf(os.Stderr, "Provide --region\n")
os.Exit(1)
}

tagMap := make(map[string]string)
for _, tag := range tags {
splitTag := strings.SplitN(tag, "=", 2)
if len(splitTag) != 2 {
fmt.Fprintf(os.Stderr, "invalid tag format; should be key=value, not %v\n", tag)
os.Exit(1)
}
key, value := splitTag[0], splitTag[1]
tagMap[key] = value
}
Comment on lines +53 to +62
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor: feels like we should just lower this into API.CreateTags() so that it's deduped with ore aws upload --tags.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Similarly for the others.


err := API.CreateTags([]string{amiID}, tagMap)
if err != nil {
fmt.Fprintf(os.Stderr, "couldn't create image tags: %v", err)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\n

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And similarly for the other files.

os.Exit(1)
}
}
98 changes: 98 additions & 0 deletions mantle/cmd/ore/azure/tag-blob.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
// Copyright 2022 Red Hat
//
// 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 azure

import (
"fmt"
"os"
"strings"

"github.com/spf13/cobra"
)

var (
cmdTagBlob = &cobra.Command{
Use: "tag-blob",
Short: "Tag a Azure storage blob",
Long: "tag a storage blob on Azure.",
Run: runSetMetadata,
}

bmo struct {
tags []string
storageacct string
container string
blob string
resourceGroup string
}
)

func init() {
sv := cmdTagBlob.Flags().StringVar
ssv := cmdTagBlob.Flags().StringSliceVar
sv(&bmo.storageacct, "storage-account", "kola", "storage account name")
sv(&bmo.container, "container", "vhds", "container name")
sv(&bmo.blob, "blob-name", "", "name of the blob")
sv(&bmo.resourceGroup, "resource-group", "kola", "resource group name")
ssv(&bmo.tags, "tags", []string{}, "list of key=value tags to attach to the Azure storage blob")
Azure.AddCommand(cmdTagBlob)
}

func runSetMetadata(cmd *cobra.Command, args []string) {
if bmo.blob == "" {
fmt.Fprintf(os.Stderr, "Provide --blob-name to tag\n")
os.Exit(1)
}

if len(bmo.tags) < 1 {
fmt.Fprintf(os.Stderr, "Provide --tag to tag\n")
os.Exit(1)
}

if err := api.SetupClients(); err != nil {
fmt.Fprintf(os.Stderr, "setting up clients: %v\n", err)
os.Exit(1)
}

kr, err := api.GetStorageServiceKeys(bmo.storageacct, bmo.resourceGroup)
if err != nil {
fmt.Fprintf(os.Stderr, "Fetching storage service keys failed: %v\n", err)
os.Exit(1)
}

if len(kr.Keys) == 0 {
fmt.Fprintf(os.Stderr, "No storage service keys found")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

\n

Doesn't need Fprintf.

os.Exit(1)
}
k := kr.Keys
key := k[0].Value

tagMap := make(map[string]*string)
for _, tag := range bmo.tags {
splitTag := strings.SplitN(tag, "=", 2)
if len(splitTag) != 2 {
fmt.Fprintf(os.Stderr, "invalid tag format; should be key=value, not %v\n", tag)
os.Exit(1)
}
key, value := splitTag[0], splitTag[1]
tagMap[key] = &value
}

err = api.SetBlobMetadata(bmo.storageacct, *key, bmo.container, bmo.blob, tagMap)
if err != nil {
fmt.Fprintf(os.Stderr, "couldn't create image tags: %v", err)
os.Exit(1)
}
}
69 changes: 69 additions & 0 deletions mantle/cmd/ore/gcloud/label-image.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
// Copyright 2017 CoreOS, Inc.
//
// 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 gcloud

import (
"fmt"
"os"
"strings"

"github.com/spf13/cobra"
)

var (
cmdLabelImage = &cobra.Command{
Use: "label-image --name <name> --labels foo=bar ...",
Short: "label an image",
Run: runLabelImage,
}
name string
labels []string
)

func init() {
// Initialize the command and its flags
GCloud.AddCommand(cmdLabelImage)
cmdLabelImage.Flags().StringVar(&name, "name", "", "GCloud Image Name")
cmdLabelImage.Flags().StringSliceVar(&labels, "labels", []string{}, "list of key=value labels to attach to the GCloud image")
}

func runLabelImage(cmd *cobra.Command, args []string) {
if name == "" {
fmt.Fprintf(os.Stderr, "Provide --name to label\n")
os.Exit(1)
}

if len(labels) < 1 {
fmt.Fprintf(os.Stderr, "Provide at least one --label to label\n")
os.Exit(1)
}

labelMap := make(map[string]string)
for _, label := range labels {
splitLabel := strings.SplitN(label, "=", 2)
if len(splitLabel) != 2 {
fmt.Fprintf(os.Stderr, "invalid label format; should be key=value, not %v\n", label)
os.Exit(1)
}
key, value := splitLabel[0], splitLabel[1]
labelMap[key] = value
}

err := api.SetImageLabels(name, labelMap)
if err != nil {
fmt.Fprintf(os.Stderr, "couldn't create image labels: %v", err)
os.Exit(1)
}
}
26 changes: 26 additions & 0 deletions mantle/platform/api/aliyun/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,32 @@ func (a *API) DeleteImage(id string, force bool) error {
return errs.AsError()
}

func (a *API) CreateTags(resource string, tags map[string]string, region string) error {
request := ecs.CreateAddTagsRequest()
request.SetConnectTimeout(defaultConnectTimeout)
request.SetReadTimeout(defaultReadTimeout)
request.ResourceId = resource
request.RegionId = region
request.ResourceType = "image"

tagObjs := make([]ecs.AddTagsTag, 0, len(tags))
for key, value := range tags {
tagObjs = append(tagObjs, ecs.AddTagsTag{
Key: key,
Value: value,
})
}

request.Tag = &tagObjs
response, err := a.ecs.AddTags(request)
plog.Infof("response %v", response)
if err != nil {
return fmt.Errorf("unable to add tags: %v", err)
}

return err
}

// DeleteSnapshot deletes a snapshot
func (a *API) DeleteSnapshot(id string, force bool) error {
request := ecs.CreateDeleteSnapshotRequest()
Expand Down
10 changes: 10 additions & 0 deletions mantle/platform/api/azure/storage.go
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,16 @@ func (a *API) DeleteBlockBlob(storageaccount, key, container, blob string) error
return err
}

func (a *API) SetBlobMetadata(storageaccount, key, container, blobname string, tags map[string]*string) error {
client, err := getPageBlobClient(storageaccount, key, container, blobname)
if err != nil {
return err
}

_, err = client.SetMetadata(context.Background(), tags, nil)
return err
}

func getBlockBlobClient(storageaccount, key string) (*azblob.Client, error) {
serviceURL := fmt.Sprintf("https://%s.blob.core.windows.net/", storageaccount)
cred, err := azblob.NewSharedKeyCredential(storageaccount, key)
Expand Down
21 changes: 21 additions & 0 deletions mantle/platform/api/gcloud/image.go
Original file line number Diff line number Diff line change
Expand Up @@ -283,3 +283,24 @@ func (a *API) SetImagePublic(name string) error {
}
return nil
}

// Add label(s) to an image
func (a *API) SetImageLabels(name string, labels map[string]string) error {
img, err := a.compute.Images.Get(a.options.Project, name).Do()
if err != nil {
return fmt.Errorf("Getting image %s failed: %v", name, err)
}

req := &compute.GlobalSetLabelsRequest{
LabelFingerprint: img.LabelFingerprint,
Labels: labels,
}

op, err := a.compute.Images.SetLabels(a.options.Project, name, req).Do()
if err != nil {
return fmt.Errorf("Adding labels to %s failed: %v", name, err)
}

plog.Infof("Updated labels on image %s: %v", name, op.Status)
return nil
}
Loading