You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-19Lines changed: 15 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,8 +4,6 @@
4
4
*Don't use `go get` / `go install`, instead you MUST download a tar binary release or create your own release using
5
5
the release program.* To build your own release see [CONTRIBUTING.md](CONTRIBUTING.md)
6
6
7
-
## Releases
8
-
9
7
## `kubebuilder`
10
8
11
9
Kubebuilder is a framework for building Kubernetes APIs using [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions).
@@ -15,27 +13,25 @@ to simplify building and publishing Kubernetes APIs from scratch.
@@ -53,11 +49,11 @@ Kubebuilder attempts to facilitate the following developer workflow for building
53
49
5. Update bootstrapped integration tests to test new fields and business logic
54
50
6. Build and publish a container from the provided Dockerfile
55
51
56
-
###Scope
52
+
## Scope
57
53
58
54
Building APIs using CRDs, Controllers and Admission Webhooks.
59
55
60
-
###Philosophy
56
+
## Philosophy
61
57
62
58
Provide clean library abstractions with clear and well exampled godocs.
63
59
@@ -66,7 +62,7 @@ Provide clean library abstractions with clear and well exampled godocs.
66
62
- Prefer *1 time init* of stubs over forked and modified boilerplate
67
63
- Never fork and modify boilerplate
68
64
69
-
###Techniques
65
+
## Techniques
70
66
71
67
- Provide higher level libraries on top of low level client libraries
72
68
- Protect developers from breaking changes in low level libraries
@@ -76,11 +72,11 @@ Provide clean library abstractions with clear and well exampled godocs.
76
72
- Driven off of `//+` comments
77
73
- Provide bootstrapping commands to initialize new packages
78
74
79
-
###Troubleshooting
75
+
## Troubleshooting
80
76
81
-
-####Bugs and Feature Requests:
77
+
-### Bugs and Feature Requests:
82
78
If you have what looks like a bug, or you would like to make a feature request, please use the [Github issue tracking system.](https://github.com/kubernetes-sigs/kubebuilder/issues)
83
79
Before you file an issue, please search existing issues to see if your issue is already covered.
84
80
85
-
-####Slack
81
+
-### Slack
86
82
For realtime discussion, you can join the [#kubebuilder](https://slack.k8s.io/#kubebuilder) slack channel. Slack requires registration, but the Kubernetes team is open invitation to anyone to register here. Feel free to come and ask any questions.
0 commit comments