Skip to content

Commit 15e9412

Browse files
Martin Dekov (VMware)alexellis
authored andcommitted
Add template store and list explanation
Adding the new command faas-cli template store list and faas-cli template store pull commands to showcase how you can browse and download templates from the official repos of add your own repo with own official templates Signed-off-by: Martin Dekov (VMware) <[email protected]>
1 parent f6f6e02 commit 15e9412

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

docs/cli/templates.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -384,4 +384,29 @@ Type in `faas-cli new --list` and look for any languages ending in `-armhf`. You
384384

385385
For these platforms do the same as above and look for the `-arm64` suffix.
386386

387-
> It is easy to make your own templates so if you need to use this platform please convert one of the "regular" templates for your platform.
387+
> It is easy to make your own templates so if you need to use this platform please convert one of the "regular" templates for your platform.
388+
389+
## Template store
390+
391+
You can browse templates from our official store or create your own store and add your own official templates there.
392+
393+
To see what templates are available type `faas-cli template store list` and you should see the following in the terminal:
394+
```
395+
$ ./faas-cli template store list
396+
397+
NAME SOURCE DESCRIPTION
398+
csharp openfaas Official C# template
399+
dockerfile openfaas Official Dockerfile template
400+
go-armhf openfaas Official Golang armhf
401+
...
402+
node10-express-armhf openfaas-incubator NodeJS 10 Express armhf template
403+
node10-express openfaas-incubator NodeJS 10 Express template
404+
ruby-http openfaas-incubator Ruby 2.4 HTTP template
405+
...
406+
```
407+
408+
Choose one or more templates and pull them with the command `faas-cli template store pull node10-express ruby-http csharp` and your templates should be downloaded.
409+
410+
You can add your own store just by specifying the `--url` flag for both commands to pull and list your custom templates store.
411+
412+
> Note: The feature is in experimental stage and the verbs may change also the structure in which you keep your templates should follow the structure of the official store found [here](https://github.com/openfaas/store/blob/master/templates.json).

0 commit comments

Comments
 (0)