ppc64le-cloud / pvsadm

Tool for managing the IBM Power Systems Virtual Servers
Apache License 2.0
37 stars 38 forks source link

Misaligned Tier information in the import command #665

Closed mkumatag closed 1 month ago

mkumatag commented 1 month ago

What happened:

Tier information in the help message is completely misaligned

% pvsadm image import --help
Import the image into PowerVS workpace
pvsadm image import --help for information

# Set the API key or feed the --api-key commandline argument
export IBMCLOUD_API_KEY=<IBM_CLOUD_API_KEY>

# To Import the image across the two different IBM account use "--accesskey" and "--secretkey" options

# To Import the image from public bucket use the "--public-bucket" or "-p" option

Examples:

# import image using default storage type (service credential will be autogenerated)
pvsadm image import -n upstream-core-lon04 -b <BUCKETNAME> --object rhel-83-10032020.ova.gz --pvs-image-name test-image -r <REGION>

# import image using default storage type with specifying the accesskey and secretkey explicitly
pvsadm image import -n upstream-core-lon04 -b <BUCKETNAME> --accesskey <ACCESSKEY> --secretkey <SECRETKEY> --object rhel-83-10032020.ova.gz --pvs-image-name test-image -r <REGION>

# with user provided storage type
pvsadm image import -n upstream-core-lon04 -b <BUCKETNAME> --pvs-storagetype <STORAGETYPE> --object rhel-83-10032020.ova.gz --pvs-image-name test-image -r <REGION>

# If user wants to specify the type of OS
pvsadm image import -n upstream-core-lon04 -b <BUCKETNAME> --object rhel-83-10032020.ova.gz --pvs-image-name test-image -r <REGION>

# import image from a public IBM Cloud Storage bucket
pvsadm image import -n upstream-core-lon04 -b <BUCKETNAME> --object rhel-83-10032020.ova.gz --pvs-image-name test-image -r <REGION> --public-bucket

Usage:
  pvsadm image import [flags]

Flags:
      --workspace-name string     PowerVS Workspace name.
      --workspace-id string       PowerVS Workspace ID.
  -b, --bucket string             Cloud Object Storage bucket name.
  -r, --bucket-region string      Cloud Object Storage bucket location.
  -o, --object string             Cloud Object Storage object name.
      --accesskey string          Cloud Object Storage HMAC access key.
      --secretkey string          Cloud Object Storage HMAC secret key.
      --pvs-image-name string     Name to PowerVS imported image.
  -p, --public-bucket             Cloud Object Storage public bucket.
  -w, --watch                     After image import watch for image to be published and ready to use
      --watch-timeout duration    watch timeout (default 1h0m0s)
      --pvs-storagetype string    PowerVS Storage type, accepted values are [tier1, tier3, tier0, tier5k].
                                                                                                                        Tier 0            | 25 IOPS/GB
                                                                                                                        Tier 1            | 10 IOPS/GB
                                                                                                                        Tier 3            | 3 IOPS/GB
                                                                                                                        Fixed IOPS/Tier5k | 5000 IOPS regardless of size
                                                                                                                        Note: The use of fixed IOPS is limited to volumes with a size of 200 GB or less, which is the break even size with Tier 0 (200 GB @ 25 IOPS/GB = 5000 IOPS). (default "tier3")
      --cos-service-cred string   IBM COS Service Credential name to be auto generated(default "pvsadm-service-cred-<COS Name>")
  -h, --help                      help for import

Global Flags:
      --add_dir_header                   If true, adds the file directory to the header of the log messages
      --alsologtostderr                  log to standard error as well as files (no effect when -logtostderr=true)
  -k, --api-key string                   IBMCLOUD API Key(env name: IBMCLOUD_APIKEY)
      --debug                            Enable PowerVS debug option(ATTENTION: dev only option, may print sensitive data from APIs)
      --env string                       IBM Cloud Environments, supported are: [test, prod] (default "prod")
      --log_backtrace_at traceLocation   when logging hits line file:N, emit a stack trace (default :0)
      --log_dir string                   If non-empty, write log files in this directory (no effect when -logtostderr=true)
      --log_file string                  If non-empty, use this log file (no effect when -logtostderr=true)
      --log_file_max_size uint           Defines the maximum size a log file can grow to (no effect when -logtostderr=true). Unit is megabytes. If the value is 0, the maximum file size is unlimited. (default 1800)
      --logtostderr                      log to standard error instead of files (default true)
      --one_output                       If true, only write logs to their native severity level (vs also writing to each lower severity level; no effect when -logtostderr=true)
      --skip_headers                     If true, avoid header prefixes in the log messages
      --skip_log_headers                 If true, avoid headers when opening log files (no effect when -logtostderr=true)
      --stderrthreshold severity         logs at or above this threshold go to stderr when writing to files and stderr (no effect when -logtostderr=true or -alsologtostderr=true) (default 2)
  -v, --v Level                          number for the log level verbosity
      --vmodule moduleSpec               comma-separated list of pattern=N settings for file-filtered logging

What you expected to happen:

How to reproduce it (as minimally and precisely as possible):

Anything else we need to know?:

Environment:

mkumatag commented 1 month ago

cc @kishen-v

kishen-v commented 1 month ago

/good-first-issue

ppc64le-cloud-bot commented 1 month ago

@kishen-v: This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed by commenting with the /remove-good-first-issue command.

In response to [this](https://github.com/ppc64le-cloud/pvsadm/issues/665): >/good-first-issue > Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
GunaKKIBM commented 1 month ago

/assign

kishen-v commented 1 month ago

Fixed via: #677

/close

ppc64le-cloud-bot commented 1 month ago

@kishen-v: Closing this issue.

In response to [this](https://github.com/ppc64le-cloud/pvsadm/issues/665#issuecomment-2378757911): >Fixed via: #677 > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.