Skip to content

Commit 67ad16a

Browse files
authoredSep 18, 2019
Merge pull request kubernetes#18 from deads2k/must-gather-version
formalize what a must-gather image includes
2 parents f796b93 + 0df554c commit 67ad16a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed
 

‎must-gather.md

+8
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,14 @@ There are several special cases today.
105105
3. take a best guess to find a healthz endpoint and all sub-healthz endpoints
106106

107107

108+
### must-gather Images
109+
To provide your own must-gather image, it must....
110+
111+
1. Must have a zero-arg, executable file at `/usr/bin/gather` that does your default gathering
112+
2. Must produce data to be copied back at `/must-gather`. The data must not contain any sensitive data. We don't string PII information, only secret information.
113+
3. Must produce a text `/must-gather/version` that indicates the product (first line) and the version (second line, `major.minor.micro.qualifier`),
114+
so that programmatic analysis can be developed.
115+
108116
### User Stories [optional]
109117

110118
#### Story 1

0 commit comments

Comments
 (0)