Skip to content

Commit

Permalink
Add support for port create command (#1090)
Browse files Browse the repository at this point in the history
Shilpa-Gokul authored Feb 17, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
1 parent 96173bd commit 5e8d95f
Showing 4 changed files with 164 additions and 10 deletions.
125 changes: 125 additions & 0 deletions cmd/capibmadm/cmd/powervs/port/create.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
/*
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"
"fmt"
"os"

"github.com/spf13/cobra"

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

"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/printer"
"sigs.k8s.io/cluster-api-provider-ibmcloud/cmd/capibmadm/utils"
)

type portCreateOptions struct {
network string
ipAddress string
description string
}

// CreateCommand create powervs network port.
func CreateCommand() *cobra.Command {
cmd := &cobra.Command{
Use: "create",
Short: "Create PowerVS Port",
Example: `
# Create PowerVS network port
export IBMCLOUD_API_KEY=<api-key>
capibmadm powervs port create --network <netword-id/network-name> --description <description> --service-instance-id <service-instance-id> --zone <zone>`,
}

var portCreateOption portCreateOptions
cmd.Flags().StringVar(&portCreateOption.network, "network", "", "Network ID or Name on which port is to be created")
cmd.Flags().StringVar(&portCreateOption.ipAddress, "ip-address", "", "IP Address to be assigned to the port")
cmd.Flags().StringVar(&portCreateOption.description, "description", "", "Description of the port")
cmd.RunE = func(cmd *cobra.Command, args []string) error {
if err := createPort(cmd.Context(), portCreateOption); err != nil {
return err
}
return nil
}
options.AddCommonFlags(cmd)
_ = cmd.MarkFlagRequired("network")
return cmd
}

func createPort(ctx context.Context, portCreateOption portCreateOptions) error {
logger := log.Log
logger.Info("Creating Port ", "Network ID/Name", portCreateOption.network, "IP Address", portCreateOption.ipAddress, "Description", portCreateOption.description, "service-instance-id", options.GlobalOptions.ServiceInstanceID, "zone", options.GlobalOptions.PowerVSZone)
accountID, err := utils.GetAccountID(ctx, iam.GetIAMAuth())
if err != nil {
return err
}
session, err := powervs.NewPISession(accountID, options.GlobalOptions.PowerVSZone, options.GlobalOptions.Debug)
if err != nil {
return err
}

networkClient := client.NewIBMPINetworkClient(ctx, session, options.GlobalOptions.ServiceInstanceID)

network, err := networkClient.Get(portCreateOption.network)
if err != nil {
return err
}

params := &models.NetworkPortCreate{
IPAddress: portCreateOption.ipAddress,
Description: portCreateOption.description,
}

port, err := networkClient.CreatePort(*network.NetworkID, params)
if err != nil {
return fmt.Errorf("failed to create a port, err: %v", err)
}
logger.Info("Successfully created a port", "portID", *port.PortID)

portInfo := PList{
Items: []PSpec{},
}

portInfo.Items = append(portInfo.Items, PSpec{
Description: utils.DereferencePointer(port.Description).(string),
ExternalIP: port.ExternalIP,
IPAddress: utils.DereferencePointer(port.IPAddress).(string),
MacAddress: utils.DereferencePointer(port.MacAddress).(string),
PortID: utils.DereferencePointer(port.PortID).(string),
Status: utils.DereferencePointer(port.Status).(string),
})

printerObj, err := printer.New(options.GlobalOptions.Output, os.Stdout)
if err != nil {
return fmt.Errorf("failed creating output printer: %w", err)
}

if options.GlobalOptions.Output == printer.PrinterTypeTable {
table := portInfo.ToTable()
err = printerObj.Print(table)
} else {
err = printerObj.Print(portInfo)
}
return err
}
1 change: 1 addition & 0 deletions cmd/capibmadm/cmd/powervs/port/port.go
Original file line number Diff line number Diff line change
@@ -33,6 +33,7 @@ func Commands() *cobra.Command {

cmd.AddCommand(DeleteCommand())
cmd.AddCommand(ListCommand())
cmd.AddCommand(CreateCommand())

return cmd
}
7 changes: 4 additions & 3 deletions docs/book/src/topics/capibmadm/powervs/index.md
Original file line number Diff line number Diff line change
@@ -9,6 +9,7 @@
- [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)
- [list](/topics/capibmadm/powervs/port.html#1-capibmadm-powervs-port-list)

- [create](/topics/capibmadm/powervs/port.html#1-capibmadm-powervs-port-create)
- [delete](/topics/capibmadm/powervs/port.html#2-capibmadm-powervs-port-delete)
- [list](/topics/capibmadm/powervs/port.html#3-capibmadm-powervs-port-list)

41 changes: 34 additions & 7 deletions docs/book/src/topics/capibmadm/powervs/port.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,30 @@
## PowerVS Network Commands

### 1. capibmadm powervs port list
### 1. capibmadm powervs port create

#### Usage:
List PowerVS ports.
#### Usage:
Create PowerVS network port.

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

#### Arguments:
--service-instance-id: PowerVS service instance id.

--zone: PowerVS zone.
--zone: PowerVS service instance zone.

--network: Network ID or Name.
--network: Network ID/ Network Name.

--description: Description of the port.

--ip-address: The requested IP address of this port

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

### 2. capibmadm powervs port delete

#### Usage:
@@ -41,4 +46,26 @@ IBMCLOUD_API_KEY: IBM Cloud API key.
```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>
```
```

### 3. capibmadm powervs port list

#### Usage:
List PowerVS ports.

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

#### Arguments:
--service-instance-id: PowerVS service instance id.

--zone: PowerVS zone.

--network: Network ID or Name.

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

0 comments on commit 5e8d95f

Please sign in to comment.