-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(docs): custom resource docs generation (#902)
## Description Create some custom docs generation for custom resources. Dynamic to work in the future if new custom resources are created. Also tied into running with the `gen-crds` task that is part of the src/pepr tasks. ## Related Issue Fixes #382 ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Test, docs, adr added or updated as needed - [x] [Contributor Guide](https://github.com/defenseunicorns/uds-template-capability/blob/main/CONTRIBUTING.md) followed --------- Co-authored-by: Micah Nagel <[email protected]>
- Loading branch information
1 parent
73eb385
commit e73597d
Showing
6 changed files
with
982 additions
and
206 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
.cache/ | ||
.idea/ | ||
build/ | ||
build/** | ||
.DS_Store | ||
*.tar.zst | ||
zarf-sbom | ||
|
76 changes: 76 additions & 0 deletions
76
docs/reference/configuration/custom-resources/exemptions-v1alpha1-cr.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
title: Exemptions CR (v1alpha1) | ||
tableOfContents: | ||
maxHeadingLevel: 6 | ||
--- | ||
<a id="Exemptions"></a> | ||
<div style="margin-left: 20px; padding-top: 30px;"> | ||
|
||
# Exemptions | ||
<table style="width: 100%; table-layout: fixed;"> | ||
<thead> | ||
<tr> | ||
<th style="width: 20%; white-space: nowrap;">Field</th> | ||
<th style="width: 25%; white-space: nowrap;">Type</th> | ||
<th style="width: 55%; white-space: nowrap;">Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td style="white-space: nowrap;">spec</td><td style="white-space: nowrap;"><a href="#Spec">Spec</a></td><td></td></tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
|
||
<a id="Spec"></a> | ||
<div style="margin-left: 40px; padding-top: 30px;"> | ||
|
||
## Spec | ||
<table style="width: 100%; table-layout: fixed;"> | ||
<thead> | ||
<tr> | ||
<th style="width: 20%; white-space: nowrap;">Field</th> | ||
<th style="width: 25%; white-space: nowrap;">Type</th> | ||
<th style="width: 55%; white-space: nowrap;">Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td style="white-space: nowrap;">exemptions</td><td style="white-space: nowrap;"><a href="#Exemptions">Exemptions[]</a></td><td>Policy exemptions</td></tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
|
||
<a id="Exemptions"></a> | ||
<div style="margin-left: 60px; padding-top: 30px;"> | ||
|
||
### Exemptions | ||
<table style="width: 100%; table-layout: fixed;"> | ||
<thead> | ||
<tr> | ||
<th style="width: 20%; white-space: nowrap;">Field</th> | ||
<th style="width: 25%; white-space: nowrap;">Type</th> | ||
<th style="width: 55%; white-space: nowrap;">Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td style="white-space: nowrap;">description</td><td style="white-space: nowrap;">string</td><td>Reasons as to why this exemption is needed</td></tr><tr><td style="white-space: nowrap;">matcher</td><td style="white-space: nowrap;"><a href="#Matcher">Matcher</a></td><td>Resource to exempt (Regex allowed for name)</td></tr><tr><td style="white-space: nowrap;">policies</td><td style="white-space: nowrap;">Policies[] (enum):<ul><li><code>DisallowHostNamespaces</code></li><li><code>DisallowNodePortServices</code></li><li><code>DisallowPrivileged</code></li><li><code>DisallowSELinuxOptions</code></li><li><code>DropAllCapabilities</code></li><li><code>RequireNonRootUser</code></li><li><code>RestrictCapabilities</code></li><li><code>RestrictExternalNames</code></li><li><code>RestrictHostPathWrite</code></li><li><code>RestrictHostPorts</code></li><li><code>RestrictProcMount</code></li><li><code>RestrictSeccomp</code></li><li><code>RestrictSELinuxType</code></li><li><code>RestrictVolumeTypes</code></li></ul></td><td>A list of policies to override</td></tr><tr><td style="white-space: nowrap;">title</td><td style="white-space: nowrap;">string</td><td>title to give the exemption for reporting purposes</td></tr> | ||
</tbody> | ||
</table> | ||
</div> | ||
|
||
<a id="Matcher"></a> | ||
<div style="margin-left: 80px; padding-top: 30px;"> | ||
|
||
#### Matcher | ||
<table style="width: 100%; table-layout: fixed;"> | ||
<thead> | ||
<tr> | ||
<th style="width: 20%; white-space: nowrap;">Field</th> | ||
<th style="width: 25%; white-space: nowrap;">Type</th> | ||
<th style="width: 55%; white-space: nowrap;">Description</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr><td style="white-space: nowrap;">kind</td><td style="white-space: nowrap;">string (enum):<ul><li><code>pod</code></li><li><code>service</code></li></ul></td><td></td></tr><tr><td style="white-space: nowrap;">name</td><td style="white-space: nowrap;">string</td><td></td></tr><tr><td style="white-space: nowrap;">namespace</td><td style="white-space: nowrap;">string</td><td></td></tr> | ||
</tbody> | ||
</table> | ||
</div> |
Oops, something went wrong.