[v16] Auto-generate operator CRD docs #45538
Merged
Conversation
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
ptgott
requested review from
klizhentas,
russjones,
r0mant,
zmb3,
fheinecke,
camscale,
tcsc,
rosstimothy and
codingllama
as code owners
|
@ptgott - this PR will require admin approval to merge due to its size. Consider breaking it up into a series smaller changes. |
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-hxtz1w1rv-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/44107-bp-v16
branch
from
214cd95 to
4dc5edd
Compare
|
The PR changelog entry failed validation: Changelog entry not found in the PR body. Please add a "no-changelog" label to the PR, or changelog lines starting with |
|
🤖 Vercel preview here: https://docs-mn92rifzk-goteleport.vercel.app/docs/ver/preview |
tigrato
approved these changes
Aug 29, 2024
ptgott
added
the
no-changelog
ptgott
force-pushed
the
paul.gottschling/44107-bp-v16
branch
from
4dc5edd to
7908735
Compare
|
🤖 Vercel preview here: https://docs-6pcy0c2tz-goteleport.vercel.app/docs/ver/preview |
hugoShaka
reviewed
Aug 30, 2024
docs/cspell.json
Outdated
Comment on lines
845
to
910
| "specallow", | ||
| "specallowdb", | ||
| "specallowimpersonate", | ||
| "specallowjoin", | ||
| "specallowkubernetes", | ||
| "specallowrequest", | ||
| "specallowrequestclaims", | ||
| "specallowrequestthresholds", | ||
| "specallowrequire", | ||
| "specallowreview", | ||
| "specallowrules", | ||
| "specallowspiffe", | ||
| "specassertion", | ||
| "specattributes", | ||
| "specaudit", | ||
| "specauditnotifications", | ||
| "specauditrecurrence", | ||
| "specazure", | ||
| "specazureallow", | ||
| "speccircleci", | ||
| "speccircleciallow", | ||
| "specclaims", | ||
| "specclient", | ||
| "speccloud", | ||
| "specdeny", | ||
| "specdenydb", | ||
| "specdenyimpersonate", | ||
| "specdenyjoin", | ||
| "specdenykubernetes", | ||
| "specdenyrequest", | ||
| "specdenyrequestclaims", | ||
| "specdenyrequestthresholds", | ||
| "specdenyrequire", | ||
| "specdenyreview", | ||
| "specdenyrules", | ||
| "specdenyspiffe", | ||
| "specgcp", | ||
| "specgcpallow", | ||
| "specgithub", | ||
| "specgithuballow", | ||
| "specgitlab", | ||
| "specgitlaballow", | ||
| "specgrants", | ||
| "speckubernetes", | ||
| "speckubernetesallow", | ||
| "speckubernetesstatic", | ||
| "specmappings", | ||
| "specmembership", | ||
| "specoidc", | ||
| "specoptions", | ||
| "specoptionscert", | ||
| "specoptionsidp", | ||
| "specoptionsidpsaml", | ||
| "specoptionsrecord", | ||
| "specowner", | ||
| "specowners", | ||
| "specownership", | ||
| "specrotation", | ||
| "specrotationschedule", | ||
| "specsaml", | ||
| "specsigning", | ||
| "specspacelift", | ||
| "specspaceliftallow", | ||
| "specteams", | ||
| "spectpm", | ||
| "spectpmallow", |
There was a problem hiding this comment.
This won't scale, can we skip the spell check on the links or those pages instead?
There was a problem hiding this comment.
I have a PR to address this on master here: #46259
hugoShaka
approved these changes
Sep 4, 2024
r0mant
approved these changes
Sep 5, 2024
|
🤖 Vercel preview here: https://docs-8f8xzvrdo-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/44107-bp-v16
branch
from
e588796 to
8ddf45e
Compare
|
🤖 Vercel preview here: https://docs-g7za1i7a7-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/44107-bp-v16
branch
from
8ddf45e to
ae2c274
Compare
|
🤖 Vercel preview here: https://docs-lfrjb1fpv-goteleport.vercel.app/docs/ver/preview |
ptgott
force-pushed
the
paul.gottschling/44107-bp-v16
branch
from
ae2c274 to
d7b3222
Compare
|
🤖 Vercel preview here: https://docs-freizogjb-goteleport.vercel.app/docs/ver/preview |
Backports #44107 * Auto-generate operator CRD docs We already pull JSON schema data from Teleport protobuf message definitions in order to generate CRD manifests. Extract a shared library from code within the existing protoc plugin for generating CRDs. This way, we can use the library to generate docs for our CRDs with a separate plugin, and don't need to complicate the interface for using the existing plugin. - Organize `integrations/crdgen` into `lib` and `cmd` directories, turning `lib` into a package. - Edit the `generateSchema` signature to include a function that formats a CRD into a document, injecting separate functions for formatting the CRD as YAML and as a docs page. - Add Makefile targets for building the docs plugin and generating CRD docs. To display the resulting reference pages in the docs, this change configures `docs/config.json` to generate the Reference section of the sidebar from the docs directory. This requires moving the Helm reference includes directory into `docs/pages/includes`. * Respond to hugoShaka feedback - Do not display the `status` field. - Indicate that enum fields can take an integer or a string. This is consistent with our comment conventions, which describe both the integer and the string values for each enum option. * Sort CRD reference page sections Also handle duplicate page sections by including the names of parent properties within section headings. * Fix crdgen Makefile targets - bring test data and hack out of `lib/` - fix broken debug builds - add crd-docs checks to the `crds-up-to-date` target - trigger proto lint on CRD and CRD doc changes - removed stale gitkeep in `docs/pages/includes/crd-docs/.gitkeep` - split crdgen formatting logic in another file for readability - update license header years on new files * fixup! Fix crdgen Makefile targets * lint files due to false positive 'generated' comment * fixup! lint files due to false positive 'generated' comment * Incorporate rosstimothy feedback Remove an unnecessary package. Also regenerate the CRD docs. * fix debug builds and gitignore * fixup! fix debug builds and gitignore * Respond to rosstimothy feedback Fix integrations/operator/crdgen/Makefile * Fix spelling * Fix flaky propertyTable test Compare the unsorted slice elements, since sorting takes place on the containing VersionSection. --------- Co-authored-by: hugoShaka <hugo.hervieux@goteleport.com>
ptgott
force-pushed
the
paul.gottschling/44107-bp-v16
branch
from
d7b3222 to
c52ae01
Compare
|
🤖 Vercel preview here: https://docs-b6m1ltcvj-goteleport.vercel.app/docs/ver/preview |
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backports #44107
We already pull JSON schema data from Teleport protobuf message definitions in order to generate CRD manifests. Extract a shared library from code within the existing protoc plugin for generating CRDs. This way, we can use the library to generate docs for our CRDs with a separate plugin, and don't need to complicate the interface for using the existing plugin.
integrations/crdgenintolibandcmddirectories, turninglibinto a package.generateSchemasignature to include a function that formats a CRD into a document, injecting separate functions for formatting the CRD as YAML and as a docs page.To display the resulting reference pages in the docs, this change configures
docs/config.jsonto generate the Reference section of the sidebar from the docs directory. This requires moving the Helm reference includes directory intodocs/pages/includes.statusfield.Also handle duplicate page sections by including the names of parent properties within section headings.
lib/crds-up-to-datetargetdocs/pages/includes/crd-docs/.gitkeepfixup! Fix crdgen Makefile targets
lint files due to false positive 'generated' comment
fixup! lint files due to false positive 'generated' comment
Incorporate rosstimothy feedback
Remove an unnecessary package.
Also regenerate the CRD docs.
fix debug builds and gitignore
fixup! fix debug builds and gitignore
Respond to rosstimothy feedback
Fix integrations/operator/crdgen/Makefile
Fix spelling
Fix flaky propertyTable test
Compare the unsorted slice elements, since sorting takes place on the containing VersionSection.