Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit c5a5c00

Browse files
committedNov 17, 2020
Document publish command
Documents publish command and its intended usage vs the build and up commands. Ref: #841 Signed-off-by: Alex Ellis (OpenFaaS Ltd) <alexellis2@gmail.com>
1 parent d510aee commit c5a5c00

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed
 

‎docs/cli/build.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,23 @@ faas-cli build --help
1010

1111
* Build images with Docker
1212

13-
The `faas-cli build` command builds a Docker image into your local Docker library, which can then be used locally or pushed into a remote Docker registry. Each change of your function requires a new `faas-cli build` command to be issued.
13+
The `faas-cli build` command builds a Docker image into your local Docker library, which can then be used locally or pushed into a remote Docker registry. Each change of your function requires a new `faas-cli build` command to be issued.
14+
15+
* Publish multi-arch images
16+
17+
If you need to target a range of CPU architectures such as 64-bit ARM and Raspberry Pi, then take a look at the new publish command.
18+
19+
This is not designed to replace the `faas-cli build` or `faas-cli up` workflow for local development, but to be used from CI to publish images for multiple architectures.
20+
21+
The publish command makes use of the Docker buildx add-on, which will need to be installed. A suitable multi-arch template will also be required such as [golang-middleware](https://github.com/openfaas/golang-http-template).
1422

1523
* How to do CI/CD
1624

17-
When it comes to continuous integration and delivery you can use the `faas-cli` tool on your build server to build and deploy your code using the built-in commands.
25+
When it comes to continuous integration and delivery you can use the `faas-cli` tool on your build server to build and deploy your code using the built-in commands.
1826

19-
* Generate a Dockerfile with `--shrinkwrap`
27+
* Generate a Dockerfile and Docker build context with `--shrinkwrap`
2028

21-
If you are using an alternative container image builder or are automating the `faas-cli` then you can use the `--shrinkwrap` flag which will produce a folder named `./build/function-name` with a Dockerfile. This bundle can be used with any container builder.
29+
If you are using an alternative container image builder such as [kaniko](https://github.com/GoogleContainerTools/kaniko) or are automating the `faas-cli` then you can use the `--shrinkwrap` flag which will produce a folder named `./build/function-name` with a Dockerfile. This bundle can be used with any container builder.
2230

2331
## 1.0 Apply build options
2432

0 commit comments

Comments
 (0)