Skip to content

Commit 6aad2af

Browse files
authored
Merge pull request #96 from arcprabh/arc2_b
readme doc update for pvsadm.
2 parents 161853b + 16fc7ae commit 6aad2af

File tree

1 file changed

+12
-55
lines changed

1 file changed

+12
-55
lines changed

README.md

Lines changed: 12 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,18 @@
1-
# pvsadm
2-
31
## Overview
4-
Power Systems Virtual Server projects deliver flexible compute capacity for Power Systems workloads.
5-
Integrated with the IBM Cloud platform for on-demand provisioning.
6-
7-
This is a tool built for the Power Systems Virtual Server helps managing and maintaining the resources easily
8-
9-
```shell script
10-
./pvsadm --help
11-
Power Systems Virtual Server projects deliver flexible compute capacity for Power Systems workloads.
12-
Integrated with the IBM Cloud platform for on-demand provisioning.
13-
14-
This is a tool built for the Power Systems Virtual Server helps managing and maintaining the resources easily
15-
16-
Usage:
17-
pvsadm [command]
18-
19-
Available Commands:
20-
help Help about any command
21-
purge Purge the powervs resources
22-
23-
Flags:
24-
-k, --api-key string IBMCLOUD API Key(env name: IBMCLOUD_API_KEY)
25-
--debug Enable PowerVS debug option
26-
-h, --help help for pvsadm
27-
28-
Use "pvsadm [command] --help" for more information about a command.
29-
```
30-
31-
## Purge PowerVS Resources:
32-
33-
```shell script
34-
$ ./pvsadm purge --help
35-
Purge the powervs resources
362

37-
Usage:
38-
pvsadm purge [command]
3+
This is a tool to help with managing of resources in IBM Power Systems Virtual Server.
394

40-
Available Commands:
41-
images Purge the powervs images
42-
networks Purge the powervs networks
43-
vms Purge the powervs vms
44-
volumes Purge the powervs volumes
5+
## Installation
6+
1. Go to the [releases page](https://github.com/ppc64le-cloud/pvsadm/releases/)
7+
2. Select the latest release and download the relevant binary under the Assets section.
8+
3. Run the `pvsadm --help` command to check the available subcommands and the options.
459

46-
Flags:
47-
--before duration Remove resources before mentioned duration(format: 99h99m00s), mutually exclusive with --since
48-
--dry-run dry run the action and don't delete the actual resources
49-
-h, --help help for purge
50-
--ignore-errors Ignore any errors during the operations
51-
-i, --instance-id string Instance ID of the PowerVS instance
52-
-n, --instance-name string Instance name of the PowerVS
53-
--no-prompt Show prompt before doing any destructive operations
54-
--since duration Remove resources since mentioned duration(format: 99h99m00s), mutually exclusive with --before
10+
## Image Management
11+
Sub command under the pvsadm tool to perform image related tasks like image conversion, uploading and importing into the IBM Power Systems Virtual Server instances. For more information, refer to the `pvsadm image --help` command.
5512

56-
Global Flags:
57-
-k, --api-key string IBMCLOUD API Key(env name: IBMCLOUD_API_KEY)
58-
--debug Enable PowerVS debug option
13+
The typical image workflow comprises of the following steps:
5914

60-
Use "pvsadm purge [command] --help" for more information about a command.
61-
```
15+
1. Download the qcow2 image.
16+
2. Convert the downloaded qcow2 image to ova using `pvsadm image qcow2ova` command.
17+
3. Upload the ova image to IBM Cloud Object Store Bucket using `pvsadm image upload` command.
18+
4. Import the ova image to IBM Power Systems Virtual Server instances using `pvsadm image import` command.

0 commit comments

Comments
 (0)