Skip to content

Commit

Permalink
Added Port Delete command to capibmadm
Browse files Browse the repository at this point in the history
  • Loading branch information
Rajalakshmi-Girish committed Feb 8, 2023
1 parent 7399387 commit 8b0e8a5
Show file tree
Hide file tree
Showing 7 changed files with 160 additions and 0 deletions.
81 changes: 81 additions & 0 deletions cmd/capibmadm/cmd/powervs/port/delete.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
/*
Copyright 2023 The Kubernetes Authors.
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 port

import (
"context"

"github.com/spf13/cobra"

v "github.com/IBM-Cloud/power-go-client/clients/instance"

logf "sigs.k8s.io/cluster-api/cmd/clusterctl/log"

"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/iam"
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/clients/powervs"
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/utils"
)

type portDeleteOptions struct {
network string
portID string
}

// DeleteCommand function to delete network's port.
func DeleteCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "delete",
Short: "Delete PowerVS network port",
Example: `
# Delete PowerVS network port with ID <port-id> in network "capi-network"
export IBMCLOUD_API_KEY=<api-key>
capibmadm powervs port delete capi-network --port-id <port-id> --service-instance-id <service-instance-id>`,
}

var portDeleteOption portDeleteOptions
cmd.Flags().StringVar(&portDeleteOption.portID, "port-id", "", "Port ID to be deleted")
cmd.Flags().StringVar(&portDeleteOption.network, "network", "", "Network ID or Name(preference will be given to the ID over Name")
_ = cmd.MarkFlagRequired("port-id")
_ = cmd.MarkFlagRequired("network")

cmd.RunE = func(cmd *cobra.Command, args []string) error {
if err := deletePort(cmd.Context(), portDeleteOption); err != nil {
return err
}
return nil
}
return cmd
}

func deletePort(ctx context.Context, portDeleteOption portDeleteOptions) error {
log := logf.Log
log.Info("Deleting Power VS network port", "of network", portDeleteOption.network, "service-instance-id", options.GlobalOptions.ServiceInstanceID, "port-id", portDeleteOption.portID)
auth := iam.GetIAMAuth()
accountID, _ := utils.GetAccountID(ctx, auth)
sess, err := powervs.NewPISession(accountID, options.GlobalOptions.PowerVSZone, options.GlobalOptions.Debug)
if err != nil {
return err
}
c := v.NewIBMPINetworkClient(ctx, sess, options.GlobalOptions.ServiceInstanceID)
errDel := c.DeletePort(portDeleteOption.network, portDeleteOption.portID)
if errDel != nil {
return errDel
}
log.Info("Successfully deleted a port", "of port ID", portDeleteOption.portID)
return nil
}
18 changes: 18 additions & 0 deletions cmd/capibmadm/cmd/powervs/port/doc.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
/*
Copyright 2023 The Kubernetes Authors.
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 port contains the commands to operate on Power VS Port resources.
package port
32 changes: 32 additions & 0 deletions cmd/capibmadm/cmd/powervs/port/port.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
/*
Copyright 2023 The Kubernetes Authors.
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 port

import (
"github.com/spf13/cobra"
)

// Commands function to add PowerVS port commands.
func Commands() *cobra.Command {
cmd := &cobra.Command{
Use: "port",
Short: "Perform PowerVS port operations",
}

cmd.AddCommand(DeleteCommand())
return cmd
}
2 changes: 2 additions & 0 deletions cmd/capibmadm/cmd/powervs/powervs.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"github.com/spf13/cobra"

"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/powervs/network"
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/cmd/powervs/port"
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/options"
)

Expand All @@ -38,6 +39,7 @@ func Commands() *cobra.Command {
_ = cmd.MarkPersistentFlagRequired("zone")

cmd.AddCommand(network.Commands())
cmd.AddCommand(port.Commands())

return cmd
}
1 change: 1 addition & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
- [capibmadm CLI](./topics/capibmadm/index.md)
- [Power VS Commands](./topics/capibmadm/powervs/index.md)
- [Network Commands](./topics/capibmadm/powervs/network.md)
- [Port Commands](./topics/capibmadm/powervs/port.md)
- [Developer Guide](./developer/index.md)
- [Rapid iterative development with Tilt](./developer/tilt.md)
- [Guide for API conversions](./developer/conversion.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/book/src/topics/capibmadm/powervs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
- [network](./network.md)
- [create](/topics/capibmadm/powervs/network.html#1-capibmadm-powervs-network-create)
- [list](/topics/capibmadm/powervs/network.html#2-capibmadm-powervs-network-list)
- [port](./port.md)
- [delete](/topics/capibmadm/powervs/port.html#1-capibmadm-powervs-port-delete)
24 changes: 24 additions & 0 deletions docs/book/src/topics/capibmadm/powervs/port.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
## Power VS Network Commands

### 1. capibmadm powervs port delete

#### Usage:
Delete Power VS network port.

#### Environmental Variable:
IBMCLOUD_API_KEY: IBM Cloud api key.

#### Arguments:
--service-instance-id: Power VS service instance id.

--zone: Power VS zone

--port-id: ID of network port

--network: Network ID or Name(preference will be given to the ID over Name

#### Example:
```shell
export IBMCLOUD_API_KEY=<api-key>
capibmadm powervs port delete --port-id <port-id> --network <network-name/network-id> --service-instance-id <service-instance-id> --zone <zone-name>
``

0 comments on commit 8b0e8a5

Please sign in to comment.