summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authordanielgruesso <dgruesso@gitlab.com>2018-12-19 16:55:26 -0500
committerdanielgruesso <dgruesso@gitlab.com>2018-12-19 16:55:26 -0500
commitcb8dc81fcbf8c0c5ac348848b2b6ed54dc30e188 (patch)
treed156418276f67e8a28a78cacd34498693a01f06b /doc/user
parentdc94a774f80098bd6f5b9fc1537f2d1f2b9ee99f (diff)
downloadgitlab-ce-cb8dc81fcbf8c0c5ac348848b2b6ed54dc30e188.tar.gz
Update table formatting
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/project/clusters/serverless/index.md48
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/user/project/clusters/serverless/index.md b/doc/user/project/clusters/serverless/index.md
index 77443b86908..5f3af5a5748 100644
--- a/doc/user/project/clusters/serverless/index.md
+++ b/doc/user/project/clusters/serverless/index.md
@@ -86,7 +86,7 @@ At launch, the following runtimes are offered:
You can locate the runtimes souce at https://gitlab.com/triggermesh/runtimes
-In order to deploy functions to your Knative instance, the following templates must be present:
+In order to deploy functions to your Knative instance, the following files must be present:
1. `gitlab-ci.yml`: This template allows to define the stage, environment, and
image to be used for your functions. It must be included at the root of your repository:
@@ -133,35 +133,35 @@ In order to deploy functions to your Knative instance, the following templates m
FUNCTION: echo
```
- This `serverless.yaml` sample contains three section with distinct parameters:
+The `serverless.yaml` file contains three section with distinct parameters:
- ### `service`
-
- | Parameter | Description |
- |-----------|-------------|
- | `service` | Name for the Knative service which will serve the function |
- | `description` | A short description of the `service` |
-
+### `service`
- ### `provider`
+| Parameter | Description |
+|-----------|-------------|
+| `service` | Name for the Knative service which will serve the function |
+| `description` | A short description of the `service` |
- | Parameter | Description |
- |-----------|-------------|
- | `name` | Indicates which provider is used to execute `serverless.yaml` file. In this case the TriggerMesh `tm` CLI |
- | `registry-secret` | Indicates which registry will be used to store docker images |
- | `environment` | Includes the environment variables to be passed as part of function execution, where `FOO` is the variable name and `BAR` are he variable contents. You may replace this with you own variables |
- ### `functions`
+### `provider`
- In the provided sample, line no. 11 contains the function name (in this sample, `"echo"`). The subsequent lines contain the function attributes:
+| Parameter | Description |
+|-----------|-------------|
+| `name` | Indicates which provider is used to execute `serverless.yaml` file. In this case the TriggerMesh `tm` CLI |
+| `registry-secret` | Indicates which registry will be used to store docker images |
+| `environment` | Includes the environment variables to be passed as part of function execution, where `FOO` is the variable name and `BAR` are he variable contents. You may replace this with you own variables |
- | Parameter | Description |
- |-----------|-------------|
- | `handler` | Reference to function file name (in the sample both the function name and the handler are the same) |
- | `runtime` | Reference to the runtime to be used to execute the function |
- | `description` | A short description of the function |
- | `buildargs` | Pointer to the function file in the repo (in the sample the function is located in the `echo` directory) |
- | `environment` | Pointer to the function file name (in the sample the function is called `echo`) |
+### `functions`
+
+ In the provided sample, line no. 11 contains the function name (in this sample, `"echo"`). The subsequent lines contain the function attributes:
+
+| Parameter | Description |
+|-----------|-------------|
+| `handler` | Reference to function file name (in the sample both the function name and the handler are the same) |
+| `runtime` | Reference to the runtime to be used to execute the function |
+| `description` | A short description of the function |
+| `buildargs` | Pointer to the function file in the repo (in the sample the function is located in the `echo` directory) |
+| `environment` | Sets an environment variable on function invokation. Pointer to the function file name (in the sample the function is called `echo`) |
After the `gitlab-ci.yml` template has been added and the `serverless.yaml` file has been
created, each function must be defined as a single file in your repository. Committing a