porter install

porter install

Create a new installation of a bundle

Synopsis

Create a new installation of a bundle.

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

Once a bundle has been successfully installed, the install action cannot be repeated. This is a precaution to avoid accidentally overwriting an existing installation. If you need to re-run install, which is common when authoring a bundle, you can use the –force flag to by-pass this check.

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’ or the PORTER_RUNTIME_DRIVER environment variable. For example, the ‘debug’ driver may be specified, which simply logs the info given to it and then exits.

porter install [INSTALLATION] [flags]

Examples

  porter install
  porter install MyAppFromReference --reference getporter/kubernetes:v0.1.0 --namespace dev
  porter install --reference localhost:5000/getporter/kubernetes:v0.1.0 --insecure-registry --force
  porter install MyAppInDev --file myapp/bundle.json
  porter install --parameter-set azure --param test-mode=true --param header-color=blue
  porter install --cred azure --cred kubernetes
  porter install --driver debug
  porter install --label env=dev --label owner=myuser

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
  -l, --label strings              Associate the specified labels with the installation. May be specified multiple times.
  -n, --namespace string           Create the installation in the specified namespace. Defaults to the global namespace.
      --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.

Options inherited from parent commands

      --debug                  Enable debug logging
      --debug-plugins          Enable plugin debug logging
      --experimental strings   Comma separated list of experimental features to enable. See https://porter.sh/configuration/#experimental-feature-flags for available feature flags.

SEE ALSO

  • porter - With Porter you can package your application artifact, client tools, configuration and deployment logic together as a versioned bundle that you can distribute, and then install with a single command.

Most commands require a Docker daemon, either local or remote.

Try our QuickStart https://porter.sh/quickstart to learn how to use Porter.