Skip to content

Commit b688ca7

Browse files
LucasRoesleralexellis
authored andcommitted
Improve wording of readonly_root_filesystem reference docs
Signed-off-by: Lucas Roesler <[email protected]>
1 parent e46818b commit b688ca7

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

docs/reference/yaml.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ This an optional boolean field, set to `false` by default.
6767

6868
The `build_options` field can be used to you to pass a list of [Docker build arguments](https://docs.docker.com/engine/reference/commandline/build/#set-build-time-variables---build-arg) to the build process. When the language template supports it, this allows you to customize the build without modifying the underlying template.
6969

70-
For example, the [official python3 language template](https://github.com/openfaas/templates/blob/master/template/python3/Dockerfile) allows passing additional Alpine `apk` packages to be installed during build process. To install the [`ca-certificates`](https://pkgs.alpinelinux.org/package/edge/main/x86_64/ca-certificates) package for your `python3` function, you can specify
70+
For example, the [official python3 language template](https://github.com/openfaas/templates/blob/master/template/python3/Dockerfile) can be used to additional Alpine `apk` packages to be installed during build process. To install the [`ca-certificates`](https://pkgs.alpinelinux.org/package/edge/main/x86_64/ca-certificates) package for your `python3` function, you can specify
7171

7272
```yaml
7373
build_options:
@@ -129,12 +129,14 @@ secrets:
129129

130130
#### Function: Read-Only Root Filesystem
131131

132-
The `readonly_root_filesystem` indicates that the function file system will be set to read-only except for a scratch/temporary folder `/tmp`. This prevents the function from writing to or modifying the filesystem (e.g. system files). This is used to provide stricter security for your functions. You can set this value as a boolean:
132+
The `readonly_root_filesystem` indicates that the function file system will be set to read-only except for the temporary folder `/tmp`. This prevents the function from writing to or modifying the filesystem (e.g. system files). This is used to provide tighter security for your functions. You can set this value as a boolean:
133133

134134
```yaml
135135
readonly_root_filesystem: true
136136
```
137137

138+
This an optional boolean field, set to `false` by default.
139+
138140
#### Function: Constraints
139141

140142
Constraints are passed directly to the underlying container orchestrator. They allow you to pin a function to certain host or type of host.

0 commit comments

Comments
 (0)