Skip to content

Commit e8f575d

Browse files
committed
feature/pipeline: Update documentation
Signed-off-by: Alexey Gladkov <[email protected]>
1 parent 77c3a41 commit e8f575d

File tree

1 file changed

+19
-6
lines changed

1 file changed

+19
-6
lines changed

features/pipeline/README.md

+19-6
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,29 @@ cmdline. The sequence of steps is specified in the `pipeline=...` parameter.
2020
- `wait-resume` is waiting for the resume attempt to complete. This step is
2121
necessary to avoid race conditions between disk initialization for resume and
2222
pipeline.
23+
- `ping` allows to wait until the network address starts pinging.
2324

2425
## Boot parameters
2526

26-
- `pipeline=name[,name1][,name2]` - the main parameter that determines the order
27+
- `pipeline=NAME[,NAME1][,NAME2]` - the main parameter that determines the order
2728
in which pipe elements are called.
28-
- `getimage` specifies an URL to fetch and mount.
29-
- `mountfs` specifies a file to mount.
30-
- `overlayfs` defines a list of elements to be combined.
31-
- `waitdev` describes the local device to wait. The format of this parameter is
32-
the same as `root=`.
29+
- `getimage=URL` specifies an URL to fetch and mount. If a file from a local
30+
directory is to be retrieved, the `file://` scheme must be used.
31+
- `mountfs=FILE` specifies a file to mount.
32+
- `mountfs-opts=MOUNT-OPTIONS` comma (`,`) separated mount options.
33+
- `overlayfs=LAYERS` defines a list of elements to be combined.
34+
- `waitdev=DEVSPEC` describes the local device to wait. The format of this
35+
parameter is the same as `root=`.
36+
- `ping=[OPTIONS:][ADDRESS]` The comma (`,`) separated options include: `v4`,
37+
`v6` - determines the ip version; `iter=NUMBER` specifies the number of
38+
attempts to ping the address; `waitfor` if specified, the wait will be
39+
forever (this is the default behavior). The address can be an ip address or a
40+
hostname, or `%gateway`, which stands for the default gateway address.
41+
The default ADDRESS is `%gateway`.
42+
- `pipe-retry=NUMBER` determines how many times a certain step can fail
43+
(single parameter).
44+
- `pipe-verify-sign=NAME[,NAME1][,NAME2]` defines a list of steps where
45+
signature verification should be enabled (single parameter).
3346

3447
The separator between the elements is a comma (`,`).
3548

0 commit comments

Comments
 (0)