mirror of
https://github.com/balena-io/balena-cli.git
synced 2024-12-30 02:28:51 +00:00
Add documentation for new resin build and resin deploy commands
Change-type: patch Signed-off-by: Cameron Diver <cameron@resin.io>
This commit is contained in:
parent
04c2333a54
commit
39b171fd2a
@ -97,6 +97,13 @@
|
|||||||
"files": [
|
"files": [
|
||||||
"lib/actions/local/index.coffee"
|
"lib/actions/local/index.coffee"
|
||||||
]
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"title": "Deploy",
|
||||||
|
"files": [
|
||||||
|
"lib/actions/build.coffee",
|
||||||
|
"lib/actions/deploy.coffee"
|
||||||
|
]
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
|
125
doc/cli.markdown
125
doc/cli.markdown
@ -120,6 +120,11 @@ Now you have access to all the commands referenced below.
|
|||||||
- [local push [deviceIp]](#local-push-deviceip-)
|
- [local push [deviceIp]](#local-push-deviceip-)
|
||||||
- [local stop [deviceIp]](#local-stop-deviceip-)
|
- [local stop [deviceIp]](#local-stop-deviceip-)
|
||||||
|
|
||||||
|
- Deploy
|
||||||
|
|
||||||
|
- [build [source]](#build-source-)
|
||||||
|
- [deploy <appName> [image]](#deploy-60-appname-62-image-)
|
||||||
|
|
||||||
# Application
|
# Application
|
||||||
|
|
||||||
## app create <name>
|
## app create <name>
|
||||||
@ -1255,3 +1260,123 @@ stop all containers
|
|||||||
|
|
||||||
name of container to stop
|
name of container to stop
|
||||||
|
|
||||||
|
# Deploy
|
||||||
|
|
||||||
|
## build [source]
|
||||||
|
|
||||||
|
Use this command to build a container with a provided docker daemon.
|
||||||
|
|
||||||
|
You must provide either an application or a device-type/architecture
|
||||||
|
pair to use the resin Dockerfile pre-processor
|
||||||
|
(e.g. Dockerfile.template -> Dockerfile).
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
|
||||||
|
$ resin build
|
||||||
|
$ resin build ./source/
|
||||||
|
$ resin build --deviceType raspberrypi3 --arch armhf
|
||||||
|
$ resin build --application MyApp ./source/
|
||||||
|
$ resin build --docker '/var/run/docker.sock'
|
||||||
|
$ resin build --dockerHost my.docker.host --dockerPort 2376 --ca ca.pem --key key.pem --cert cert.pem
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
#### --arch, -A <arch>
|
||||||
|
|
||||||
|
The architecture to build for
|
||||||
|
|
||||||
|
#### --devicetype, -d <deviceType>
|
||||||
|
|
||||||
|
The type of device this build is for
|
||||||
|
|
||||||
|
#### --application, -a <application>
|
||||||
|
|
||||||
|
The target resin.io application this build is for
|
||||||
|
|
||||||
|
#### --docker, -P <docker>
|
||||||
|
|
||||||
|
Path to a local docker socket
|
||||||
|
|
||||||
|
#### --dockerHost, -h <dockerHost>
|
||||||
|
|
||||||
|
The address of the host containing the docker daemon
|
||||||
|
|
||||||
|
#### --dockerPort, -p <dockerPort>
|
||||||
|
|
||||||
|
The port on which the host docker daemon is listening
|
||||||
|
|
||||||
|
#### --ca <ca>
|
||||||
|
|
||||||
|
Docker host TLS certificate authority file
|
||||||
|
|
||||||
|
#### --cert <cert>
|
||||||
|
|
||||||
|
Docker host TLS certificate file
|
||||||
|
|
||||||
|
#### --key <key>
|
||||||
|
|
||||||
|
Docker host TLS key file
|
||||||
|
|
||||||
|
#### --tag, -t <tag>
|
||||||
|
|
||||||
|
The alias to the generated image
|
||||||
|
|
||||||
|
#### --nocache
|
||||||
|
|
||||||
|
Don't use docker layer caching when building
|
||||||
|
|
||||||
|
## deploy <appName> [image]
|
||||||
|
|
||||||
|
Use this command to deploy and optionally build an image to an application.
|
||||||
|
|
||||||
|
Usage: deploy <appName> ([image] | --build [--source build-dir])
|
||||||
|
|
||||||
|
Note: If building with this command, all options supported by `resin build`
|
||||||
|
are also supported with this command.
|
||||||
|
|
||||||
|
Examples:
|
||||||
|
$ resin deploy myApp --build --source myBuildDir/
|
||||||
|
$ resin deploy myApp myApp/myImage
|
||||||
|
|
||||||
|
### Options
|
||||||
|
|
||||||
|
#### --build, -b
|
||||||
|
|
||||||
|
Build image then deploy
|
||||||
|
|
||||||
|
#### --source, -s <source>
|
||||||
|
|
||||||
|
The source directory to use when building the image
|
||||||
|
|
||||||
|
#### --docker, -P <docker>
|
||||||
|
|
||||||
|
Path to a local docker socket
|
||||||
|
|
||||||
|
#### --dockerHost, -h <dockerHost>
|
||||||
|
|
||||||
|
The address of the host containing the docker daemon
|
||||||
|
|
||||||
|
#### --dockerPort, -p <dockerPort>
|
||||||
|
|
||||||
|
The port on which the host docker daemon is listening
|
||||||
|
|
||||||
|
#### --ca <ca>
|
||||||
|
|
||||||
|
Docker host TLS certificate authority file
|
||||||
|
|
||||||
|
#### --cert <cert>
|
||||||
|
|
||||||
|
Docker host TLS certificate file
|
||||||
|
|
||||||
|
#### --key <key>
|
||||||
|
|
||||||
|
Docker host TLS key file
|
||||||
|
|
||||||
|
#### --tag, -t <tag>
|
||||||
|
|
||||||
|
The alias to the generated image
|
||||||
|
|
||||||
|
#### --nocache
|
||||||
|
|
||||||
|
Don't use docker layer caching when building
|
||||||
|
|
||||||
|
@ -96,11 +96,11 @@ module.exports =
|
|||||||
Usage: deploy <appName> ([image] | --build [--source build-dir])
|
Usage: deploy <appName> ([image] | --build [--source build-dir])
|
||||||
|
|
||||||
Note: If building with this command, all options supported by `resin build`
|
Note: If building with this command, all options supported by `resin build`
|
||||||
are also support with this command.
|
are also supported with this command.
|
||||||
|
|
||||||
Examples:
|
Examples:
|
||||||
$ resin deploy myApp --build --source myBuildDir/
|
$ resin deploy myApp --build --source myBuildDir/
|
||||||
$ resin deploy myApp myApp/myImage
|
$ resin deploy myApp myApp/myImage
|
||||||
'''
|
'''
|
||||||
permission: 'user'
|
permission: 'user'
|
||||||
options: dockerUtils.appendOptions [
|
options: dockerUtils.appendOptions [
|
||||||
|
Loading…
Reference in New Issue
Block a user