feature: plugin-manager should have way to get info about available plugins

[djzager]

Feature Request

The plugin-manager should provide an info subcommand that gives users more information about the specified plugin.

Description

Currently, the plugin-manager subcommand supports listing of the available plugins, for example:

$ crane plugin-manager list --params
Listing from the repo default
+-------------+--------------------+----------------------------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|    NAME     |  SHORTDESCRIPTION  |        DESCRIPTION         | AVAILABLEVERSIONS |                                                                                   OPTIONALFIELDS                                                                                   |
+-------------+--------------------+----------------------------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| pvc         | pvc                | this is pvc                | 0.0.1             |                                                                                                                                                                                    |
+-------------+--------------------+----------------------------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| hc-whiteout | hc-whiteout plugin | this is hc-whiteout plugin | 0.0.1             |                                                                                                                                                                                    |
+-------------+--------------------+----------------------------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| openshift   | openshift          | this is openshift          | 1.0.7             | - FlagName: StripDefaultPullSecrets                                                                                                                                                |
|             |                    |                            |                   |   Help: Whether to strip Pod and BuildConfig default pull secrets (beginning with builder/default/deployer-dockercfg-) that aren't replaced by the map param PullSecretReplacement |
|             |                    |                            |                   |   Example: true                                                                                                                                                                    |
|             |                    |                            |                   | - FlagName: PullSecretReplacement                                                                                                                                                  |
|             |                    |                            |                   |   Help: Map of pull secrets to replace in Pods and BuildConfigs while transforming in format secret1=destsecret1,secret2=destsecret2[...]                                          |
|             |                    |                            |                   |   Example: default-dockercfg-h4n7g=default-dockercfg-12345,builder-dockercfg-abcde=builder-dockercfg-12345                                                                         |
|             |                    |                            |                   | - FlagName: RegistryReplacement                                                                                                                                                    |
|             |                    |                            |                   |   Help: Map of image registry paths to swap on transform, in the format original-registry1=target-registry1,original-registry2=target-registry2...                                 |
|             |                    |                            |                   |   Example: docker-registry.default.svc:5000=image-registry.openshift-image-registry.svc:5000,docker.io/foo=quay.io/bar                                                             |
+-------------+--------------------+----------------------------+-------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

However, this doesn't give the end user much insight into what the plugin does, how it does it, or the when/why the end user would install and use it.

And instead of using table to consume this information, output similar to something like following makes more sense:

Name:                  OpenshiftPlugin
ShortDescription:    <short-description>
Description:            <description>
Version:                   <version>
OptionalFields:        <optional-fields>

Solution

Introduce an info subcommand that provides long form explanation of a specified user plugin.

Alternative Solutions

• Populating the SHORTDESCRIPTION and DESCRIPTION with an actual description 😎 might lessen the need for a new info command.
• Change the output from table to similar to something that is mentioned above.

[JaydipGabani]

Updating SHORTDESCRIPTION and DESCRIPTION with appropriate information is in the list, so this might be updated in a while

[eriknelson]

/kind enhancement
/priority low
/triage accepted

[openshift-ci]

@eriknelson: The label(s) kind/enhancement, priority/low cannot be applied, because the repository doesn't have them.

In response to this:

/kind enhancement
/priority low
/triage accepted

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[github-actions]

This issue synced with: https://issues.redhat.com/browse/MTRHO-65

[eriknelson]

/priority minor

[eriknelson]

/kind enhancement

[openshift-ci]

@eriknelson: The label(s) kind/enhancement cannot be applied, because the repository doesn't have them.

In response to this:

/kind enhancement

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[eriknelson]

/kind feature