File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed
Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change @@ -131,3 +131,32 @@ conform to the following schema:
131131 Default _`opacity(30%) grayscale(100%)`_. Allows users to specify custom
132132 [CSS filters](https://developer.mozilla.org/en-US/docs/Web/CSS/filter) that are applied to the
133133 `background_image`.
134+
135+ ??? info "` user_data ` : [ ` value ` ] ( ../vars.md#value-schema ) "
136+
137+ This field is meant to store arbitrary metadata. Its value can be any type
138+ you can express in YAML, even a string. The data in this field is NOT
139+ exposed in the pipeline during runtime. You can reference the data using YAML
140+ anchors when setting your pipelines.
141+
142+ The main benefit of this field is having a way to preserve arbitrary data
143+ that will survive the `fly set-pipeline/get-pipeline` lifecycle. Any other
144+ top-level keys are not preserved by Concourse.
145+
146+ ??? example "Example: Arbitrary User Data"
147+
148+ You can set `user_data` to any value, like a map:
149+
150+ ```yaml
151+ user_data:
152+ team: SRE
153+ contact: sre@example.com
154+ labels:
155+ - prod
156+ ```
157+
158+ Or a string:
159+
160+ ```yaml
161+ user_data: This is my user data value
162+ ```
You can’t perform that action at this time.
0 commit comments