Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Backport Switch from StringSlice to StringArray (#1931) #2046

Merged
merged 2 commits into from
May 2, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ and we will add you. **All** contributors belong here. 💯
* [Saksham Sharma](https://github.com/sakkshm26)
* [Quentin Petraroia](https://github.com/qpetraroia)
* [Tamir Kamara](https://github.com/tamirkamara)

* [Chioma Onyekpere](https://github.com/Simpcyclassy)
24 changes: 12 additions & 12 deletions cmd/porter/bundle.go
Original file line number Diff line number Diff line change
Expand Up @@ -142,11 +142,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Path to the porter manifest file. Defaults to the bundle in the current directory.")
f.StringVar(&opts.CNABFile, "cnab-file", "",
"Path to the CNAB bundle.json file.")
f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringSliceVar(&opts.Params, "param", nil,
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down Expand Up @@ -190,11 +190,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Path to the porter manifest file. Defaults to the bundle in the current directory.")
f.StringVar(&opts.CNABFile, "cnab-file", "",
"Path to the CNAB bundle.json file.")
f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringSliceVar(&opts.Params, "param", nil,
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down Expand Up @@ -241,11 +241,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Path to the porter manifest file. Defaults to the bundle in the current directory.")
f.StringVar(&opts.CNABFile, "cnab-file", "",
"Path to the CNAB bundle.json file.")
f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringSliceVar(&opts.Params, "param", nil,
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down Expand Up @@ -292,11 +292,11 @@ For example, the 'debug' driver may be specified, which simply logs the info giv
"Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.")
f.StringVar(&opts.CNABFile, "cnab-file", "",
"Path to the CNAB bundle.json file.")
f.StringSliceVarP(&opts.ParameterSets, "parameter-set", "p", nil,
f.StringArrayVarP(&opts.ParameterSets, "parameter-set", "p", nil,
"Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.")
f.StringSliceVar(&opts.Params, "param", nil,
f.StringArrayVar(&opts.Params, "param", nil,
"Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.")
f.StringSliceVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
f.StringArrayVarP(&opts.CredentialIdentifiers, "cred", "c", nil,
"Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.")
f.StringVarP(&opts.Driver, "driver", "d", porter.DefaultDriver,
"Specify a driver to use. Allowed values: docker, debug")
Expand Down
24 changes: 12 additions & 12 deletions docs/content/cli/bundles_install.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ porter bundles install [INSTALLATION] [flags]
### Options

```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
-h, --help help for install
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param strings Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set strings Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred stringArray Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
-h, --help help for install
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param stringArray Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set stringArray Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
```

### Options inherited from parent commands
Expand Down
26 changes: 13 additions & 13 deletions docs/content/cli/bundles_invoke.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,19 +36,19 @@ porter bundles invoke [INSTALLATION] --action ACTION [flags]
### Options

```
--action string Custom action name to invoke.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
-h, --help help for invoke
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param strings Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set strings Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
--action string Custom action name to invoke.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred stringArray Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
-h, --help help for invoke
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param stringArray Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set stringArray Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
```

### Options inherited from parent commands
Expand Down
28 changes: 14 additions & 14 deletions docs/content/cli/bundles_uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,20 +38,20 @@ porter bundles uninstall [INSTALLATION] [flags]
### Options

```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
--delete Delete all records associated with the installation, assuming the uninstall action succeeds
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
--force Force a fresh pull of the bundle
--force-delete UNSAFE. Delete all records associated with the installation, even if uninstall fails. This is intended for cleaning up test data and is not recommended for production environments.
-h, --help help for uninstall
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param strings Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set strings Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred stringArray Credential to use when uninstalling the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
--delete Delete all records associated with the installation, assuming the uninstall action succeeds
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory. Optional unless a newer version of the bundle should be used to uninstall the bundle.
--force Force a fresh pull of the bundle
--force-delete UNSAFE. Delete all records associated with the installation, even if uninstall fails. This is intended for cleaning up test data and is not recommended for production environments.
-h, --help help for uninstall
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param stringArray Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set stringArray Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
```

### Options inherited from parent commands
Expand Down
24 changes: 12 additions & 12 deletions docs/content/cli/bundles_upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,18 +36,18 @@ porter bundles upgrade [INSTALLATION] [flags]
### Options

```
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred strings Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
-h, --help help for upgrade
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param strings Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set strings Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
--allow-docker-host-access Controls if the bundle should have access to the host's Docker daemon with elevated privileges. See https://porter.sh/configuration/#allow-docker-host-access for the full implications of this flag.
--cnab-file string Path to the CNAB bundle.json file.
-c, --cred stringArray Credential to use when installing the bundle. May be either a named set of credentials or a filepath, and specified multiple times.
-d, --driver string Specify a driver to use. Allowed values: docker, debug (default "docker")
-f, --file string Path to the porter manifest file. Defaults to the bundle in the current directory.
--force Force a fresh pull of the bundle
-h, --help help for upgrade
--insecure-registry Don't require TLS for the registry
--no-logs Do not persist the bundle execution logs
--param stringArray Define an individual parameter in the form NAME=VALUE. Overrides parameters otherwise set via --parameter-set. May be specified multiple times.
-p, --parameter-set stringArray Name of a parameter set file for the bundle. May be either a named set of parameters or a filepath, and specified multiple times.
-r, --reference string Use a bundle in an OCI registry specified by the given reference.
```

### Options inherited from parent commands
Expand Down
3 changes: 2 additions & 1 deletion docs/content/cli/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@ Generate completion script

### Synopsis

Capture the output of the completion command to a file for your shell environment.
Save the output of this command to a file and load the file into your shell.
For additional details see: https://porter.sh/install#command-completion

```
porter completion [bash|zsh|fish|powershell]
Expand Down
Loading