docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Clarified Windows filepath and added syntax highlighting

This commit is contained in:
Steven Follis 2019-07-01 13:34:47 -04:00
parent dd2e0ee9b9
commit 09223529e7
1 changed files with 36 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
app-template/working-with-template.md
View File

@ -35,7 +35,7 @@ A service template provides the description required by Docker Template to scaff
1. `/run/configuration`, a JSON file which contains all settings such as parameters, image name, etc. For example: 1. `/run/configuration`, a JSON file which contains all settings such as parameters, image name, etc. For example:
``` ```json
{ {
"parameters": { "parameters": {
"externalPort": "80", "externalPort": "80",
@ -53,7 +53,7 @@ To create a basic service template, you need to create two files — a dockerfil
`docker-compose.yaml` `docker-compose.yaml`
``` ```yaml
version: "3.6" version: "3.6"
services: services:
mysql: mysql:
@ -62,7 +62,7 @@ services:
`Dockerfile` `Dockerfile`
``` ```conf
FROM alpine FROM alpine
COPY docker-compose.yaml . COPY docker-compose.yaml .
CMD cp docker-compose.yaml /project/ CMD cp docker-compose.yaml /project/
@ -80,7 +80,7 @@ Services that generate a template using code must contain the following files th
Here’s an example of a simple NodeJS service: Here’s an example of a simple NodeJS service:
``` ```bash
my-service my-service
├── Dockerfile # The Dockerfile of the service template ├── Dockerfile # The Dockerfile of the service template
└── assets └── assets
@ -92,7 +92,7 @@ The NodeJS service contains the following files:
`my-service/Dockerfile` `my-service/Dockerfile`
``` ```conf
FROM alpine FROM alpine
COPY assets /assets COPY assets /assets
CMD ["cp", "/assets", "/project"] CMD ["cp", "/assets", "/project"]
@ -103,7 +103,7 @@ COPY assets /assets
`my-service/assets/docker-compose.yaml` `my-service/assets/docker-compose.yaml`
{% raw %} {% raw %}
``` ```yaml
version: "3.6" version: "3.6"
services: services:
{{ .Name }}: {{ .Name }}:
@ -115,7 +115,7 @@ services:
`my-service/assets/Dockerfile` `my-service/assets/Dockerfile`
``` ```conf
FROM NODE:9 FROM NODE:9
WORKDIR /app WORKDIR /app
COPY package.json . COPY package.json .
@ -128,7 +128,7 @@ CMD ["yarn", "run", "start"]
The next step is to build and push the service template image to a remote repository by running the following command: The next step is to build and push the service template image to a remote repository by running the following command:
``` ```bash
cd [...]/my-service cd [...]/my-service
docker build -t org/my-service . docker build -t org/my-service .
docker push org/my-service docker push org/my-service
@ -136,7 +136,7 @@ docker push org/my-service
To build and push the image to an instance of Docker Trusted Registry(DTR), or to an external registry, specify the name of the repository: To build and push the image to an instance of Docker Trusted Registry(DTR), or to an external registry, specify the name of the repository:
``` ```bash
cd [...]/my-service cd [...]/my-service
docker build -t myrepo:5000/my-service . docker build -t myrepo:5000/my-service .
docker push myrepo:5000/my-service docker push myrepo:5000/my-service
@ -151,7 +151,7 @@ Of all the available service and application definitions, Docker Template has ac
Here is an example of the Express service definition: Here is an example of the Express service definition:
``` ```yaml
- apiVersion: v1alpha1 # constant - apiVersion: v1alpha1 # constant
kind: ServiceTemplate # constant kind: ServiceTemplate # constant
metadata: metadata:
@ -180,7 +180,7 @@ To customize a service, you need to complete the following tasks:
Add the parameters available to the application. The following example adds the NodeJS version and the external port: Add the parameters available to the application. The following example adds the NodeJS version and the external port:
``` ```yaml
- [...] - [...]
spec: spec:
[...] [...]
@ -209,7 +209,7 @@ When you run the service template container, a volume is mounted making the serv
The file matches the following go struct: The file matches the following go struct:
``` ```golang
type TemplateContext struct { type TemplateContext struct {
ServiceID string `json:"serviceId,omitempty"` ServiceID string `json:"serviceId,omitempty"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
@ -224,7 +224,7 @@ type TemplateContext struct {
Where `ConfiguredService` is: Where `ConfiguredService` is:
``` ```go
type ConfiguredService struct { type ConfiguredService struct {
ID string `json:"serviceId,omitempty"` ID string `json:"serviceId,omitempty"`
Name string `json:"name,omitempty"` Name string `json:"name,omitempty"`
@ -236,7 +236,7 @@ You can then use the file to obtain values for the parameters and use this infor
To use the `interpolator` image, update `my-service/Dockerfile` to use the following Dockerfile: To use the `interpolator` image, update `my-service/Dockerfile` to use the following Dockerfile:
``` ```conf
FROM dockertemplate/interpolator:v0.0.3-beta1 FROM dockertemplate/interpolator:v0.0.3-beta1
COPY assets . COPY assets .
``` ```
@ -245,7 +245,7 @@ COPY assets .
This places the interpolator image in the `/assets` folder and copies the folder to the target `/project` folder. If you prefer to do this manually, use a Dockerfile instead: This places the interpolator image in the `/assets` folder and copies the folder to the target `/project` folder. If you prefer to do this manually, use a Dockerfile instead:
``` ```conf
WORKDIR /assets WORKDIR /assets
CMD ["/interpolator", "-config", "/run/configuration", "-source", "/assets", "-destination", "/project"] CMD ["/interpolator", "-config", "/run/configuration", "-source", "/assets", "-destination", "/project"]
``` ```
@ -270,7 +270,7 @@ Create a local repository file called `library.yaml` anywhere on your local driv
`library.yaml` `library.yaml`
``` ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1
generated: "2018-06-13T09:24:07.392654524Z" generated: "2018-06-13T09:24:07.392654524Z"
kind: RepositoryContent kind: RepositoryContent
@ -291,7 +291,7 @@ Now that you have created a local repository and added service definitions to it
1. Edit `~/.docker/dockertemplate/preferences.yaml` as follows: 1. Edit `~/.docker/dockertemplate/preferences.yaml` as follows:
``` ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1
channel: master channel: master
kind: Preferences kind: Preferences
@ -302,7 +302,7 @@ repositories:
2. Add your local repository: 2. Add your local repository:
``` ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1
channel: master channel: master
kind: Preferences kind: Preferences
@ -313,6 +313,13 @@ repositories:
url: https://docker-application-template.s3.amazonaws.com/master/library.yaml url: https://docker-application-template.s3.amazonaws.com/master/library.yaml
``` ```
When configuring a local repository on Windows, the `url` structure is slightly different:
```yaml
- name: custom-services
url: file://c:/path/to/my/library.yaml
```
After updating the `preferences.yaml` file, run `docker template ls` or restart the Application Designer and select **Custom application**. The new service should now be visible in the list of available services. After updating the `preferences.yaml` file, run `docker template ls` or restart the Application Designer and select **Custom application**. The new service should now be visible in the list of available services.
### Share custom service templates ### Share custom service templates
@ -343,7 +350,7 @@ Before you create an application template definition, you must create a reposito
For example, to create an Express and MySQL application, the application definition must be similar to the following yaml file: For example, to create an Express and MySQL application, the application definition must be similar to the following yaml file:
``` ```yaml
apiVersion: v1alpha1 #constant apiVersion: v1alpha1 #constant
kind: ApplicationTemplate #constant kind: ApplicationTemplate #constant
metadata: metadata:
@ -366,7 +373,7 @@ Create a local repository file called `library.yaml` anywhere on your local driv
`library.yaml` `library.yaml`
``` ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1
generated: "2018-06-13T09:24:07.392654524Z" generated: "2018-06-13T09:24:07.392654524Z"
kind: RepositoryContent kind: RepositoryContent
@ -391,7 +398,7 @@ Now that you have created a local repository and added application definitions,
1. Edit `~/.docker/dockertemplate/preferences.yaml` as follows: 1. Edit `~/.docker/dockertemplate/preferences.yaml` as follows:
``` ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1
channel: master channel: master
kind: Preferences kind: Preferences
@ -402,7 +409,7 @@ repositories:
2. Add your local repository: 2. Add your local repository:
``` ```yaml
apiVersion: v1alpha1 apiVersion: v1alpha1
channel: master channel: master
kind: Preferences kind: Preferences
@ -413,6 +420,13 @@ repositories:
url: https://docker-application-template.s3.amazonaws.com/master/library.yaml url: https://docker-application-template.s3.amazonaws.com/master/library.yaml
``` ```
When configuring a local repository on Windows, the `url` structure is slightly different:
```yaml
- name: custom-services
url: file://c:/path/to/my/library.yaml
```
After updating the `preferences.yaml` file, run `docker template ls` or restart the Application Designer and select **Custom application**. The new template should now be visible in the list of available templates. After updating the `preferences.yaml` file, run `docker template ls` or restart the Application Designer and select **Custom application**. The new template should now be visible in the list of available templates.
### Share the custom application template ### Share the custom application template