Docker-Docs/_data/docker-app/docker_app_install.yaml

116 lines
3.1 KiB
YAML

command: docker app install
aliases: deploy
short: Install an application
long: |-
Install an application.
By default, the application definition in the current directory will be
installed. The APP_NAME can also be:
- a path to a Docker Application definition (.dockerapp) or a CNAB bundle.json
- a registry Application Package reference
usage: docker app install [APP_NAME] [--name INSTALLATION_NAME] [--target-context
TARGET_CONTEXT] [OPTIONS]
pname: docker app
plink: docker_app.yaml
options:
- option: credential-set
value_type: stringArray
default_value: '[]'
description: |
Use a YAML file containing a credential set or a credential set present in the credential store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: insecure-registries
value_type: stringSlice
default_value: '[]'
description: |
Use HTTP instead of HTTPS when pulling from/pushing to those registries
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: kubernetes-namespace
value_type: string
default_value: default
description: Kubernetes namespace to install into
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: Installation name (defaults to application name)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: orchestrator
value_type: string
description: Orchestrator to install on (swarm, kubernetes)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: parameters-file
value_type: stringArray
default_value: '[]'
description: Override parameters file
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: pull
value_type: bool
default_value: "false"
description: Pull the bundle
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: set
shorthand: s
value_type: stringArray
default_value: '[]'
description: Override parameter value
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: target-context
value_type: string
description: |
Context on which the application is installed (default: <current-context>)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: with-registry-auth
value_type: bool
default_value: "false"
description: Sends registry auth
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
examples: |-
$ docker app install myapp.dockerapp --name myinstallation --target-context=mycontext
$ docker app install myrepo/myapp:mytag --name myinstallation --target-context=mycontext
$ docker app install bundle.json --name myinstallation --credential-set=mycredentials.yml
deprecated: false
experimental: false
experimentalcli: true
kubernetes: false
swarm: false