Add assemble reference docs

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2019-05-09 17:00:17 -07:00 committed by Maria Bermudez
parent 3ae1f1a10f
commit ef7f63dd77
25 changed files with 701 additions and 0 deletions

View File

@ -0,0 +1,64 @@
command: docker assemble
short: assemble is a high-level build tool
long: assemble is a high-level build tool
pname: docker
plink: docker.yaml
cname:
- docker assemble backend
- docker assemble build
- docker assemble version
clink:
- docker_assemble_backend.yaml
- docker_assemble_build.yaml
- docker_assemble_version.yaml
options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlscacert
value_type: string
description: |
specify CA certificate to use when validating the backend service's TLS certificate
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlscert
value_type: string
description: |
specify client certificate to use when connecting to backend service
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlskey
value_type: string
description: specify client key to use when connecting to backend service
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tlsservername
value_type: string
description: |
override server name for validation of the backend service's TLS certificate
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,35 @@
command: docker assemble backend
short: Manage build backend service
long: Manage build backend service
pname: docker assemble
plink: docker_assemble.yaml
cname:
- docker assemble backend cache
- docker assemble backend image
- docker assemble backend info
- docker assemble backend logs
- docker assemble backend start
- docker assemble backend stop
clink:
- docker_assemble_backend_cache.yaml
- docker_assemble_backend_image.yaml
- docker_assemble_backend_info.yaml
- docker_assemble_backend_logs.yaml
- docker_assemble_backend_start.yaml
- docker_assemble_backend_stop.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,27 @@
command: docker assemble backend cache
short: Manage build cache
long: Manage build cache
pname: docker assemble backend
plink: docker_assemble_backend.yaml
cname:
- docker assemble backend cache purge
- docker assemble backend cache usage
clink:
- docker_assemble_backend_cache_purge.yaml
- docker_assemble_backend_cache_usage.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,22 @@
command: docker assemble backend cache purge
short: Purge build cache
long: Purge build cache
usage: docker assemble backend cache purge
pname: docker assemble backend cache
plink: docker_assemble_backend_cache.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,22 @@
command: docker assemble backend cache usage
short: Show build cache contents
long: Show build cache contents
usage: docker assemble backend cache usage
pname: docker assemble backend cache
plink: docker_assemble_backend_cache.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,31 @@
command: docker assemble backend image
short: Print image to be used as backend
long: |-
Print image to be used as backend.
This can be useful to do:
docker save -o assemble-backend.tar $(docker assemble backend image)
In order to transport "assemble-backend.tar" to an offline system and:
docker load < assemble-backend.tar
usage: docker assemble backend image
pname: docker assemble backend
plink: docker_assemble_backend.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,22 @@
command: docker assemble backend info
short: Print information about build backend service
long: Print information about build backend service
usage: docker assemble backend info
pname: docker assemble backend
plink: docker_assemble_backend.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,32 @@
command: docker assemble backend logs
short: Show logs for build backend service
long: Show logs for build backend service
usage: docker assemble backend logs
pname: docker assemble backend
plink: docker_assemble_backend.yaml
options:
- option: follow
value_type: bool
default_value: "false"
description: follow log output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,60 @@
command: docker assemble backend start
short: Start build backend service
long: Start build backend service
usage: docker assemble backend start
pname: docker assemble backend
plink: docker_assemble_backend.yaml
options:
- option: allow-host-port
value_type: uintSlice
default_value: '[5000]'
description: |
allow the backend to access a host port by starting a proxy container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: cache-volume
value_type: string
description: |
named volume to use as build cache (default "docker-assemble-backend-cache-root" if it exists, otherwise an anonymous volume)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: host-port
value_type: uint16
default_value: "0"
description: host port to expose build service (0 is a random port)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: image
value_type: string
default_value: scratch
description: image to use
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,32 @@
command: docker assemble backend stop
short: Stop build backend service
long: Stop build backend service
usage: docker assemble backend stop
pname: docker assemble backend
plink: docker_assemble_backend.yaml
options:
- option: keep
value_type: bool
default_value: "false"
description: stop but don't destroy the container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,150 @@
command: docker assemble build
short: Build a project into a container
long: Build a project into a container
usage: docker assemble build [PATH]
pname: docker assemble
plink: docker_assemble.yaml
options:
- option: debug-dump-config
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug-dump-image
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug-dump-llb
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: debug-skip-build
value_type: bool
default_value: "false"
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: frontend
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: frontend-devel
value_type: string
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: label
value_type: stringArray
default_value: '[]'
description: label to write into the image as `KEY=VALUE`
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: name
value_type: string
description: |
build image with repository `NAME` (default taken from project metadata)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: namespace
value_type: string
description: |
build image within repository `NAMESPACE` (default no namespace)
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: option
shorthand: o
value_type: stringArray
default_value: '[]'
description: set an option as `OPTION=VALUE`
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: port
value_type: stringArray
default_value: '[]'
description: port to expose from container
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: progress
value_type: string
default_value: auto
description: |
set type of progress (auto, plain, tty). Use plain to show container output
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: push
value_type: bool
default_value: "false"
description: push result to registry, not local image store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: push-insecure
value_type: bool
default_value: "false"
description: |
push result to insecure (http) registry, not local image store
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
- option: tag
value_type: string
description: |
tag image with `TAG` (default taken from project metadata or "latest")
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -0,0 +1,22 @@
command: docker assemble version
short: Print the version number of docker assemble
long: Print the version number of docker assemble
usage: docker assemble version
pname: docker assemble
plink: docker_assemble.yaml
inherited_options:
- option: addr
value_type: string
default_value: docker-container://docker-assemble-backend-root
description: backend address
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false
deprecated: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false

View File

@ -544,6 +544,32 @@ reference:
title: Use the Docker command line
- path: /engine/reference/commandline/docker/
title: docker (base command)
- sectiontitle: docker assemble *
section:
- path: /engine/reference/commandline/assemble/
title: docker assemble
- path: /engine/reference/commandline/assemble_backend/
title: docker assemble backend
- path: /engine/reference/commandline/assemble_backend_cache/
title: docker assemble backend cache
- path: /engine/reference/commandline/assemble_backend_cache_purge/
title: docker assemble backend cache purge
- path: /engine/reference/commandline/assemble_backend_cache_usage/
title: docker assemble backend cache usage
- path: /engine/reference/commandline/assemble_backend_image/
title: docker assemble backend image
- path: /engine/reference/commandline/assemble_backend_info/
title: docker assemble backend info
- path: /engine/reference/commandline/assemble_backend_logs/
title: docker assemble backend logs
- path: /engine/reference/commandline/assemble_backend_start/
title: docker assemble backend start
- path: /engine/reference/commandline/assemble_backend_stop/
title: docker assemble backend stop
- path: /engine/reference/commandline/assemble_build/
title: docker assemble build
- path: /engine/reference/commandline/assemble_version/
title: docker assemble version
- path: /engine/reference/commandline/attach/
title: docker attach
- path: /engine/reference/commandline/build/

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble
title: docker assemble
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend
title: docker assemble backend
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_cache
title: docker assemble backend cache
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_cache_purge
title: docker assemble backend cache purge
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_cache_usage
title: docker assemble backend cache usage
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_image
title: docker assemble backend image
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_info
title: docker assemble backend info
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_logs
title: docker assemble backend logs
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_start
title: docker assemble backend start
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_backend_stop
title: docker assemble backend stop
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_build
title: docker assemble build
---
<!--
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 %}

View File

@ -0,0 +1,13 @@
---
datafolder: assemble
datafile: docker_assemble_version
title: docker assemble 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 %}