Skip to content

Commit

Permalink
Add doc for vpc image list cmd (#1101)
Browse files Browse the repository at this point in the history
  • Loading branch information
dharaneeshvrd authored Feb 14, 2023
1 parent 66eddb3 commit caec424
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
- [Network Commands](./topics/capibmadm/powervs/network.md)
- [Port Commands](./topics/capibmadm/powervs/port.md)
- [SSH key Commands](./topics/capibmadm/powervs/key.md)
- [VPC Commands](./topics/capibmadm/vpc/index.md)
- [Image Commands](./topics/capibmadm/vpc/image.md)
- [Developer Guide](./developer/index.md)
- [Rapid iterative development with Tilt](./developer/tilt.md)
- [Guide for API conversions](./developer/conversion.md)
Expand Down
1 change: 1 addition & 0 deletions docs/book/src/topics/capibmadm/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
Kubernetes Cluster API Provider IBM Cloud Management Utility

## [1. Power VS commands](./powervs/index.md)
## [2. VPC commands](./vpc/index.md)
20 changes: 20 additions & 0 deletions docs/book/src/topics/capibmadm/vpc/image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## PowerVS VPC Commands

### 1. capibmadm vpc image list

#### Usage:
List images in given VPC region.

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

#### Arguments:
--region: VPC region.

--resource-group-name: IBM Cloud resource group name.

#### Example:
```shell
export IBMCLOUD_API_KEY=<api-key>
capibmadm vpc image list --region <region> --resource-group-name <resource-group>
```
6 changes: 6 additions & 0 deletions docs/book/src/topics/capibmadm/vpc/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# capibmadm vpc `<commands>`


## 1. VPC commands
- [image](./image.md)
- [list](/topics/capibmadm/vpc/image.html#1-capibmadm-vpc-image-list)

0 comments on commit caec424

Please sign in to comment.