Add installation instruction to porter explain command

[joshuabezaleel]

What does this change

Add installation instructions for porter explain command which includes generating credentials first and then including required parameters to the installation instruction of a particular bundle.

What issue does it fix

Closes #1511

Notes for the reviewer

Put any questions or notes for the reviewer here.

Checklist

• Unit Tests
• Documentation
• Schema (porter.yaml)

[joshuabezaleel]

Hi @carolynvs I've added a draft PR for this particular issue and a screenshot showing the result of running the command.
Should I also add a new unit test using a new bundle json test file for this specific case?

Thank you so much in advance! Looking forward to the review 🙂

[carolynvs]

Since you already updated the existing unit test's output, there's no need for a new unit test. 👍

[carolynvs]

Thanks, this is exactly what I was looking for. I have just some small revisions but it's looking good!

[carolynvs]

I just checked out the latest code and tried it out:

$ porter explain -r getporter/wordpress:v0.1.4
Name: wordpress
Description:
Version: 0.1.4
Porter Version: v1.0.0-alpha.3

Credentials:
Name         Description   Required   Applies To
kubeconfig                 true       All Actions

Parameters:
Name                 Description   Type     Default               Required   Applies To
namespace                          string   wordpress             false      All Actions
wordpress-name                     string   porter-ci-wordpress   false      All Actions
wordpress-password                 string   <nil>                 true       install,upgrade

Outputs:
Name                 Description                           Type     Applies To
wordpress-password   The Wordpress installation password   string   install,upgrade

Actions:
Name   Description   Modifies Installation   Stateless
ping   ping          true                    false

Dependencies:
Alias   Reference
mysql   localhost:5000/mysql:v0.1.4

This bundle uses the following tools: exec, helm3.
To install this bundle run the following command, passing --param KEY=VALUE for any parameters you want to customize:
porter credentials generate kubeconfig --reference getporter/wordpress:v0.1.4
porter install --reference getporter/wordpress:v0.1.4wordpress-password=TODO  --param  --cred kubeconfig

It's super close, there are just two things that need fixing:

• Let's start the instructions on it's own line, so that it's in a separate paragraph. Right now it kind of blends in with "This bundle uses the following tools"
• The parameters are printing out incorrectly. First because there isn't a space between the bundle reference and the parameter, but also because it should be --param wordpress-password=TODO, right now the flag value is printed before the flag.

[carolynvs]

Looks great, thanks for sticking with it. This is going to make it a lot easier for people new to Porter. 💯

$ porter explain -r getporter/porter-hello:v0.1.1
Name: porter-hello
Description: An example Porter configuration
Version: 0.1.1
Porter Version: v1.0.0-alpha.3

This bundle uses the following tools: exec.

To install this bundle run the following command, passing --param KEY=VALUE for any parameters you want to customize:
porter install --reference getporter/porter-hello:v0.1.1

[carolynvs]

I'm working on a new alpha release, so this will be included when it goes out next week!

[joshuabezaleel]

Hey @carolynvs , sorry that I was too tired yesterday because I just got back from a trip so I left the PR kind of hanging uncomfortably in the middle of doing it, and I am also not sure why 1 one of my commits got deleted while resolving the conflicts, thus the failing tests 🤔 Thank you for the on-point and detailed review!

Here is the screenshot of the explain command using the getporter/wordpress reference that you've used as the example earlier, also fixed the order of the --param flag.

Thank you so much for responding and merging the PR this fast! 😄