Skip to content
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

Jump to bottom

kubebuilder/quickstart: add instruction for enabling status subresource #2897

Merged
merged 2 commits into from
Apr 24, 2020
Merged

kubebuilder/quickstart: add instruction for enabling status subresource #2897

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9704a79
kubebuilder/quickstart: add instruction for enabling status subresource
hasbro17 Apr 23, 2020
341dc17
remove link header for quickstart guide
hasbro17 Apr 24, 2020
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
23 changes: 17 additions & 6 deletions website/content/en/docs/kubebuilder/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
title: Golang Based Operator Quickstart
linkTitle: Quickstart
weight: 1
---

**NOTE:** This is a WIP doc for the Kubebuilder integration effort. This new CLI and workflow is currently alpha and there may be breaking changes.
Please refer to the [quickstart guide][legacy_quickstart_doc] for the default CLI and workflow.
Expand Down Expand Up @@ -109,6 +104,20 @@ type MemcachedStatus struct {
}
```

Add the `+kubebuilder:subresource:status` [marker][status_marker] to add a [status subresource][status_subresource] to the CRD manifest so that the controller can update the CR status without changing the rest of the CR object:

```Go
// Memcached is the Schema for the memcacheds API
// +kubebuilder:subresource:status
type Memcached struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`

Spec MemcachedSpec `json:"spec,omitempty"`
Status MemcachedStatus `json:"status,omitempty"`
}
```

After modifying the `*_types.go` file always run the following command to update the generated code for that resource type:

```sh
Expand Down Expand Up @@ -454,4 +463,6 @@ See the [advanced topics][advanced_topics] doc for more use cases and under the
[builder_godocs]: https://godoc.org/github.com/kubernetes-sigs/controller-runtime/pkg/builder#example-Builder
[legacy_quickstart_doc]: /docs/golang/quickstart/
[activate_modules]: https://github.com/golang/go/wiki/Modules#how-to-install-and-activate-module-support
[advanced_topics]: /docs/kubebuilder/advanced-topics/
[advanced_topics]: /docs/kubebuilder/advanced-topics/
[status_marker]: https://book.kubebuilder.io/reference/generating-crd.html#status
[status_subresource]: https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#status-subresource