github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

docs: add documentation for all file formats dokku uses

Browse Source 
Some files - those maintained by external organizations - have a very light treatment and solely point to the upstream documentation to reduce any issues creating examples/documentation for them that may differ in the future.

Closes #7315
This commit is contained in:
Jose Diaz-Gonzalez
2024-12-07 14:46:52 -05:00
parent 3bb9bc1e12
commit 8f3f6c49f1
9 changed files with 250 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/appendices/file-formats/lambda-yml.md Normal file
View File

@@ -0,0 +1,16 @@
# lambda.yml
The `lambda.yml` file is used to configure a Lambda application.
```yaml
---
build_image: mlupin/docker-lambda:dotnetcore3.1-build
builder: dotnet
run_image: mlupin/docker-lambda:dotnetcore3.1
```
## Fields
`build_image`: A docker image that is accessible by the docker daemon. The `build_image` should be based on an existing Lambda image - builders may fail if they cannot run within the specified `build_image`. The build will fail if the image is inaccessible by the docker daemon.
`builder`: The name of a builder. This may be used if multiple builders match and a specific builder is desired. If an invalid builder is specified, the build will fail.
`run_image`: A docker image that is accessible by the docker daemon. The `run_image` should be based on an existing Lambda image - built images may fail to start if they are not compatible with the produced artifact. The generation of the `run_image` will fail if the image is inaccessible by the docker daemon.