https://github.com/kamiazya/kubebuilder-playground
Playground that develops custom resource definition of k8s with kubebuilder.
https://github.com/kamiazya/kubebuilder-playground
golang k8s k8s-crd kubebuilder playground
Last synced: 5 days ago
JSON representation
Playground that develops custom resource definition of k8s with kubebuilder.
- Host: GitHub
- URL: https://github.com/kamiazya/kubebuilder-playground
- Owner: kamiazya
- Created: 2019-10-28T13:39:13.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-25T00:10:31.000Z (over 2 years ago)
- Last Synced: 2025-06-20T08:04:25.714Z (5 days ago)
- Topics: golang, k8s, k8s-crd, kubebuilder, playground
- Language: Go
- Homepage:
- Size: 91.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# kubebuilder-playground
Playground that develops custom resource definition of k8s with [kubebuilder](https://book.kubebuilder.io).
## Commands
### Install CRD
Install k8s CRD by using [kustomize](https://kustomize.io).
```bash
$ make install
${GOPATH}/bin//controller-gen "crd:trivialVersions=true" rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
kustomize build config/crd | kubectl apply -f -
customresourcedefinition.apiextensions.k8s.io/guestbooks.webapp.kubebuilder.kamiazya.tech created
```
### Create project
```bash
kubebuilder init --domain kubebuilder.kamiazya.tech
```
### Create API
```bash
kubebuilder create api --group webapp --version v1 --kind Guestbook
```
### Apply Sample Resource
```bash
# apply
$ kubectl apply -f config/samples/webapp_v1_guestbook.yaml
guestbook.webapp.kubebuilder.kamiazya.tech/guestbook-sample created
```
### Start Development
```bash
$ make run
${GOPATH}/bin/controller-gen object:headerFile=./hack/boilerplate.go.txt paths="./..."
go fmt ./...
go vet ./...
${GOPATH}/bin//controller-gen "crd:trivialVersions=true" rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=config/crd/bases
go run ./main.go
2019-10-29T20:57:32.772+0900 INFO controller-runtime.metrics metrics server is starting to listen {"addr": ":8080"}
2019-10-29T20:57:32.772+0900 INFO controller-runtime.controller Starting EventSource {"controller": "guestbook", "source": "kind source: /, Kind="}
2019-10-29T20:57:32.772+0900 INFO setup starting manager
2019-10-29T20:57:32.772+0900 INFO controller-runtime.manager starting metrics server {"path": "/metrics"}
2019-10-29T20:57:32.874+0900 INFO controller-runtime.controller Starting Controller {"controller": "guestbook"}
2019-10-29T20:57:32.974+0900 INFO controller-runtime.controller Starting workers {"controller": "guestbook", "worker count": 1}
2019-10-29T20:58:55.574+0900 DEBUG controller-runtime.controller Successfully Reconciled {"controller": "guestbook", "request": "default/guestbook-sample"}
...
```
`Ctrl + C` to stop.
### Get and Describe Resource
```bash
# get
$ kubectl get guestbook
NAME AGE
guestbook-sample 2m47s
$ kubectl describe guestbook guestbook-sample
Name: guestbook-sample
Namespace: default
Labels:
Annotations: kubectl.kubernetes.io/last-applied-configuration:
{"apiVersion":"webapp.kubebuilder.kamiazya.tech/v1","kind":"Guestbook","metadata":{"annotations":{},"name":"guestbook-sample","namespace":...
API Version: webapp.kubebuilder.kamiazya.tech/v1
Kind: Guestbook
Metadata:
Creation Timestamp: 2019-10-29T11:58:55Z
Generation: 1
Resource Version: 100219
Self Link: /apis/webapp.kubebuilder.kamiazya.tech/v1/namespaces/default/guestbooks/guestbook-sample
UID: 57d25e09-2a8f-40ad-9bd5-5444a610f23c
Spec:
Foo: bar
Events:
```