Skip to content

📖Add info about markers #2529

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.

Sign up for GitHub

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
merged 2 commits into from
Mar 8, 2022
Merged

📖Add info about markers #2529

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c2699c0
Add info about markers
sayantani11 Mar 7, 2022
e9860e6
alignment error
sayantani11 Mar 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/book/src/reference/markers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,19 @@ a marker name, optionally followed by some marker specific configuration:
// +kubebuilder:printcolumn:JSONPath=".status.replicas",name=Replicas,type=string
```

<aside class="note">
<h1>difference between `// +optional` and `// +kubebuilder:validation:Optional`</h1>

Controller-gen supports both (see the output of `controller-gen crd -www`). `+kubebuilder:validation:Optional` and `+optional` can be applied to fields.

But `+kubebuilder:validation:Optional` can also be applied at the package level such that it applies to every field in the package.

If you're using controller-gen only then they're redundant, but if you're using other generators or you want developers that need to build their own clients for your API, you'll want to also include `+optional`.

The most reliable way in 1.x to get `+optional` is `omitempty`.

</aside>

See each subsection for information about different types of code and YAML
generation.

Expand Down