@intentius/chant-lexicon-docker 0.124.98 → 0.124.99

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (241) hide show
  1. package/dist/codegen/docs-cli.d.ts +0 -1
  2. package/dist/codegen/docs.d.ts +0 -1
  3. package/dist/codegen/generate-cli.d.ts +0 -1
  4. package/dist/codegen/generate-compose.d.ts +0 -1
  5. package/dist/codegen/generate-dockerfile.d.ts +0 -1
  6. package/dist/codegen/generate.d.ts +0 -1
  7. package/dist/codegen/naming.d.ts +0 -1
  8. package/dist/codegen/package.d.ts +0 -1
  9. package/dist/codegen/patches.d.ts +0 -1
  10. package/dist/codegen/versions.d.ts +0 -1
  11. package/dist/compose-key.d.ts +0 -1
  12. package/dist/composites/catalog.d.ts +0 -1
  13. package/dist/composites/docker-otel-collector.d.ts +0 -1
  14. package/dist/composites/docker-web-service.d.ts +0 -1
  15. package/dist/composites/index.d.ts +0 -1
  16. package/dist/coverage.d.ts +0 -1
  17. package/dist/default-labels.d.ts +0 -1
  18. package/dist/detect.d.ts +0 -1
  19. package/dist/dockerfile-order.d.ts +0 -1
  20. package/dist/export-resources.d.ts +0 -1
  21. package/dist/generated/index.d.ts +0 -1
  22. package/dist/generated/runtime.d.ts +0 -1
  23. package/dist/import/adapter.d.ts +0 -1
  24. package/dist/import/adapter.js +4 -2
  25. package/dist/import/embedded.d.ts +0 -1
  26. package/dist/import/engine.d.ts +0 -1
  27. package/dist/import/generator.d.ts +9 -2
  28. package/dist/import/generator.js +23 -1
  29. package/dist/import/live-export.d.ts +0 -1
  30. package/dist/import/parser.d.ts +0 -1
  31. package/dist/import/testdata/tar.d.ts +0 -1
  32. package/dist/index.d.ts +0 -1
  33. package/dist/integrity.json +2 -2
  34. package/dist/interpolation.d.ts +0 -1
  35. package/dist/lint/audit-catalog.d.ts +0 -1
  36. package/dist/lint/audit-lineage.d.ts +0 -1
  37. package/dist/lint/post-synth/add-url-checksum.d.ts +0 -1
  38. package/dist/lint/post-synth/apt-no-recommends.d.ts +0 -1
  39. package/dist/lint/post-synth/apt-update-alone.d.ts +0 -1
  40. package/dist/lint/post-synth/cache-busting-copy.d.ts +0 -1
  41. package/dist/lint/post-synth/copy-from-stage.d.ts +0 -1
  42. package/dist/lint/post-synth/docker-helpers.d.ts +0 -1
  43. package/dist/lint/post-synth/index.d.ts +0 -1
  44. package/dist/lint/post-synth/no-latest-image.d.ts +0 -1
  45. package/dist/lint/post-synth/no-root-user.d.ts +0 -1
  46. package/dist/lint/post-synth/prefer-copy.d.ts +0 -1
  47. package/dist/lint/post-synth/relative-workdir.d.ts +0 -1
  48. package/dist/lint/post-synth/repeated-cmd.d.ts +0 -1
  49. package/dist/lint/post-synth/root-after-user.d.ts +0 -1
  50. package/dist/lint/post-synth/ssh-port-exposed.d.ts +0 -1
  51. package/dist/lint/post-synth/unused-global-arg.d.ts +0 -1
  52. package/dist/lint/post-synth/unused-volume.d.ts +0 -1
  53. package/dist/lint/rules/data/deprecated-images.d.ts +0 -1
  54. package/dist/lint/rules/data/known-base-images.d.ts +0 -1
  55. package/dist/lint/rules/index.d.ts +0 -1
  56. package/dist/lint/rules/no-latest-tag.d.ts +0 -1
  57. package/dist/lint/rules/per-kind-order.d.ts +0 -1
  58. package/dist/list-artifacts.d.ts +0 -1
  59. package/dist/lsp/completions.d.ts +0 -1
  60. package/dist/lsp/hover.d.ts +0 -1
  61. package/dist/manifest.json +1 -1
  62. package/dist/package-cli.d.ts +0 -1
  63. package/dist/plugin.d.ts +0 -1
  64. package/dist/serializer.d.ts +0 -1
  65. package/dist/spec/fetch-compose.d.ts +0 -1
  66. package/dist/spec/fetch-engine.d.ts +0 -1
  67. package/dist/spec/parse-compose.d.ts +0 -1
  68. package/dist/spec/parse-engine.d.ts +0 -1
  69. package/dist/validate-cli.d.ts +0 -1
  70. package/dist/validate.d.ts +0 -1
  71. package/dist/variables.d.ts +0 -1
  72. package/package.json +4 -5
  73. package/dist/codegen/docs-cli.d.ts.map +0 -1
  74. package/dist/codegen/docs.d.ts.map +0 -1
  75. package/dist/codegen/generate-cli.d.ts.map +0 -1
  76. package/dist/codegen/generate-compose.d.ts.map +0 -1
  77. package/dist/codegen/generate-dockerfile.d.ts.map +0 -1
  78. package/dist/codegen/generate.d.ts.map +0 -1
  79. package/dist/codegen/naming.d.ts.map +0 -1
  80. package/dist/codegen/package.d.ts.map +0 -1
  81. package/dist/codegen/patches.d.ts.map +0 -1
  82. package/dist/codegen/versions.d.ts.map +0 -1
  83. package/dist/compose-key.d.ts.map +0 -1
  84. package/dist/composites/catalog.d.ts.map +0 -1
  85. package/dist/composites/docker-otel-collector.d.ts.map +0 -1
  86. package/dist/composites/docker-web-service.d.ts.map +0 -1
  87. package/dist/composites/index.d.ts.map +0 -1
  88. package/dist/coverage.d.ts.map +0 -1
  89. package/dist/default-labels.d.ts.map +0 -1
  90. package/dist/detect.d.ts.map +0 -1
  91. package/dist/dockerfile-order.d.ts.map +0 -1
  92. package/dist/export-resources.d.ts.map +0 -1
  93. package/dist/generated/index.d.ts.map +0 -1
  94. package/dist/generated/runtime.d.ts.map +0 -1
  95. package/dist/import/adapter.d.ts.map +0 -1
  96. package/dist/import/embedded.d.ts.map +0 -1
  97. package/dist/import/engine.d.ts.map +0 -1
  98. package/dist/import/generator.d.ts.map +0 -1
  99. package/dist/import/live-export.d.ts.map +0 -1
  100. package/dist/import/parser.d.ts.map +0 -1
  101. package/dist/import/testdata/tar.d.ts.map +0 -1
  102. package/dist/index.d.ts.map +0 -1
  103. package/dist/interpolation.d.ts.map +0 -1
  104. package/dist/lint/audit-catalog.d.ts.map +0 -1
  105. package/dist/lint/audit-lineage.d.ts.map +0 -1
  106. package/dist/lint/post-synth/add-url-checksum.d.ts.map +0 -1
  107. package/dist/lint/post-synth/apt-no-recommends.d.ts.map +0 -1
  108. package/dist/lint/post-synth/apt-update-alone.d.ts.map +0 -1
  109. package/dist/lint/post-synth/cache-busting-copy.d.ts.map +0 -1
  110. package/dist/lint/post-synth/copy-from-stage.d.ts.map +0 -1
  111. package/dist/lint/post-synth/docker-helpers.d.ts.map +0 -1
  112. package/dist/lint/post-synth/index.d.ts.map +0 -1
  113. package/dist/lint/post-synth/no-latest-image.d.ts.map +0 -1
  114. package/dist/lint/post-synth/no-root-user.d.ts.map +0 -1
  115. package/dist/lint/post-synth/prefer-copy.d.ts.map +0 -1
  116. package/dist/lint/post-synth/relative-workdir.d.ts.map +0 -1
  117. package/dist/lint/post-synth/repeated-cmd.d.ts.map +0 -1
  118. package/dist/lint/post-synth/root-after-user.d.ts.map +0 -1
  119. package/dist/lint/post-synth/ssh-port-exposed.d.ts.map +0 -1
  120. package/dist/lint/post-synth/unused-global-arg.d.ts.map +0 -1
  121. package/dist/lint/post-synth/unused-volume.d.ts.map +0 -1
  122. package/dist/lint/rules/data/deprecated-images.d.ts.map +0 -1
  123. package/dist/lint/rules/data/known-base-images.d.ts.map +0 -1
  124. package/dist/lint/rules/index.d.ts.map +0 -1
  125. package/dist/lint/rules/no-latest-tag.d.ts.map +0 -1
  126. package/dist/lint/rules/per-kind-order.d.ts.map +0 -1
  127. package/dist/list-artifacts.d.ts.map +0 -1
  128. package/dist/lsp/completions.d.ts.map +0 -1
  129. package/dist/lsp/hover.d.ts.map +0 -1
  130. package/dist/package-cli.d.ts.map +0 -1
  131. package/dist/plugin.d.ts.map +0 -1
  132. package/dist/serializer.d.ts.map +0 -1
  133. package/dist/spec/fetch-compose.d.ts.map +0 -1
  134. package/dist/spec/fetch-engine.d.ts.map +0 -1
  135. package/dist/spec/parse-compose.d.ts.map +0 -1
  136. package/dist/spec/parse-engine.d.ts.map +0 -1
  137. package/dist/validate-cli.d.ts.map +0 -1
  138. package/dist/validate.d.ts.map +0 -1
  139. package/dist/variables.d.ts.map +0 -1
  140. package/src/codegen/__snapshots__/okf.test.ts.snap +0 -555
  141. package/src/codegen/docs-cli.ts +0 -10
  142. package/src/codegen/docs.ts +0 -171
  143. package/src/codegen/generate-cli.ts +0 -36
  144. package/src/codegen/generate-compose.ts +0 -21
  145. package/src/codegen/generate-dockerfile.ts +0 -21
  146. package/src/codegen/generate.test.ts +0 -115
  147. package/src/codegen/generate.ts +0 -258
  148. package/src/codegen/naming.test.ts +0 -81
  149. package/src/codegen/naming.ts +0 -54
  150. package/src/codegen/okf.test.ts +0 -36
  151. package/src/codegen/package.ts +0 -59
  152. package/src/codegen/patches.ts +0 -42
  153. package/src/codegen/versions.ts +0 -46
  154. package/src/compose-key.ts +0 -31
  155. package/src/composites/catalog.test.ts +0 -39
  156. package/src/composites/catalog.ts +0 -118
  157. package/src/composites/docker-otel-collector.ts +0 -83
  158. package/src/composites/docker-web-service.test.ts +0 -34
  159. package/src/composites/docker-web-service.ts +0 -75
  160. package/src/composites/index.ts +0 -9
  161. package/src/coverage.test.ts +0 -33
  162. package/src/coverage.ts +0 -54
  163. package/src/default-labels.test.ts +0 -85
  164. package/src/default-labels.ts +0 -72
  165. package/src/detect.ts +0 -7
  166. package/src/dockerfile-order.ts +0 -20
  167. package/src/docs-examples.test.ts +0 -141
  168. package/src/export-resources.ts +0 -90
  169. package/src/generated/index.d.ts +0 -407
  170. package/src/generated/index.ts +0 -410
  171. package/src/generated/runtime.ts +0 -4
  172. package/src/import/adapter.ts +0 -99
  173. package/src/import/embedded-live.test.ts +0 -250
  174. package/src/import/embedded.ts +0 -83
  175. package/src/import/engine.ts +0 -107
  176. package/src/import/generator.test.ts +0 -134
  177. package/src/import/generator.ts +0 -202
  178. package/src/import/live-export.test.ts +0 -271
  179. package/src/import/live-export.ts +0 -359
  180. package/src/import/parser.test.ts +0 -137
  181. package/src/import/parser.ts +0 -269
  182. package/src/import/roundtrip.test.ts +0 -257
  183. package/src/import/testdata/configs-secrets.yaml +0 -15
  184. package/src/import/testdata/full.yaml +0 -43
  185. package/src/import/testdata/names-and-fields.yaml +0 -44
  186. package/src/import/testdata/simple.yaml +0 -9
  187. package/src/import/testdata/tar.ts +0 -24
  188. package/src/import/testdata/webapp.yaml +0 -41
  189. package/src/index.ts +0 -32
  190. package/src/interpolation.test.ts +0 -41
  191. package/src/interpolation.ts +0 -76
  192. package/src/lint/audit-catalog.ts +0 -28
  193. package/src/lint/audit-lineage.ts +0 -48
  194. package/src/lint/post-synth/add-url-checksum.ts +0 -38
  195. package/src/lint/post-synth/apt-no-recommends.ts +0 -43
  196. package/src/lint/post-synth/apt-update-alone.ts +0 -39
  197. package/src/lint/post-synth/cache-busting-copy.ts +0 -65
  198. package/src/lint/post-synth/copy-from-stage.ts +0 -54
  199. package/src/lint/post-synth/docker-helpers.ts +0 -194
  200. package/src/lint/post-synth/index.ts +0 -33
  201. package/src/lint/post-synth/no-latest-image.ts +0 -36
  202. package/src/lint/post-synth/no-root-user.ts +0 -38
  203. package/src/lint/post-synth/post-synth.test.ts +0 -330
  204. package/src/lint/post-synth/prefer-copy.ts +0 -53
  205. package/src/lint/post-synth/relative-workdir.ts +0 -38
  206. package/src/lint/post-synth/repeated-cmd.ts +0 -35
  207. package/src/lint/post-synth/root-after-user.ts +0 -44
  208. package/src/lint/post-synth/ssh-port-exposed.ts +0 -68
  209. package/src/lint/post-synth/unused-global-arg.ts +0 -38
  210. package/src/lint/post-synth/unused-volume.ts +0 -49
  211. package/src/lint/rules/data/deprecated-images.ts +0 -28
  212. package/src/lint/rules/data/known-base-images.ts +0 -20
  213. package/src/lint/rules/index.ts +0 -6
  214. package/src/lint/rules/no-latest-tag.ts +0 -63
  215. package/src/lint/rules/per-kind-order.ts +0 -130
  216. package/src/lint/rules/rules.test.ts +0 -170
  217. package/src/list-artifacts.test.ts +0 -141
  218. package/src/list-artifacts.ts +0 -164
  219. package/src/lsp/completions.test.ts +0 -40
  220. package/src/lsp/completions.ts +0 -21
  221. package/src/lsp/hover.test.ts +0 -35
  222. package/src/lsp/hover.ts +0 -39
  223. package/src/package-cli.ts +0 -25
  224. package/src/plugin.test.ts +0 -121
  225. package/src/plugin.ts +0 -268
  226. package/src/serializer.test.ts +0 -545
  227. package/src/serializer.ts +0 -444
  228. package/src/skills/chant-docker-patterns.md +0 -222
  229. package/src/skills/chant-docker.md +0 -156
  230. package/src/spec/fetch-compose.ts +0 -35
  231. package/src/spec/fetch-engine.ts +0 -25
  232. package/src/spec/parse-compose.ts +0 -195
  233. package/src/spec/parse-engine.ts +0 -59
  234. package/src/typecheck.e2e.test.ts +0 -125
  235. package/src/typed-props.test.ts +0 -60
  236. package/src/validate-cli.ts +0 -19
  237. package/src/validate.test.ts +0 -16
  238. package/src/validate.ts +0 -44
  239. package/src/variables.test.ts +0 -32
  240. package/src/variables.ts +0 -47
  241. /package/{src → dist}/generated/lexicon-docker.json +0 -0
@@ -1,555 +0,0 @@
1
- // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
2
-
3
- exports[`docker OKF bundle > packaging emits a conformant, snapshot-stable bundle 1`] = `
4
- [
5
- {
6
- "content": "---
7
- okf_version: '0.2'
8
- ---
9
-
10
- # Resource types
11
-
12
- * [DockerConfig](/types/DockerConfig.md) - Docker::Compose::Config
13
- * [Dockerfile](/types/Dockerfile.md) - Docker::Dockerfile
14
- * [DockerSecret](/types/DockerSecret.md) - Docker::Compose::Secret
15
- * [Network](/types/Network.md) - Docker::Compose::Network
16
- * [Service](/types/Service.md) - Docker::Compose::Service
17
- * [Volume](/types/Volume.md) - Docker::Compose::Volume
18
-
19
- # Rules
20
-
21
- * [DKRD001](/rules/DKRD001.md) - Service uses :latest or untagged image — specify an explicit version tag
22
- * [DKRD002](/rules/DKRD002.md) - Named volume is declared but not mounted by any service
23
- * [DKRD003](/rules/DKRD003.md) - Service exposes SSH port (22) externally — this is a security risk
24
- * [DKRD010](/rules/DKRD010.md) - apt-get install without --no-install-recommends adds unnecessary packages
25
- * [DKRD011](/rules/DKRD011.md) - Prefer COPY over ADD when not fetching URLs or extracting archives
26
- * [DKRD012](/rules/DKRD012.md) - Dockerfile's final stage has no USER instruction, or ends on USER root — container runs as root
27
- * [DKRD013](/rules/DKRD013.md) - Whole build context copied before a dependency install — every source change re-runs the install
28
- * [DKRD014](/rules/DKRD014.md) - RUN needs root but comes after USER switched to a non-root user
29
- * [DKRD015](/rules/DKRD015.md) - More than one CMD or ENTRYPOINT in a stage — only the last one takes effect
30
- * [DKRD016](/rules/DKRD016.md) - COPY --from names a stage that is not defined before it
31
- * [DKRD017](/rules/DKRD017.md) - ARG before the first FROM is not used by any FROM or stage
32
- * [DKRD018](/rules/DKRD018.md) - Relative WORKDIR before any absolute WORKDIR in the stage
33
- * [DKRD019](/rules/DKRD019.md) - ADD fetches a remote URL without --checksum
34
- * [DKRD020](/rules/DKRD020.md) - apt-get update in a different RUN from apt-get install — the install can use a stale package index
35
- * [DKRS001](/rules/DKRS001.md) - No Latest Tag
36
- * [DKRS002](/rules/DKRS002.md) - Per-kind Dockerfile fields written in a different order
37
- ",
38
- "path": "index.md",
39
- },
40
- {
41
- "content": "---
42
- type: post-synth-check
43
- title: DKRD001
44
- description: Service uses :latest or untagged image — specify an explicit version tag
45
- id: DKRD001
46
- severity: error
47
- category: post-synth
48
- lexicon: docker
49
- docs: https://intentius.io/chant/lexicons/docker/rules/
50
- ---
51
- Service uses :latest or untagged image — specify an explicit version tag
52
-
53
- ## Applies to
54
-
55
- - [Service](/types/Service.md)
56
- ",
57
- "path": "rules/DKRD001.md",
58
- },
59
- {
60
- "content": "---
61
- type: post-synth-check
62
- title: DKRD002
63
- description: Named volume is declared but not mounted by any service
64
- id: DKRD002
65
- severity: error
66
- category: post-synth
67
- lexicon: docker
68
- docs: https://intentius.io/chant/lexicons/docker/rules/
69
- ---
70
- Named volume is declared but not mounted by any service
71
-
72
- ## Applies to
73
-
74
- - [Volume](/types/Volume.md)
75
- ",
76
- "path": "rules/DKRD002.md",
77
- },
78
- {
79
- "content": "---
80
- type: post-synth-check
81
- title: DKRD003
82
- description: Service exposes SSH port (22) externally — this is a security risk
83
- id: DKRD003
84
- severity: error
85
- category: post-synth
86
- lexicon: docker
87
- docs: https://intentius.io/chant/lexicons/docker/rules/
88
- ---
89
- Service exposes SSH port (22) externally — this is a security risk
90
-
91
- ## Applies to
92
-
93
- - [Service](/types/Service.md)
94
- ",
95
- "path": "rules/DKRD003.md",
96
- },
97
- {
98
- "content": "---
99
- type: post-synth-check
100
- title: DKRD010
101
- description: apt-get install without --no-install-recommends adds unnecessary packages
102
- id: DKRD010
103
- severity: error
104
- category: post-synth
105
- lexicon: docker
106
- docs: https://intentius.io/chant/lexicons/docker/rules/
107
- ---
108
- apt-get install without --no-install-recommends adds unnecessary packages
109
- ",
110
- "path": "rules/DKRD010.md",
111
- },
112
- {
113
- "content": "---
114
- type: post-synth-check
115
- title: DKRD011
116
- description: Prefer COPY over ADD when not fetching URLs or extracting archives
117
- id: DKRD011
118
- severity: error
119
- category: post-synth
120
- lexicon: docker
121
- docs: https://intentius.io/chant/lexicons/docker/rules/
122
- ---
123
- Prefer COPY over ADD when not fetching URLs or extracting archives
124
- ",
125
- "path": "rules/DKRD011.md",
126
- },
127
- {
128
- "content": "---
129
- type: post-synth-check
130
- title: DKRD012
131
- description: Dockerfile's final stage has no USER instruction, or ends on USER root — container runs as root
132
- id: DKRD012
133
- severity: error
134
- category: post-synth
135
- lexicon: docker
136
- docs: https://intentius.io/chant/lexicons/docker/rules/
137
- ---
138
- Dockerfile's final stage has no USER instruction, or ends on USER root — container runs as root
139
-
140
- ## Applies to
141
-
142
- - [Dockerfile](/types/Dockerfile.md)
143
- ",
144
- "path": "rules/DKRD012.md",
145
- },
146
- {
147
- "content": "---
148
- type: post-synth-check
149
- title: DKRD013
150
- description: Whole build context copied before a dependency install — every source change re-runs the install
151
- id: DKRD013
152
- severity: error
153
- category: post-synth
154
- lexicon: docker
155
- docs: https://intentius.io/chant/lexicons/docker/rules/
156
- ---
157
- Whole build context copied before a dependency install — every source change re-runs the install
158
- ",
159
- "path": "rules/DKRD013.md",
160
- },
161
- {
162
- "content": "---
163
- type: post-synth-check
164
- title: DKRD014
165
- description: RUN needs root but comes after USER switched to a non-root user
166
- id: DKRD014
167
- severity: error
168
- category: post-synth
169
- lexicon: docker
170
- docs: https://intentius.io/chant/lexicons/docker/rules/
171
- ---
172
- RUN needs root but comes after USER switched to a non-root user
173
- ",
174
- "path": "rules/DKRD014.md",
175
- },
176
- {
177
- "content": "---
178
- type: post-synth-check
179
- title: DKRD015
180
- description: More than one CMD or ENTRYPOINT in a stage — only the last one takes effect
181
- id: DKRD015
182
- severity: error
183
- category: post-synth
184
- lexicon: docker
185
- docs: https://intentius.io/chant/lexicons/docker/rules/
186
- ---
187
- More than one CMD or ENTRYPOINT in a stage — only the last one takes effect
188
- ",
189
- "path": "rules/DKRD015.md",
190
- },
191
- {
192
- "content": "---
193
- type: post-synth-check
194
- title: DKRD016
195
- description: COPY --from names a stage that is not defined before it
196
- id: DKRD016
197
- severity: error
198
- category: post-synth
199
- lexicon: docker
200
- docs: https://intentius.io/chant/lexicons/docker/rules/
201
- ---
202
- COPY --from names a stage that is not defined before it
203
- ",
204
- "path": "rules/DKRD016.md",
205
- },
206
- {
207
- "content": "---
208
- type: post-synth-check
209
- title: DKRD017
210
- description: ARG before the first FROM is not used by any FROM or stage
211
- id: DKRD017
212
- severity: error
213
- category: post-synth
214
- lexicon: docker
215
- docs: https://intentius.io/chant/lexicons/docker/rules/
216
- ---
217
- ARG before the first FROM is not used by any FROM or stage
218
- ",
219
- "path": "rules/DKRD017.md",
220
- },
221
- {
222
- "content": "---
223
- type: post-synth-check
224
- title: DKRD018
225
- description: Relative WORKDIR before any absolute WORKDIR in the stage
226
- id: DKRD018
227
- severity: error
228
- category: post-synth
229
- lexicon: docker
230
- docs: https://intentius.io/chant/lexicons/docker/rules/
231
- ---
232
- Relative WORKDIR before any absolute WORKDIR in the stage
233
- ",
234
- "path": "rules/DKRD018.md",
235
- },
236
- {
237
- "content": "---
238
- type: post-synth-check
239
- title: DKRD019
240
- description: ADD fetches a remote URL without --checksum
241
- id: DKRD019
242
- severity: error
243
- category: post-synth
244
- lexicon: docker
245
- docs: https://intentius.io/chant/lexicons/docker/rules/
246
- ---
247
- ADD fetches a remote URL without --checksum
248
- ",
249
- "path": "rules/DKRD019.md",
250
- },
251
- {
252
- "content": "---
253
- type: post-synth-check
254
- title: DKRD020
255
- description: apt-get update in a different RUN from apt-get install — the install can use a stale package index
256
- id: DKRD020
257
- severity: error
258
- category: post-synth
259
- lexicon: docker
260
- docs: https://intentius.io/chant/lexicons/docker/rules/
261
- ---
262
- apt-get update in a different RUN from apt-get install — the install can use a stale package index
263
- ",
264
- "path": "rules/DKRD020.md",
265
- },
266
- {
267
- "content": "---
268
- type: lint-rule
269
- title: DKRS001
270
- description: No Latest Tag
271
- id: DKRS001
272
- severity: warning
273
- category: correctness
274
- lexicon: docker
275
- docs: https://intentius.io/chant/lexicons/docker/rules/
276
- ---
277
- No Latest Tag
278
-
279
- ## Applies to
280
-
281
- - [Service](/types/Service.md)
282
- ",
283
- "path": "rules/DKRS001.md",
284
- },
285
- {
286
- "content": "---
287
- type: lint-rule
288
- title: DKRS002
289
- description: Per-kind Dockerfile fields written in a different order
290
- id: DKRS002
291
- severity: warning
292
- category: correctness
293
- lexicon: docker
294
- docs: https://intentius.io/chant/lexicons/docker/rules/
295
- ---
296
- Per-kind Dockerfile fields written in a different order
297
-
298
- ## Applies to
299
-
300
- - [Dockerfile](/types/Dockerfile.md)
301
- ",
302
- "path": "rules/DKRS002.md",
303
- },
304
- {
305
- "content": "---
306
- type: resource-type
307
- title: DockerConfig
308
- description: A config definition in Docker Compose
309
- name: DockerConfig
310
- lexicon: docker
311
- resource_type: Docker::Compose::Config
312
- ---
313
- A config definition in Docker Compose
314
-
315
- ## Properties
316
-
317
- - \`name\` (\`ComposeString\`): Custom name for this config.
318
- - \`content\` (\`ComposeString\`): Inline content of the config.
319
- - \`environment\` (\`ComposeString\`): Name of an environment variable from which to get the config value.
320
- - \`file\` (\`ComposeString\`): Path to a file containing the config value.
321
- - \`external\` (\`boolean | ComposeString | { name?: ComposeString }\`): Specifies that this config already exists and was created outside of Compose.
322
- - \`labels\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Add metadata to the config using labels.
323
- - \`template_driver\` (\`ComposeString\`): Driver to use for templating the config's value.
324
- ",
325
- "path": "types/DockerConfig.md",
326
- },
327
- {
328
- "content": "---
329
- type: resource-type
330
- title: Dockerfile
331
- description: A Dockerfile definition with ordered build instructions
332
- name: Dockerfile
333
- lexicon: docker
334
- resource_type: Docker::Dockerfile
335
- ---
336
- A Dockerfile definition with ordered build instructions
337
-
338
- ## Properties
339
-
340
- - \`from\`: Base image (required first instruction)
341
- - \`arg\`: Build-time argument
342
- - \`env\`: Environment variable
343
- - \`run\`: Run a command during build
344
- - \`copy\`: Copy files from build context
345
- - \`add\`: Add files (supports URLs and archives)
346
- - \`workdir\`: Set working directory
347
- - \`user\`: Set user for subsequent instructions
348
- - \`expose\`: Document exposed ports
349
- - \`volume\`: Create mount points
350
- - \`label\`: Add metadata labels
351
- - \`entrypoint\`: Set the entrypoint executable
352
- - \`cmd\`: Default command arguments
353
- - \`healthcheck\`: Health check instruction
354
- - \`globalArgs\`: ARG instructions written before the first FROM
355
- - \`steps\`: Instructions after FROM, written in the order given; one instruction per step
356
-
357
- ## Governed by
358
-
359
- - [DKRD012](/rules/DKRD012.md): Dockerfile's final stage has no USER instruction, or ends on USER root — container runs as root
360
- - [DKRS002](/rules/DKRS002.md): Per-kind Dockerfile fields written in a different order
361
- ",
362
- "path": "types/Dockerfile.md",
363
- },
364
- {
365
- "content": "---
366
- type: resource-type
367
- title: DockerSecret
368
- description: A secret definition in Docker Compose
369
- name: DockerSecret
370
- lexicon: docker
371
- resource_type: Docker::Compose::Secret
372
- ---
373
- A secret definition in Docker Compose
374
-
375
- ## Properties
376
-
377
- - \`name\` (\`ComposeString\`): Custom name for this secret.
378
- - \`environment\` (\`ComposeString\`): Name of an environment variable from which to get the secret value.
379
- - \`file\` (\`ComposeString\`): Path to a file containing the secret value.
380
- - \`external\` (\`boolean | ComposeString | { name?: ComposeString }\`): Specifies that this secret already exists and was created outside of Compose.
381
- - \`labels\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Add metadata to the secret using labels.
382
- - \`driver\` (\`ComposeString\`): Specify which secret driver should be used for this secret.
383
- - \`driver_opts\` (\`Record<string, ComposeString | number>\`): Specify driver-specific options.
384
- - \`template_driver\` (\`ComposeString\`): Driver to use for templating the secret's value.
385
- ",
386
- "path": "types/DockerSecret.md",
387
- },
388
- {
389
- "content": "---
390
- type: resource-type
391
- title: Network
392
- description: A network definition in Docker Compose
393
- name: Network
394
- lexicon: docker
395
- resource_type: Docker::Compose::Network
396
- ---
397
- A network definition in Docker Compose
398
-
399
- ## Properties
400
-
401
- - \`name\` (\`ComposeString\`): Custom name for this network.
402
- - \`driver\` (\`ComposeString\`): Specify which driver should be used for this network. Default is 'bridge'.
403
- - \`driver_opts\` (\`Record<string, ComposeString | number>\`): Specify driver-specific options defined as key/value pairs.
404
- - \`ipam\` (\`{ driver?: ComposeString; config?: Array<{ subnet?: ComposeString; ip_range?: ComposeString; gateway?: ComposeString; aux_addresses?: Record<string, ComposeString>; [key: \`x-\${string}\`]: unknown }>; options?: Record<string, ComposeString>; [key: \`x-\${string}\`]: unknown }\`): Custom IP Address Management configuration for this network.
405
- - \`external\` (\`boolean | ComposeString | { name?: ComposeString; [key: \`x-\${string}\`]: unknown }\`): Specifies that this network already exists and was created outside of Compose.
406
- - \`internal\` (\`boolean | ComposeString\`): Create an externally isolated network.
407
- - \`enable_ipv4\` (\`boolean | ComposeString\`): Enable IPv4 networking.
408
- - \`enable_ipv6\` (\`boolean | ComposeString\`): Enable IPv6 networking.
409
- - \`attachable\` (\`boolean | ComposeString\`): If true, standalone containers can attach to this network.
410
- - \`labels\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Add metadata to the network using labels.
411
- ",
412
- "path": "types/Network.md",
413
- },
414
- {
415
- "content": "---
416
- type: resource-type
417
- title: Service
418
- description: A containerized service definition in Docker Compose
419
- name: Service
420
- lexicon: docker
421
- resource_type: Docker::Compose::Service
422
- ---
423
- A containerized service definition in Docker Compose
424
-
425
- ## Properties
426
-
427
- - \`develop\` (\`{ watch?: Array<{ ignore?: ComposeString | Array<ComposeString>; include?: ComposeString | Array<ComposeString>; path: ComposeString; action: "rebuild" | "sync" | "restart" | "sync+restart" | "sync+exec"; target?: ComposeString; exec?: { command: null | ComposeString | Array<ComposeString>; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: \`x-\${string}\`]: unknown }; initial_sync?: boolean; [key: \`x-\${string}\`]: unknown }>; [key: \`x-\${string}\`]: unknown } | null\`)
428
- - \`deploy\` (\`{ mode?: ComposeString; endpoint_mode?: ComposeString; replicas?: number | ComposeString; labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; rollback_config?: { parallelism?: number | ComposeString; delay?: ComposeString; failure_action?: ComposeString; monitor?: ComposeString; max_failure_ratio?: number | ComposeString; order?: "start-first" | "stop-first"; [key: \`x-\${string}\`]: unknown }; update_config?: { parallelism?: number | ComposeString; delay?: ComposeString; failure_action?: ComposeString; monitor?: ComposeString; max_failure_ratio?: number | ComposeString; order?: "start-first" | "stop-first"; [key: \`x-\${string}\`]: unknown }; resources?: { limits?: { cpus?: number | ComposeString; memory?: ComposeString; pids?: number | ComposeString; [key: \`x-\${string}\`]: unknown }; reservations?: { cpus?: number | ComposeString; memory?: ComposeString; generic_resources?: Array<{ discrete_resource_spec?: { kind?: ComposeString; value?: number | ComposeString; [key: \`x-\${string}\`]: unknown }; [key: \`x-\${string}\`]: unknown }>; devices?: Array<{ capabilities: Array<ComposeString>; count?: ComposeString | number; device_ids?: Array<ComposeString>; driver?: ComposeString; options?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: \`x-\${string}\`]: unknown }>; [key: \`x-\${string}\`]: unknown }; [key: \`x-\${string}\`]: unknown }; restart_policy?: { condition?: ComposeString; delay?: ComposeString; max_attempts?: number | ComposeString; window?: ComposeString; [key: \`x-\${string}\`]: unknown }; placement?: { constraints?: Array<ComposeString>; preferences?: Array<{ spread?: ComposeString; [key: \`x-\${string}\`]: unknown }>; max_replicas_per_node?: number | ComposeString; [key: \`x-\${string}\`]: unknown }; [key: \`x-\${string}\`]: unknown } | null\`)
429
- - \`annotations\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`)
430
- - \`attach\` (\`boolean | ComposeString\`)
431
- - \`build\` (\`ComposeString | { context?: ComposeString; dockerfile?: ComposeString; dockerfile_inline?: ComposeString; entitlements?: Array<ComposeString>; args?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; ssh?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; cache_from?: Array<ComposeString>; cache_to?: Array<ComposeString>; no_cache?: boolean | ComposeString; no_cache_filter?: ComposeString | Array<ComposeString>; additional_contexts?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; network?: ComposeString; provenance?: ComposeString | boolean; sbom?: ComposeString | boolean; pull?: boolean | ComposeString; target?: ComposeString; shm_size?: number | ComposeString; extra_hosts?: Record<string, ComposeString | Array<ComposeString>> | Array<ComposeString>; isolation?: ComposeString; privileged?: boolean | ComposeString; secrets?: Array<ComposeString | { source?: ComposeString; target?: ComposeString; uid?: ComposeString; gid?: ComposeString; mode?: number | ComposeString; [key: \`x-\${string}\`]: unknown }>; tags?: Array<ComposeString>; ulimits?: Record<string, number | ComposeString | { hard: number | ComposeString; soft: number | ComposeString; [key: \`x-\${string}\`]: unknown }>; platforms?: Array<ComposeString>; [key: \`x-\${string}\`]: unknown }\`): Configuration options for building the service's image.
432
- - \`blkio_config\` (\`{ device_read_bps?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; device_read_iops?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; device_write_bps?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; device_write_iops?: Array<{ path?: ComposeString; rate?: number | ComposeString }>; weight?: number | ComposeString; weight_device?: Array<{ path?: ComposeString; weight?: number | ComposeString }> }\`): Block IO configuration for the service.
433
- - \`cap_add\` (\`Array<ComposeString>\`): Add Linux capabilities. For example, 'CAP_SYS_ADMIN', 'SYS_ADMIN', or 'NET_ADMIN'.
434
- - \`cap_drop\` (\`Array<ComposeString>\`): Drop Linux capabilities. For example, 'CAP_SYS_ADMIN', 'SYS_ADMIN', or 'NET_ADMIN'.
435
- - \`cgroup\` (\`"host" | "private"\`): Specify the cgroup namespace to join. Use 'host' to use the host's cgroup namespace, or 'private' to use a private cgroup namespace.
436
- - \`cgroup_parent\` (\`ComposeString\`): Specify an optional parent cgroup for the container.
437
- - \`command\` (\`null | ComposeString | Array<ComposeString>\`): Override the default command declared by the container image, for example 'CMD' in Dockerfile.
438
- - \`configs\` (\`Array<ComposeString | { source?: ComposeString; target?: ComposeString; uid?: ComposeString; gid?: ComposeString; mode?: number | ComposeString; [key: \`x-\${string}\`]: unknown }>\`): Grant access to Configs on a per-service basis.
439
- - \`container_name\` (\`ComposeString\`): Specify a custom container name, rather than a generated default name.
440
- - \`cpu_count\` (\`ComposeString | number\`): Number of usable CPUs.
441
- - \`cpu_percent\` (\`ComposeString | number\`): Percentage of CPU resources to use.
442
- - \`cpu_shares\` (\`number | ComposeString\`): CPU shares (relative weight) for the container.
443
- - \`cpu_quota\` (\`number | ComposeString\`): Limit the CPU CFS (Completely Fair Scheduler) quota.
444
- - \`cpu_period\` (\`number | ComposeString\`): Limit the CPU CFS (Completely Fair Scheduler) period.
445
- - \`cpu_rt_period\` (\`number | ComposeString\`): Limit the CPU real-time period in microseconds or a duration.
446
- - \`cpu_rt_runtime\` (\`number | ComposeString\`): Limit the CPU real-time runtime in microseconds or a duration.
447
- - \`cpus\` (\`number | ComposeString\`): Number of CPUs to use. A floating-point value is supported to request partial CPUs.
448
- - \`cpuset\` (\`ComposeString\`): CPUs in which to allow execution (0-3, 0,1).
449
- - \`credential_spec\` (\`{ config?: ComposeString; file?: ComposeString; registry?: ComposeString; [key: \`x-\${string}\`]: unknown }\`): Configure the credential spec for managed service account.
450
- - \`depends_on\` (\`Array<ComposeString> | Record<string, { restart?: boolean | ComposeString; required?: boolean; condition: "service_started" | "service_healthy" | "service_completed_successfully"; [key: \`x-\${string}\`]: unknown }>\`): Express dependency between services. Service dependencies cause services to be started in dependency order. The dependent service will wait for the dependency to be ready before starting.
451
- - \`device_cgroup_rules\` (\`Array<ComposeString>\`): Add rules to the cgroup allowed devices list.
452
- - \`devices\` (\`Array<ComposeString | { source: ComposeString; target?: ComposeString; permissions?: ComposeString; [key: \`x-\${string}\`]: unknown }>\`): List of device mappings for the container.
453
- - \`dns\` (\`ComposeString | Array<ComposeString>\`): Custom DNS servers to set for the service container.
454
- - \`dns_opt\` (\`Array<ComposeString>\`): Custom DNS options to be passed to the container's DNS resolver.
455
- - \`dns_search\` (\`ComposeString | Array<ComposeString>\`): Custom DNS search domains to set on the service container.
456
- - \`domainname\` (\`ComposeString\`): Custom domain name to use for the service container.
457
- - \`entrypoint\` (\`null | ComposeString | Array<ComposeString>\`): Override the default entrypoint declared by the container image, for example 'ENTRYPOINT' in Dockerfile.
458
- - \`env_file\` (\`ComposeString | Array<ComposeString | { path: ComposeString; format?: ComposeString; required?: boolean | ComposeString }>\`): Add environment variables from a file or multiple files. Can be a single file path or a list of file paths.
459
- - \`label_file\` (\`ComposeString | Array<ComposeString>\`): Add metadata to containers using files containing Docker labels.
460
- - \`environment\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Add environment variables. You can use either an array or a list of KEY=VAL pairs.
461
- - \`expose\` (\`Array<ComposeString | number>\`): Expose ports without publishing them to the host machine - they'll only be accessible to linked services.
462
- - \`extends\` (\`ComposeString | { service: ComposeString; file?: ComposeString }\`): Extend another service, in the current file or another file.
463
- - \`provider\` (\`{ type: ComposeString; options?: Record<string, ComposeString | number | boolean | Array<ComposeString | number | boolean>>; [key: \`x-\${string}\`]: unknown }\`): Specify a service which will not be manage by Compose directly, and delegate its management to an external provider.
464
- - \`external_links\` (\`Array<ComposeString>\`): Link to services started outside this Compose application. Specify services as <service_name>:<alias>.
465
- - \`extra_hosts\` (\`Record<string, ComposeString | Array<ComposeString>> | Array<ComposeString>\`): Add hostname mappings to the container network interface configuration.
466
- - \`gpus\` (\`"all" | Array<{ capabilities?: Array<ComposeString>; count?: ComposeString | number; device_ids?: Array<ComposeString>; driver?: ComposeString; options?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString> }>\`): Define GPU devices to use. Can be set to 'all' to use all GPUs, or a list of specific GPU devices.
467
- - \`group_add\` (\`Array<ComposeString | number>\`): Add additional groups which user inside the container should be member of.
468
- - \`healthcheck\` (\`{ disable?: boolean | ComposeString; interval?: ComposeString; retries?: number | ComposeString; test?: ComposeString | Array<ComposeString>; timeout?: ComposeString; start_period?: ComposeString; start_interval?: ComposeString; [key: \`x-\${string}\`]: unknown }\`): Configure a health check for the container to monitor its health status.
469
- - \`hostname\` (\`ComposeString\`): Define a custom hostname for the service container.
470
- - \`image\` (\`ComposeString\`): Specify the image to start the container from. Can be a repository/tag, a digest, or a local image ID.
471
- - \`init\` (\`boolean | ComposeString\`): Run as an init process inside the container that forwards signals and reaps processes.
472
- - \`ipc\` (\`ComposeString\`): IPC sharing mode for the service container. Use 'host' to share the host's IPC namespace, 'service:[service_name]' to share with another service, or 'shareable' to allow other services to share this service's IPC namespace.
473
- - \`isolation\` (\`ComposeString\`): Container isolation technology to use. Supported values are platform-specific.
474
- - \`labels\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Add metadata to containers using Docker labels. You can use either an array or a list.
475
- - \`links\` (\`Array<ComposeString>\`): Link to containers in another service. Either specify both the service name and a link alias (SERVICE:ALIAS), or just the service name.
476
- - \`logging\` (\`{ driver?: ComposeString; options?: Record<string, ComposeString | number | null>; [key: \`x-\${string}\`]: unknown }\`): Logging configuration for the service.
477
- - \`mac_address\` (\`ComposeString\`): Container MAC address to set.
478
- - \`mem_limit\` (\`number | ComposeString\`): Memory limit for the container. A string value can use suffix like '2g' for 2 gigabytes.
479
- - \`mem_reservation\` (\`ComposeString | number\`): Memory reservation for the container.
480
- - \`mem_swappiness\` (\`number | ComposeString\`): Container memory swappiness as percentage (0 to 100).
481
- - \`memswap_limit\` (\`number | ComposeString\`): Amount of memory the container is allowed to swap to disk. Set to -1 to enable unlimited swap.
482
- - \`network_mode\` (\`ComposeString\`): Network mode. Values can be 'bridge', 'host', 'none', 'service:[service name]', or 'container:[container name]'.
483
- - \`models\` (\`Array<ComposeString> | Record<string, { endpoint_var?: ComposeString; model_var?: ComposeString; [key: \`x-\${string}\`]: unknown } | null>\`): AI Models to use, referencing entries under the top-level models key.
484
- - \`networks\` (\`Array<ComposeString> | Record<string, { aliases?: Array<ComposeString>; interface_name?: ComposeString; ipv4_address?: ComposeString; ipv6_address?: ComposeString; link_local_ips?: Array<ComposeString>; mac_address?: ComposeString; driver_opts?: Record<string, ComposeString | number>; priority?: number; gw_priority?: number; [key: \`x-\${string}\`]: unknown } | null>\`): Networks to join, referencing entries under the top-level networks key. Can be a list of network names or a mapping of network name to network configuration.
485
- - \`oom_kill_disable\` (\`boolean | ComposeString\`): Disable OOM Killer for the container.
486
- - \`oom_score_adj\` (\`ComposeString | number\`): Tune host's OOM preferences for the container (accepts -1000 to 1000).
487
- - \`pid\` (\`ComposeString | null\`): PID mode for container.
488
- - \`pids_limit\` (\`number | ComposeString\`): Tune a container's PIDs limit. Set to -1 for unlimited PIDs.
489
- - \`platform\` (\`ComposeString\`): Target platform to run on, e.g., 'linux/amd64', 'linux/arm64', or 'windows/amd64'.
490
- - \`ports\` (\`Array<number | ComposeString | { name?: ComposeString; mode?: ComposeString; host_ip?: ComposeString; target?: number | ComposeString; published?: ComposeString | number; protocol?: ComposeString; app_protocol?: ComposeString; [key: \`x-\${string}\`]: unknown }>\`): Expose container ports. Short format ([HOST:]CONTAINER[/PROTOCOL]).
491
- - \`pre_start\` (\`Array<{ command?: null | ComposeString | Array<ComposeString>; image?: ComposeString; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; per_replica?: boolean | ComposeString; [key: \`x-\${string}\`]: unknown }>\`): Init containers to run to completion before the service container is started. Each step runs in its own ephemeral container, in declared order; a non-zero exit fails the bring-up of the service and its dependents.
492
- - \`post_start\` (\`Array<{ command: null | ComposeString | Array<ComposeString>; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: \`x-\${string}\`]: unknown }>\`): Commands to run after the container starts. If any command fails, the container stops.
493
- - \`pre_stop\` (\`Array<{ command: null | ComposeString | Array<ComposeString>; user?: ComposeString; privileged?: boolean | ComposeString; working_dir?: ComposeString; environment?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; [key: \`x-\${string}\`]: unknown }>\`): Commands to run before the container stops. If any command fails, the container stop is aborted.
494
- - \`privileged\` (\`boolean | ComposeString\`): Give extended privileges to the service container.
495
- - \`profiles\` (\`Array<ComposeString>\`): List of profiles for this service. When profiles are specified, services are only started when the profile is activated.
496
- - \`pull_policy\` (\`ComposeString\`): Policy for pulling images. Options include: 'always', 'never', 'if_not_present', 'missing', 'build', or time-based refresh policies.
497
- - \`pull_refresh_after\` (\`ComposeString\`): Time after which to refresh the image. Used with pull_policy=refresh.
498
- - \`read_only\` (\`boolean | ComposeString\`): Mount the container's filesystem as read only.
499
- - \`restart\` (\`ComposeString\`): Restart policy for the service container. Options include: 'no', 'always', 'on-failure', and 'unless-stopped'.
500
- - \`runtime\` (\`ComposeString\`): Runtime to use for this container, e.g., 'runc'.
501
- - \`scale\` (\`number | ComposeString\`): Number of containers to deploy for this service.
502
- - \`security_opt\` (\`Array<ComposeString>\`): Override the default labeling scheme for each container.
503
- - \`shm_size\` (\`number | ComposeString\`): Size of /dev/shm. A string value can use suffix like '2g' for 2 gigabytes.
504
- - \`secrets\` (\`Array<ComposeString | { source?: ComposeString; target?: ComposeString; uid?: ComposeString; gid?: ComposeString; mode?: number | ComposeString; [key: \`x-\${string}\`]: unknown }>\`): Grant access to Secrets on a per-service basis.
505
- - \`sysctls\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Kernel parameters to set in the container. You can use either an array or a list.
506
- - \`stdin_open\` (\`boolean | ComposeString\`): Keep STDIN open even if not attached.
507
- - \`stop_grace_period\` (\`ComposeString\`): Time to wait for the container to stop gracefully before sending SIGKILL (e.g., '1s', '1m30s').
508
- - \`stop_signal\` (\`ComposeString\`): Signal to stop the container (e.g., 'SIGTERM', 'SIGINT').
509
- - \`storage_opt\` (\`Record<string, unknown>\`): Storage driver options for the container.
510
- - \`tmpfs\` (\`ComposeString | Array<ComposeString>\`): Mount a temporary filesystem (tmpfs) into the container. Can be a single value or a list.
511
- - \`tty\` (\`boolean | ComposeString\`): Allocate a pseudo-TTY to service container.
512
- - \`ulimits\` (\`Record<string, number | ComposeString | { hard: number | ComposeString; soft: number | ComposeString; [key: \`x-\${string}\`]: unknown }>\`): Override the default ulimits for a container.
513
- - \`use_api_socket\` (\`boolean\`): Bind mount Docker API socket and required auth.
514
- - \`user\` (\`ComposeString\`): Username or UID to run the container process as.
515
- - \`uts\` (\`ComposeString\`): UTS namespace to use. 'host' shares the host's UTS namespace.
516
- - \`userns_mode\` (\`ComposeString\`): User namespace to use. 'host' shares the host's user namespace.
517
- - \`volumes\` (\`Array<ComposeString | { type: "bind" | "volume" | "tmpfs" | "cluster" | "npipe" | "image"; source?: ComposeString; target?: ComposeString; read_only?: boolean | ComposeString; consistency?: ComposeString; bind?: { propagation?: ComposeString; create_host_path?: boolean | ComposeString; recursive?: "enabled" | "disabled" | "writable" | "readonly"; selinux?: "z" | "Z"; [key: \`x-\${string}\`]: unknown }; volume?: { labels?: Record<string, ComposeString | number | boolean | null> | Array<ComposeString>; nocopy?: boolean | ComposeString; subpath?: ComposeString; [key: \`x-\${string}\`]: unknown }; tmpfs?: { size?: number | ComposeString; mode?: number | ComposeString; [key: \`x-\${string}\`]: unknown }; image?: { subpath?: ComposeString; [key: \`x-\${string}\`]: unknown }; [key: \`x-\${string}\`]: unknown }>\`): Mount host paths or named volumes accessible to the container. Short syntax (VOLUME:CONTAINER_PATH[:MODE])
518
- - \`volumes_from\` (\`Array<ComposeString>\`): Mount volumes from another service or container. Optionally specify read-only access (ro) or read-write (rw).
519
- - \`working_dir\` (\`ComposeString\`): The working directory in which the entrypoint or command will be run
520
-
521
- ## Governed by
522
-
523
- - [DKRD001](/rules/DKRD001.md): Service uses :latest or untagged image — specify an explicit version tag
524
- - [DKRD003](/rules/DKRD003.md): Service exposes SSH port (22) externally — this is a security risk
525
- - [DKRS001](/rules/DKRS001.md): No Latest Tag
526
- ",
527
- "path": "types/Service.md",
528
- },
529
- {
530
- "content": "---
531
- type: resource-type
532
- title: Volume
533
- description: A named volume definition in Docker Compose
534
- name: Volume
535
- lexicon: docker
536
- resource_type: Docker::Compose::Volume
537
- ---
538
- A named volume definition in Docker Compose
539
-
540
- ## Properties
541
-
542
- - \`name\` (\`ComposeString\`): Custom name for this volume.
543
- - \`driver\` (\`ComposeString\`): Specify which volume driver should be used for this volume.
544
- - \`driver_opts\` (\`Record<string, ComposeString | number>\`): Specify driver-specific options.
545
- - \`external\` (\`boolean | ComposeString | { name?: ComposeString; [key: \`x-\${string}\`]: unknown }\`): Specifies that this volume already exists and was created outside of Compose.
546
- - \`labels\` (\`Record<string, ComposeString | number | boolean | null> | Array<ComposeString>\`): Add metadata to the volume using labels.
547
-
548
- ## Governed by
549
-
550
- - [DKRD002](/rules/DKRD002.md): Named volume is declared but not mounted by any service
551
- ",
552
- "path": "types/Volume.md",
553
- },
554
- ]
555
- `;
@@ -1,10 +0,0 @@
1
- #!/usr/bin/env tsx
2
- /**
3
- * CLI entry for Docker lexicon docs generation.
4
- */
5
-
6
- import { generateDocs } from "./docs";
7
-
8
- const verbose = process.argv.includes("--verbose") || process.argv.includes("-v");
9
-
10
- await generateDocs({ verbose });