Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Add documentation about CRD versions and validation #4273

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cbandy merged 1 commit into CrunchyData:main from cbandy:crd-validation-doc
Oct 2, 2025

Conversation

Copy link
Member

@cbandy cbandy commented Sep 8, 2025
edited
Loading

This adds a README describing how Kubernetes names its API resources and how it stores their objects. The validation page has a dump of when/where CEL validation features are available.

@cbandy cbandy force-pushed the crd-validation-doc branch 2 times, most recently from 77e1885 to 5b7e68a Compare September 30, 2025 18:54
@cbandy cbandy changed the title (削除) WIP: docs about CEL validation features (削除ここまで) (追記) Add documentation about CRD versions and validation (追記ここまで) Sep 30, 2025
Comment on lines +14 to +15
- v1beta1 is compatible with Kubernetes 1.30, OpenShift 4.14, and later
- v1 uses newer CRD features and requires Kubernetes 1.30, OpenShift 4.17, and later
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 I added the Kubernetes versions we're targeting for the v1 API here.

benjaminjb reacted with heart emoji
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🌱 v1/README.md describes what versions of a CRD Kubernetes and kubectl present. It's not linked or included here.

@cbandy cbandy marked this pull request as ready for review September 30, 2025 19:07
```

<!--
```mermaid
Copy link
Contributor

@benjaminjb benjaminjb Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤷🏻 I wasn't sure how helpful this diagram would be, so I left it in and out simultaneously. 😁


<!--
```mermaid
venn
Copy link
Contributor

@benjaminjb benjaminjb Oct 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is Venn supported?

also

sets Kind label: request body "kind" 

? Too obvious? eh, no, that's covered by the union Group,Version,Kind

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is Venn supported?

Nope. Oh, the places we [could] go!

This is the syntax proposed in https://www.github.com/mermaid-js/mermaid/pull/5932

Copy link
Contributor

@benjaminjb benjaminjb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like technical documentation like this close to the code; I wonder how we keep this up to date -- I guess as we update this as we notice new things (from release changelogs, keps) OR when we need certain capabilities, we might have motivation to check for them and then add. I'm fine with this not being comprehensive.

cbandy reacted with thumbs up emoji
@cbandy cbandy merged commit ca7c3cd into CrunchyData:main Oct 2, 2025
19 checks passed
@cbandy cbandy deleted the crd-validation-doc branch October 2, 2025 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benjaminjb benjaminjb benjaminjb approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /