porter

I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

Synopsis

I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

Examples

  porter create
  porter build
  porter install
  porter uninstall

Options

      --debug   Enable debug logging
  -h, --help    help for porter

SEE ALSO

porter archive

Archive a bundle

Synopsis

Archives a bundle by generating a gzipped tar archive containing the bundle, invocation image and any referenced images.

porter archive [flags]

Examples

  porter archive [FILENAME]
  porter archive --file another/porter.yaml [FILENAME]
  porter archive --cnab-file some/bundle.json [FILENAME]
		  

Options

      --cnab-file string   Path to the CNAB bundle.json file.
  -f, --file porter.yaml   Path to the Porter manifest. Defaults to porter.yaml in the current directory.
  -h, --help               help for archive

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter build

Build a bundle

Synopsis

Builds the bundle in the current directory by generating a Dockerfile and a CNAB bundle.json, and then building the invocation image.

porter build [flags]

Options

  -h, --help      help for build
  -v, --verbose   Enable verbose logging

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter bundles

Bundle commands

Synopsis

Commands for working with bundles. These all have shortcuts so that you can call these commands without the bundle resource prefix. For example, porter bundle install is available as porter install as well.

Options

  -h, --help   help for bundles

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles archive

Archive a bundle

Synopsis

Archives a bundle by generating a gzipped tar archive containing the bundle, invocation image and any referenced images.

porter bundles archive [flags]

Examples

  porter bundle archive [FILENAME]
  porter bundle archive --file another/porter.yaml [FILENAME]
  porter bundle archive --cnab-file some/bundle.json [FILENAME]
		  

Options

      --cnab-file string   Path to the CNAB bundle.json file.
  -f, --file porter.yaml   Path to the Porter manifest. Defaults to porter.yaml in the current directory.
  -h, --help               help for archive

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles build

Build a bundle

Synopsis

Builds the bundle in the current directory by generating a Dockerfile and a CNAB bundle.json, and then building the invocation image.

porter bundles build [flags]

Options

  -h, --help      help for build
  -v, --verbose   Enable verbose logging

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles create

Create a bundle

Synopsis

Create a bundle. This generates a porter bundle in the current directory.

porter bundles create [flags]

Options

  -h, --help   help for create

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles install

Install a new instance of a bundle

Synopsis

Install a new instance of a bundle.

The first argument is the bundle instance name to create for the installation. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter bundles install [INSTANCE] [flags]

Examples

  porter bundle install
  porter bundle install --insecure
  porter bundle install MyAppInDev --file myapp/bundle.json
  porter bundle install --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter bundle install --cred azure --cred kubernetes
  porter bundle install --driver debug
  porter bundle install MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0

Options

      --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.
  -h, --help                 help for install
      --insecure             Allow working with untrusted bundles (default true)
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles invoke

Invoke a custom action on a bundle instance

Synopsis

Invoke a custom action on a bundle instance.

The first argument is the bundle instance name upon which to invoke the action. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter bundles invoke [INSTANCE] --action ACTION [flags]

Examples

  porter bundle invoke --action ACTION
  porter bundle invoke --action ACTION MyAppInDev --file myapp/bundle.json
  porter bundle invoke --action ACTION --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter bundle invoke --action ACTION --cred azure --cred kubernetes
  porter bundle invoke --action ACTION --driver debug
  porter bundle invoke --action ACTION MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0

Options

      --action string        Custom action name to invoke.
      --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.
  -h, --help                 help for invoke
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles uninstall

Uninstall a bundle instance

Synopsis

Uninstall a bundle instance

The first argument is the bundle instance name to uninstall. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter bundles uninstall [INSTANCE] [flags]

Examples

  porter bundle uninstall
  porter bundle uninstall --insecure
  porter bundle uninstall MyAppInDev --file myapp/bundle.json
  porter bundle uninstall --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter bundle uninstall --cred azure --cred kubernetes
  porter bundle uninstall --driver debug
  porter bundle uninstall MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0


Options

      --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.
  -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.
  -h, --help                 help for uninstall
      --insecure             Allow working with untrusted bundles (default true)
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter bundles upgrade

Upgrade a bundle instance

Synopsis

Upgrade a bundle instance.

The first argument is the bundle instance name to upgrade. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter bundles upgrade [INSTANCE] [flags]

Examples

  porter bundle upgrade
  porter bundle upgrade --insecure
  porter bundle upgrade MyAppInDev --file myapp/bundle.json
  porter bundle upgrade --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter bundle upgrade --cred azure --cred kubernetes
  porter bundle upgrade --driver debug
  porter bundle upgrade MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0

Options

      --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.
  -h, --help                 help for upgrade
      --insecure             Allow working with untrusted bundles (default true)
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter create

Create a bundle

Synopsis

Create a bundle. This generates a porter bundle in the current directory.

porter create [flags]

Options

  -h, --help   help for create

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter credentials

Credentials commands

Synopsis

Credentials commands

Options

  -h, --help   help for credentials

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter credentials generate

Generate Credential Set

Synopsis

Generate a named set of credentials.

The first argument is the name of credential set you wish to generate. If not provided, this will default to the bundle name. By default, Porter will generate a credential set for the bundle in the current directory. You may also specify a bundle with –file.

Bundles define 1 or more credential(s) that are required to interact with a bundle. The bundle definition defines where the credential should be delivered to the bundle, i.e. at /root/.kube. A credential set, on the other hand, represents the source data that you wish to use when interacting with the bundle. These will typically be environment variables or files on your local file system.

When you wish to install, upgrade or delete a bundle, Porter will use the credential set to determine where to read the necessary information from and will then provide it to the bundle in the correct location.

porter credentials generate [NAME] [flags]

Examples

  porter credential generate
  porter bundle credential generate kubecred --insecure
  porter bundle credential generate kubecred --file myapp/porter.yaml
  porter bundle credential generate kubecred --tag deislabs/cool-bundle:v1.0.1
  porter bundle credential generate kubecred --cnab-file myapp/bundle.json --dry-run

Options

      --cnab-file string   Path to the CNAB bundle.json file.
      --dry-run            Generate credential but do not save it.
  -f, --file string        Path to the porter manifest file. Defaults to the bundle in the current directory.
  -h, --help               help for generate
      --insecure           Allow working with untrusted bundles. (default true)
      --tag string         Use a bundle in an OCI registry specified by the given tag.

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter credentials list

List credentials

Synopsis

List named sets of credentials defined by the user.

porter credentials list [flags]

Examples

  porter credentials list [-o table|json|yaml]

Options

  -h, --help            help for list
  -o, --output string   Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter credentials show

Show a Credential

Synopsis

Show a particular credential set, including all named credentials and their corresponding mappings.

porter credentials show [flags]

Examples

  porter credential show NAME [-o table|json|yaml]

Options

  -h, --help            help for show
  -o, --output string   Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter docs

Generate markdown docs

Synopsis

Generate markdown docs for https://porter.sh/cli

porter docs [flags]

Options

  -d, --dest string   Destination directory (default "./docs/content/cli/")
  -h, --help          help for docs

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter install

Install a new instance of a bundle

Synopsis

Install a new instance of a bundle.

The first argument is the bundle instance name to create for the installation. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter install [INSTANCE] [flags]

Examples

  porter install
  porter install --insecure
  porter install MyAppInDev --file myapp/bundle.json
  porter install --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter install --cred azure --cred kubernetes
  porter install --driver debug
  porter install MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0

Options

      --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.
  -h, --help                 help for install
      --insecure             Allow working with untrusted bundles (default true)
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter instances

Bundle Instance commands

Synopsis

Commands for working with instances of a bundle

Options

  -h, --help   help for instances

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter instances list

list instances of installed bundles

Synopsis

List instances of all bundles installed by Porter.

A listing of instances of bundles currently installed by Porter will be provided, along with metadata such as creation time, last action, last status, etc.

Optional output formats include json and yaml.

porter instances list [flags]

Examples

  porter instances list
  porter instances list -o json

Options

  -h, --help            help for list
  -o, --output string   Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter instances output list

List bundle instance outputs

Synopsis

Displays a listing of bundle instance outputs.

porter instances output list [--instance|i INSTANCE] [flags]

Examples

  porter instance outputs list
    porter instance outputs list --instance another-bundle

Options

  -h, --help              help for list
  -i, --instance string   Specify the bundle instance to which the output belongs.
  -o, --output string     Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter instances output show

Show the output of a bundle instance

Synopsis

Show the output of a bundle instance

porter instances output show NAME [--instance|-i INSTANCE] [flags]

Examples

  porter instance output show kubeconfig
    porter instance output show subscription-id --instance azure-mysql

Options

  -h, --help              help for show
  -i, --instance string   Specify the bundle instance to which the output belongs.

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter instances show

Show an instance of a bundle

Synopsis

Displays info relating to an instance of a bundle, including status and a listing of outputs.

porter instances show [INSTANCE] [flags]

Examples

  porter instance show
porter instance show another-bundle

Optional output formats include json and yaml.

Options

  -h, --help            help for show
  -o, --output string   Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter invoke

Invoke a custom action on a bundle instance

Synopsis

Invoke a custom action on a bundle instance.

The first argument is the bundle instance name upon which to invoke the action. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter invoke [INSTANCE] --action ACTION [flags]

Examples

  porter invoke --action ACTION
  porter invoke --action ACTION MyAppInDev --file myapp/bundle.json
  porter invoke --action ACTION --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter invoke --action ACTION --cred azure --cred kubernetes
  porter invoke --action ACTION --driver debug
  porter invoke --action ACTION MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0

Options

      --action string        Custom action name to invoke.
      --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.
  -h, --help                 help for invoke
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter list

list instances of installed bundles

Synopsis

List instances of all bundles installed by Porter.

A listing of instances of bundles currently installed by Porter will be provided, along with metadata such as creation time, last action, last status, etc.

Optional output formats include json and yaml.

porter list [flags]

Examples

  porter instances list
  porter instances list -o json

Options

  -h, --help            help for list
  -o, --output string   Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter mixins delete

Delete a mixin

Synopsis

Delete a mixin

porter mixins delete NAME [flags]

Examples

  porter mixin delete helm

Options

  -h, --help   help for delete

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter mixins feed

Feed commands

Synopsis

Feed commands

Options

  -h, --help   help for feed

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter mixins feed generate

Generate an atom feed from the mixins in a directory

Synopsis

Generate an atom feed from the mixins in a directory.

A template is required, providing values for text properties such as the author name, base URLs and other values that cannot be inferred from the mixin file names. You can make a default template by running ‘porter mixins feed template’.

The file names of the mixins must follow the naming conventions required of published mixins:

VERSION/MIXIN-GOOS-GOARCH[FILE_EXT]

More than one mixin may be present in the directory, and the directories may be nested a few levels deep, as long as the file path ends with the above naming convention, porter will find and match it. Below is an example directory structure that porter can list to generate a feed:

bin/ └── v1.2.3/ ├── mymixin-darwin-amd64 ├── mymixin-linux-amd64 └── mymixin-windows-amd64.exe

See https://porter.sh/mixin-distribution more details.

porter mixins feed generate [flags]

Examples

  porter mixin feed generate
  porter mixin feed generate --dir bin --file bin/atom.xml --template porter-atom-template.xml

Options

  -d, --dir string        The directory to search for mixin versions to publish in the feed. Defaults to the current directory.
  -f, --file string       The path of the atom feed output by this command. (default "atom.xml")
  -h, --help              help for generate
  -t, --template string   The template atom file used to populate the text fields in the generated feed. (default "atom-template.xml")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter mixins feed template

Create an atom feed template

Synopsis

Create an atom feed template in the current directory

porter mixins feed template [flags]

Options

  -h, --help   help for template

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter mixins install

Install a mixin

Synopsis

Install a mixin

porter mixins install NAME [flags]

Examples

  porter mixin install helm --url https://cdn.deislabs.io/porter/mixins/helm
  porter mixin install helm --feed-url https://cdn.deislabs.io/porter/atom.xml
  porter mixin install azure --version v0.4.0-ralpha.1+dubonnet --url https://cdn.deislabs.io/porter/mixins/azure
  porter mixin install kubernetes --version canary --url https://cdn.deislabs.io/porter/mixins/kubernetes

Options

      --feed-url string   URL of an atom feed where the mixin can be downloaded (default https://cdn.deislabs.io/porter/atom.xml)
  -h, --help              help for install
      --url string        URL from where the mixin can be downloaded, for example https://github.com/org/proj/releases/downloads
  -v, --version string    The mixin version. This can either be a version number, or a tagged release like 'latest' or 'canary' (default "latest")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter mixins list

List installed mixins

Synopsis

List installed mixins

porter mixins list [flags]

Options

  -h, --help            help for list
  -o, --output string   Output format, allowed values are: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

porter publish

Publish a bundle

Synopsis

Publishes a bundle by pushing the invocation image and bundle to a registry.

porter publish [flags]

Examples

  porter publish
  porter publish --file myapp/porter.yaml
  porter publish --insecure
		

Options

  -f, --file porter.yaml    Path to the Porter manifest. Defaults to porter.yaml in the current directory.
  -h, --help                help for publish
      --insecure-registry   Don't require TLS for the registry.

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter schema

Print the JSON schema for the Porter manifest

Synopsis

Print the JSON schema for the Porter manifest

porter schema [flags]

Options

  -h, --help   help for schema

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter show

Show an instance of a bundle

Synopsis

Displays info relating to an instance of a bundle, including status and a listing of outputs.

porter show [INSTANCE] [flags]

Examples

  porter instance show
porter instance show another-bundle

Optional output formats include json and yaml.

Options

  -h, --help            help for show
  -o, --output string   Specify an output format.  Allowed values: table, json, yaml (default "table")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter uninstall

Uninstall a bundle instance

Synopsis

Uninstall a bundle instance

The first argument is the bundle instance name to uninstall. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter uninstall [INSTANCE] [flags]

Examples

  porter uninstall
  porter uninstall --insecure
  porter uninstall MyAppInDev --file myapp/bundle.json
  porter uninstall --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter uninstall --cred azure --cred kubernetes
  porter uninstall --driver debug
  porter uninstall MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0


Options

      --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.
  -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.
  -h, --help                 help for uninstall
      --insecure             Allow working with untrusted bundles (default true)
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter upgrade

Upgrade a bundle instance

Synopsis

Upgrade a bundle instance.

The first argument is the bundle instance name to upgrade. This defaults to the name of the bundle.

Porter uses the Docker driver as the default runtime for executing a bundle’s invocation image, but an alternate driver may be supplied via ‘–driver/-d’. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter upgrade [INSTANCE] [flags]

Examples

  porter upgrade
  porter upgrade --insecure
  porter upgrade MyAppInDev --file myapp/bundle.json
  porter upgrade --param-file base-values.txt --param-file dev-values.txt --param test-mode=true --param header-color=blue
  porter upgrade --cred azure --cred kubernetes
  porter upgrade --driver debug
  porter upgrade MyAppFromTag --tag deislabs/porter-kube-bundle:v1.0

Options

      --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.
  -h, --help                 help for upgrade
      --insecure             Allow working with untrusted bundles (default true)
      --insecure-registry    Don't require TLS for the registry
      --param strings        Define an individual parameter in the form NAME=VALUE. Overrides parameters set with the same name using --param-file. May be specified multiple times.
      --param-file strings   Path to a parameters definition file for the bundle, each line in the form of NAME=VALUE. May be specified multiple times.
  -t, --tag string           Use a bundle in an OCI registry specified by the given tag

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool

porter version

Print the application version

Synopsis

Print the application version

porter version [flags]

Options

  -h, --help            help for version
  -o, --output string   Specify an output format.  Allowed values: json, plaintext (default "plaintext")

Options inherited from parent commands

      --debug   Enable debug logging

SEE ALSO

  • porter - I am porter 👩🏽‍✈️, the friendly neighborhood CNAB authoring tool