Merge pull request #24 from jameszwang/update-readme

Support record ssh private key and update README.md
openshift-online · Nov 28, 2024 · 9eeae8d · 9eeae8d
2 parents 9f19993 + 9d3abd0
commit 9eeae8d
Show file tree

Hide file tree

Showing 13 changed files with 69 additions and 29 deletions.
diff --git a/.github/workflows/check-pull-request.yml b/.github/workflows/check-pull-request.yml
@@ -51,12 +51,12 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.21'
+          go-version: '1.23.2'
           cache: false
       - name: Ensure dependencies are downloaded
         run: go mod download
       - name: golangci-lint
         uses: golangci/golangci-lint-action@v4
         with:
-          version: v1.54
+          version: v1.62.0
           skip-cache: true
diff --git a/Makefile b/Makefile
@@ -33,4 +33,4 @@ fmt:
 
 .PHONY: lint
 lint:
-	golangci-lint run --timeout 5m0s
+	golangci-lint run --timeout 10m0s
diff --git a/README.md b/README.md
@@ -78,4 +78,18 @@ git push origin v0.0.1
 
 	`$ rosa-support delete vpc --vpc-id <vpc id> --region <region>`
 
+* Prepare bastion
+	* *--region* is required where created the vpc-id
+	* *--availability-zone* is required on which zone to launch the bastion instance
+	* *--vpc-id* is required which should be VPC id used to launch cluster
+	* *--keypair-name* is required to generate temporary used to launch the proxy instance
+	* *--private-key-path* is required to record the generated private ssh key
+	* *--cidr-block* is NOT required, only IP address within CIDR block can access other resources through bastion proxy(default is 0.0.0.0/0)
+
+  `$ rosa-support create bastion --region us-east-2 --availability-zone us-east-2a --vpc-id <vpc id> --keypair-name <name> --private-key-path <path>`
+
+* Destroy bastion,the bastion and related resources with VPC will be destroyed when clean VPC
+
+  `$ rosa-support delete vpc --vpc-id <vpc id> --region <region>`
+
 Note that a repository administrator may need to push the tag to the repository due to access restrictions.
diff --git a/cmd/rosa-support/create/bastion/cmd.go b/cmd/rosa-support/create/bastion/cmd.go
@@ -12,6 +12,8 @@ var args struct {
 	region           string
 	vpcID            string
 	availabilityZone string
+	privateKeyPath   string
+	keyPairName      string
 	cidr             string
 }
 
@@ -20,7 +22,7 @@ var Cmd = &cobra.Command{
 	Short: "Create bastion proxy",
 	Long:  "Create bastion proxy.",
 	Example: `  # Create a bastion proxy in region 'us-east-2'
-  rosa-support create bastion --region us-east-2 --availability-zone us-east-2a --vpc-id <vpc id>`,
+  rosa-support create bastion --region us-east-2 --availability-zone us-east-2a --vpc-id <vpc id> --keypair-name <name> --private-key-path <path>`,
 
 	Run: run,
 }
@@ -37,7 +39,7 @@ func init() {
 	)
 	err := Cmd.MarkFlagRequired("region")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	flags.StringVarP(
@@ -49,7 +51,7 @@ func init() {
 	)
 	err = Cmd.MarkFlagRequired("vpc-id")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	flags.StringVarP(
@@ -61,7 +63,31 @@ func init() {
 	)
 	err = Cmd.MarkFlagRequired("availability-zone")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
+		os.Exit(1)
+	}
+	flags.StringVarP(
+		&args.keyPairName,
+		"keypair-name",
+		"",
+		"",
+		"key pair will be created with the name (required)",
+	)
+	err = Cmd.MarkFlagRequired("keypair-name")
+	if err != nil {
+		logger.LogError("%s", err.Error())
+		os.Exit(1)
+	}
+	flags.StringVarP(
+		&args.privateKeyPath,
+		"private-key-path",
+		"",
+		"",
+		"record generated private ssh key in the given path (required)",
+	)
+	err = Cmd.MarkFlagRequired("private-key-path")
+	if err != nil {
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	flags.StringVarP(
@@ -79,7 +105,7 @@ func run(cmd *cobra.Command, _ []string) {
 	if err != nil {
 		panic(err)
 	}
-	instance, err := vpc.PrepareBastionProxy(args.availabilityZone, args.cidr)
+	instance, err := vpc.PrepareBastionProxy(args.availabilityZone, args.cidr, args.keyPairName, args.privateKeyPath)
 	if err != nil {
 		panic(err)
 	}

diff --git a/cmd/rosa-support/create/proxy/cmd.go b/cmd/rosa-support/create/proxy/cmd.go
@@ -78,33 +78,33 @@ func init() {
 
 	err := Cmd.MarkFlagRequired("vpc-id")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	err = Cmd.MarkFlagRequired("region")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	err = Cmd.MarkFlagRequired("availability-zone")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	err = Cmd.MarkFlagRequired("ca-file")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	err = Cmd.MarkFlagRequired("keypair-name")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 
 	err = Cmd.MarkFlagRequired("private-key-path")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 }

diff --git a/cmd/rosa-support/create/sg/cmd.go b/cmd/rosa-support/create/sg/cmd.go
@@ -63,12 +63,12 @@ func init() {
 	)
 	err := Cmd.MarkFlagRequired("vpc-id")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	err = Cmd.MarkFlagRequired("region")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 }

diff --git a/cmd/rosa-support/create/subnets/cmd.go b/cmd/rosa-support/create/subnets/cmd.go
@@ -39,7 +39,7 @@ func init() {
 	)
 	err := Cmd.MarkFlagRequired("region")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	flags.StringVarP(
@@ -51,7 +51,7 @@ func init() {
 	)
 	err = Cmd.MarkFlagRequired("availability-zones")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	flags.StringVarP(
@@ -63,7 +63,7 @@ func init() {
 	)
 	err = Cmd.MarkFlagRequired("vpc-id")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 }

diff --git a/cmd/rosa-support/create/vpc/cmd.go b/cmd/rosa-support/create/vpc/cmd.go
@@ -69,7 +69,7 @@ func init() {
 func run(cmd *cobra.Command, _ []string) {
 	vpc, err := vpcClient.PrepareVPC(args.name, args.region, args.cidr, args.findExisting, "")
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 
@@ -92,7 +92,7 @@ func run(cmd *cobra.Command, _ []string) {
 		}
 		_, err = vpc.AWSClient.TagResource(vpc.VpcID, tagMap)
 		if err != nil {
-			logger.LogError(err.Error())
+			logger.LogError("%s", err.Error())
 			os.Exit(1)
 		}
 	}

diff --git a/cmd/rosa-support/delete/tag/cmd.go b/cmd/rosa-support/delete/tag/cmd.go
@@ -80,12 +80,12 @@ func init() {
 func run(_ *cobra.Command, _ []string) {
 	client, err := awsClient.CreateAWSClient(args.profileName, args.region)
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	_, err = client.RemoveResourceTag(args.resourceID, args.tagKey, args.tagValue)
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 }
diff --git a/cmd/rosa-support/delete/vpc/cmd.go b/cmd/rosa-support/delete/vpc/cmd.go
@@ -60,12 +60,12 @@ func init() {
 func run(cmd *cobra.Command, _ []string) {
 	vpc, err := vpcClient.GenerateVPCByID(args.vpcID, args.region)
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 	err = vpc.DeleteVPCChain(args.totalClean)
 	if err != nil {
-		logger.LogError(err.Error())
+		logger.LogError("%s", err.Error())
 		os.Exit(1)
 	}
 }
diff --git a/cmd/rosa-support/tag/cmd.go b/cmd/rosa-support/tag/cmd.go
@@ -57,7 +57,7 @@ func init() {
 	for _, requiredFlag := range requiredFlags {
 		err := Cmd.MarkFlagRequired(requiredFlag)
 		if err != nil {
-			logger.LogError(err.Error())
+			logger.LogError("%s", err.Error())
 			os.Exit(1)
 		}
 	}

diff --git a/go.mod b/go.mod
@@ -3,7 +3,7 @@ module github.com/openshift-online/rosa-support
 go 1.21
 
 require (
-	github.com/openshift-online/ocm-common v0.0.13
+	github.com/openshift-online/ocm-common v0.0.14-0.20241121072829-c1150dfc4289
 	github.com/spf13/cobra v1.8.0
 )
 

diff --git a/go.sum b/go.sum
@@ -56,8 +56,8 @@ github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9Y
 github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1/go.mod h1:L3OGu8Wl2/fWfCI6z80xFu9LTZmf1ZRjMHUOPmWr69U=
-github.com/openshift-online/ocm-common v0.0.13 h1:FUn4PwuxOLsGbyJIC+izQQxYP3hA6dW5z/ep4HbTE4Q=
-github.com/openshift-online/ocm-common v0.0.13/go.mod h1:6MWje2NFNJ3IWpGs7BYj6DWagWXHyp8EnmYY7XFTtI4=
+github.com/openshift-online/ocm-common v0.0.14-0.20241121072829-c1150dfc4289 h1:CYX7p1cLo4+BwjHlJXHDP/zPiNit32b6YO6R0lGW+ZQ=
+github.com/openshift-online/ocm-common v0.0.14-0.20241121072829-c1150dfc4289/go.mod h1:6MWje2NFNJ3IWpGs7BYj6DWagWXHyp8EnmYY7XFTtI4=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=