Initial commit

Author: mkumatag

README.md

@@ -1,2 +1,5 @@
 # ibmcloud-nuke
 Delete the resource in the IBM Cloud account
+
+
+> Note: This is still in alpha phase and not ready for the production usage, not responsible for any data loss. 

cmd/root.go

@@ -0,0 +1,24 @@
+package cmd
+
+import (
+	"fmt"
+	"github.com/mkumatag/ibmcloud-nuke/internal/app"
+	"github.com/spf13/cobra"
+)
+
+func NewRootCommand() *cobra.Command {
+	command := &cobra.Command{
+		Use:          "ibmcloud-nuke",
+		Short:        "ibmcloud-nuke removes the mentioned resource from IBM Cloud",
+		Long:         `Tool which removes the specified resource from the IBM Cloud account based on the filters`,
+		SilenceUsage: true,
+	}
+
+	command.RunE = func(cmd *cobra.Command, args []string) error {
+		if len(args) != 1 {
+			return fmt.Errorf("only one argument is expected which is a config file name but provided: %s", args)
+		}
+		return app.Run(args[0])
+	}
+	return command
+}

go.mod

@@ -0,0 +1,32 @@
+module github.com/mkumatag/ibmcloud-nuke
+
+go 1.18
+
+require (
+	github.com/IBM/go-sdk-core/v5 v5.10.1
+	github.com/IBM/vpc-go-sdk v0.20.0
+	github.com/spf13/cobra v1.4.0
+	gopkg.in/yaml.v2 v2.4.0
+	k8s.io/apimachinery v0.24.1
+)
+
+require (
+	github.com/asaskevich/govalidator v0.0.0-20200907205600-7a23bdc65eef // indirect
+	github.com/go-logr/logr v1.2.0 // indirect
+	github.com/go-openapi/errors v0.19.8 // indirect
+	github.com/go-openapi/strfmt v0.21.2 // indirect
+	github.com/go-playground/locales v0.14.0 // indirect
+	github.com/go-playground/universal-translator v0.18.0 // indirect
+	github.com/go-stack/stack v1.8.0 // indirect
+	github.com/hashicorp/go-cleanhttp v0.5.2 // indirect
+	github.com/hashicorp/go-retryablehttp v0.7.1 // indirect
+	github.com/inconshreveable/mousetrap v1.0.0 // indirect
+	github.com/leodido/go-urn v1.2.1 // indirect
+	github.com/mitchellh/mapstructure v1.3.3 // indirect
+	github.com/oklog/ulid v1.3.1 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	go.mongodb.org/mongo-driver v1.7.5 // indirect
+	gopkg.in/go-playground/validator.v9 v9.31.0 // indirect
+	k8s.io/klog/v2 v2.60.1 // indirect
+	k8s.io/utils v0.0.0-20220210201930-3a6ce19ff2f9 // indirect
+)

go.sum

@@ -0,0 +1,33 @@
+package app
+
+import (
+	"github.com/mkumatag/ibmcloud-nuke/internal/pkg"
+	"github.com/mkumatag/ibmcloud-nuke/internal/resources"
+	"gopkg.in/yaml.v2"
+	"os"
+)
+
+func Run(config string) error {
+	content, err := os.ReadFile(config)
+	if err != nil {
+		return err
+	}
+	conf := &pkg.Config{}
+	if err := yaml.Unmarshal(content, conf); err != nil {
+		return err
+	}
+	//spew.Dump(conf)
+	for _, r := range conf.Resources {
+		for _, f := range resources.ResourceFuncs {
+			n, err := f(*conf, r)
+			if err != nil {
+				return err
+			}
+			if err := n.NukeIt(); err != nil {
+				return err
+			}
+		}
+
+	}
+	return nil
+}

internal/app/nuke.go

@@ -0,0 +1,5 @@
+package app
+
+import (
+	_ "github.com/mkumatag/ibmcloud-nuke/internal/resources/vpc"
+)

internal/app/resources.go

@@ -0,0 +1,26 @@
+package pkg
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/IBM/go-sdk-core/v5/core"
+)
+
+const (
+	// APIKeyEnv is environment which contains the IBMCloud API Key
+	APIKeyEnv = "IBMCLOUD_API_KEY"
+)
+
+// GetAuthenticator Returns an authenticator for IBM Cloud
+func GetAuthenticator() (core.Authenticator, error) {
+	apiKey := os.Getenv(APIKeyEnv)
+	if apiKey == "" {
+		return nil, fmt.Errorf("please set %s environment, it cannot be empty", APIKeyEnv)
+	}
+
+	auth := &core.IamAuthenticator{
+		ApiKey: apiKey,
+	}
+	return auth, nil
+}

internal/pkg/authenticator.go

@@ -0,0 +1,11 @@
+package pkg
+
+import "fmt"
+
+var (
+	ErrorResourceTypeMatch = fmt.Errorf("resource type doesn't match")
+
+	ErrorMissingRegion = fmt.Errorf("region is not specified in resouce or globally")
+
+	ErrorResourceNotFound = fmt.Errorf("resource not found")
+)

internal/pkg/errors.go

@@ -0,0 +1,42 @@
+package pkg
+
+type Nuke interface {
+	NukeIt() error
+	Validate() error
+}
+
+type Filter struct {
+	Name  string `yaml:"name"`
+	Regex string `yaml:"regex"`
+	ID    string `yaml:"ID"`
+}
+
+type Resource struct {
+	Nuke
+
+	Type       string `yaml:"type"`
+	Attributes `yaml:",inline"`
+}
+
+type Attributes struct {
+	Region string `yaml:"region"`
+	Zone   string `yaml:"zone"`
+	Filter Filter `yaml:"filter"`
+}
+
+type Config struct {
+	Global    Attributes `yaml:",inline"`
+	Resources []Resource `yaml:"resources"`
+}
+
+func (c *Config) GetGlobalRegion() string {
+	return c.Global.Region
+}
+
+func (c *Config) GetGlobalZone() string {
+	return c.Global.Zone
+}
+
+func (c *Config) GetGlobalFilter() Filter {
+	return c.Global.Filter
+}

internal/pkg/types.go

@@ -0,0 +1,52 @@
+package utils
+
+import (
+	"fmt"
+	"net/url"
+)
+
+// pagingHelper while listing resources, can use this to get the start token for getting the next set of resources for processing
+// start token will get fetched from nextUrl returned by f and passed to the func f.
+// f should take start as param and return three values isDone bool, nextUrl string, e error.
+// isDone  - represents no need to iterate for getting next set of resources.
+// nextUrl - if nextUrl is present, will try to get the start token and pass it to f for next set of resource processing.
+// e       - if e is not nil, will break and return the error.
+func PagingHelper(f func(string) (bool, string, error)) (err error) {
+	start := ""
+	for {
+		isDone, nextUrl, e := f(start)
+
+		if e != nil {
+			err = e
+			break
+		}
+
+		if isDone {
+			break
+		}
+
+		// for paging over next set of resources getting the start token
+		if nextUrl != "" {
+			start, err = getStartToken(nextUrl)
+			if err != nil {
+				break
+			}
+		} else {
+			break
+		}
+	}
+
+	return
+}
+
+// getStartToken parses the given url string and gets the 'start' query param
+func getStartToken(nextUrlS string) (start string, err error) {
+	nextUrl, err := url.Parse(nextUrlS)
+	if err != nil || nextUrl == nil {
+		err = fmt.Errorf("could not parse next url for getting next resources %w", err)
+		return
+	}
+
+	start = nextUrl.Query().Get("start")
+	return
+}