mirror of https://github.com/docker/docs.git
Add docker template reference docs
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
parent
49a90ef0fc
commit
f93037b0d5
|
@ -0,0 +1,23 @@
|
|||
command: docker template
|
||||
short: Use templates to quickly create new services
|
||||
long: Use templates to quickly create new services
|
||||
pname: docker
|
||||
plink: docker.yaml
|
||||
cname:
|
||||
- docker template config
|
||||
- docker template inspect
|
||||
- docker template list
|
||||
- docker template scaffold
|
||||
- docker template version
|
||||
clink:
|
||||
- docker_template_config.yaml
|
||||
- docker_template_inspect.yaml
|
||||
- docker_template_list.yaml
|
||||
- docker_template_scaffold.yaml
|
||||
- docker_template_version.yaml
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
command: docker template config
|
||||
short: Modify docker template configuration
|
||||
long: Modify docker template configuration
|
||||
pname: docker template
|
||||
plink: docker_template.yaml
|
||||
cname:
|
||||
- docker template config set
|
||||
- docker template config view
|
||||
clink:
|
||||
- docker_template_config_set.yaml
|
||||
- docker_template_config_view.yaml
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,48 @@
|
|||
command: docker template config set
|
||||
short: set default values for docker template
|
||||
long: set default values for docker template
|
||||
usage: docker template config set
|
||||
pname: docker template config
|
||||
plink: docker_template_config.yaml
|
||||
options:
|
||||
- option: feedback
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: |
|
||||
Send anonymous feedback about usage (performance, failure status, os, version)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: no-feedback
|
||||
value_type: bool
|
||||
default_value: "false"
|
||||
description: Don't send anonymous feedback
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: org
|
||||
value_type: string
|
||||
description: Set default organization / docker hub user
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: server
|
||||
value_type: string
|
||||
description: Set default registry server (host[:port])
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
command: docker template config view
|
||||
short: view default values for docker template
|
||||
long: view default values for docker template
|
||||
usage: docker template config view
|
||||
pname: docker template config
|
||||
plink: docker_template_config.yaml
|
||||
options:
|
||||
- option: format
|
||||
value_type: string
|
||||
default_value: yaml
|
||||
description: Configure the output format (json|yaml)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,22 @@
|
|||
command: docker template inspect
|
||||
short: Inspect service templates or application templates
|
||||
long: Inspect service templates or application templates
|
||||
usage: docker template inspect <service or application>
|
||||
pname: docker template
|
||||
plink: docker_template.yaml
|
||||
options:
|
||||
- option: format
|
||||
value_type: string
|
||||
default_value: pretty
|
||||
description: Configure the output format (pretty|json|yaml)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,32 @@
|
|||
command: docker template list
|
||||
aliases: ls
|
||||
short: List available templates with their informations
|
||||
long: List available templates with their informations
|
||||
usage: docker template list
|
||||
pname: docker template
|
||||
plink: docker_template.yaml
|
||||
options:
|
||||
- option: format
|
||||
value_type: string
|
||||
default_value: pretty
|
||||
description: Configure the output format (pretty|json|yaml)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: type
|
||||
value_type: string
|
||||
default_value: all
|
||||
description: Filter by type (application|service|all)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
command: docker template scaffold
|
||||
short: Choose an application template or service template(s) and scaffold a new project
|
||||
long: Choose an application template or service template(s) and scaffold a new project
|
||||
usage: docker template scaffold application [<alias=service>...] OR scaffold [alias=]service
|
||||
[<[alias=]service>...]
|
||||
pname: docker template
|
||||
plink: docker_template.yaml
|
||||
options:
|
||||
- option: name
|
||||
value_type: string
|
||||
description: Application name
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: org
|
||||
value_type: string
|
||||
description: |
|
||||
Deploy to a specific organization / docker hub user (if not specified, it will use your current hub login)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: path
|
||||
value_type: string
|
||||
description: Deploy to a specific path
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: platform
|
||||
value_type: string
|
||||
default_value: linux
|
||||
description: Target platform (linux|windows)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: server
|
||||
value_type: string
|
||||
description: Deploy to a specific registry server (host[:port])
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
- option: set
|
||||
shorthand: s
|
||||
value_type: stringArray
|
||||
default_value: '[]'
|
||||
description: Override parameters values (service.name=value)
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
examples: "docker template scaffold react-java-mysql -s back.java=10 -s front.externalPort=80
|
||||
\ndocker template scaffold react-java-mysql java=back reactjs=front -s reactjs.externalPort=80
|
||||
\ndocker template scaffold back=spring front=react -s back.externalPort=9000 \ndocker
|
||||
template scaffold react-java-mysql --server=myregistry:5000 --org=myorg"
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -0,0 +1,12 @@
|
|||
command: docker template version
|
||||
short: Print version information
|
||||
long: Print version information
|
||||
usage: docker template version
|
||||
pname: docker template
|
||||
plink: docker_template.yaml
|
||||
deprecated: false
|
||||
experimental: false
|
||||
experimentalcli: false
|
||||
kubernetes: false
|
||||
swarm: false
|
||||
|
|
@ -866,6 +866,24 @@ reference:
|
|||
title: docker system prune
|
||||
- path: /engine/reference/commandline/tag/
|
||||
title: docker tag
|
||||
- sectiontitle: docker template *
|
||||
section:
|
||||
- path: /engine/reference/commandline/template/
|
||||
title: docker template
|
||||
- path: /engine/reference/commandline/template_config/
|
||||
title: docker template config
|
||||
- path: /engine/reference/commandline/template_config_set/
|
||||
title: docker template config set
|
||||
- path: /engine/reference/commandline/template_config_view/
|
||||
title: docker template config view
|
||||
- path: /engine/reference/commandline/template_inspect/
|
||||
title: docker template inspect
|
||||
- path: /engine/reference/commandline/template_list/
|
||||
title: docker template list
|
||||
- path: /engine/reference/commandline/template_scaffold/
|
||||
title: docker template scaffold
|
||||
- path: /engine/reference/commandline/template_version/
|
||||
title: docker template version
|
||||
- path: /engine/reference/commandline/top/
|
||||
title: docker top
|
||||
- sectiontitle: docker trust *
|
||||
|
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template
|
||||
title: docker template
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_config
|
||||
title: docker template config
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_config_set
|
||||
title: docker template config set
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_config_view
|
||||
title: docker template config view
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_inspect
|
||||
title: docker template inspect
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_list
|
||||
title: docker template list
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_scaffold
|
||||
title: docker template scaffold
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
|
@ -0,0 +1,13 @@
|
|||
---
|
||||
datafolder: application-template
|
||||
datafile: docker_template_version
|
||||
title: docker template version
|
||||
---
|
||||
<!--
|
||||
Sorry, but the contents of this page are automatically generated from
|
||||
Docker's source code. If you want to suggest a change to the text that appears
|
||||
here, you'll need to open a ticket in the documentation repository:
|
||||
|
||||
https://github.com/docker/docker.github.io/issues/new
|
||||
-->
|
||||
{% include cli.md datafolder=page.datafolder datafile=page.datafile %}
|
Loading…
Reference in New Issue