Skip to content

Removes some steps that are now been built into kubebuidler #96

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 1 commit into from
May 22, 2020
Merged

Removes some steps that are now been built into kubebuidler #96

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
49 changes: 0 additions & 49 deletions docs/addon/walkthrough/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,55 +88,6 @@ manifests:
EOF
```

### Adding the framework into our types

We now want to plug the framework into our types, so that our CRs will look like
other addon operators.

We begin by editing the api type, we add some common fields. The idea is that
CommonSpec and CommonStatus form a common contract that we expect all addons to
support (and we can hopefully evolve the contract with just a recompile!)

Modify `api/v1alpha1/guestbook_types.go` to:

* add an import for `addonv1alpha1 "sigs.k8s.io/kubebuilder-declarative-pattern/pkg/patterns/addon/pkg/apis/v1alpha1"`
* add a field `addonv1alpha1.CommonSpec` to the Spec object
* add a field `addonv1alpha1.CommonStatus` to the Status object
* add the accessor functions (ComponentName, CommonSpec, ..)

Your `guestbook_types.go` file should now additionally contain:

```go
import addonv1alpha1 "sigs.k8s.io/kubebuilder-declarative-pattern/pkg/patterns/addon/pkg/apis/v1alpha1"

type GuestbookSpec struct {
addonv1alpha1.CommonSpec `json:",inline"`
}

type GuestbookStatus struct {
addonv1alpha1.CommonStatus `json:",inline"`
}

var _ addonv1alpha1.CommonObject = &Guestbook{}

func (c *Guestbook) ComponentName() string {
return "guestbook"
}

func (c *Guestbook) CommonSpec() addonv1alpha1.CommonSpec {
return c.Spec.CommonSpec
}

func (c *Guestbook) GetCommonStatus() addonv1alpha1.CommonStatus {
return c.Status.CommonStatus
}

func (c *Guestbook) SetCommonStatus(s addonv1alpha1.CommonStatus) {
c.Status.CommonStatus = s
}

```

### Using the framework in the controller

We replace the controller code `controllers/guestbook_controller.go`:
Expand Down