Skip to content

Commit e0a173a

Browse files
committed
docs: update scaffold examples to current kubebuilder output
Signed-off-by: cprivitere <[email protected]>
1 parent 5ed0516 commit e0a173a

File tree

1 file changed

+17
-4
lines changed

1 file changed

+17
-4
lines changed

docs/book/src/developer/providers/getting-started/implement-api-types.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,16 @@ To enable clients to encode and decode your API, your types must be able to be r
7878
By default, Kubebuilder will provide you with a scheme builder like:
7979

8080
```go
81-
import "sigs.k8s.io/controller-runtime/pkg/scheme"
81+
import (
82+
"k8s.io/apimachinery/pkg/runtime/schema"
83+
"sigs.k8s.io/controller-runtime/pkg/scheme"
84+
)
8285

8386
var (
84-
// SchemeBuilder is used to add go types to the GroupVersionKind scheme
87+
// GroupVersion is group version used to register these objects.
88+
GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", Version: "v1alpha1"}
89+
90+
// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
8591
SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}
8692

8793
// AddToScheme adds the types in this group-version to the given scheme.
@@ -105,10 +111,17 @@ to be imported cleanly into other projects.
105111
To mitigate this, use the following schemebuilder pattern:
106112

107113
```go
108-
import "k8s.io/apimachinery/pkg/runtime"
114+
import (
115+
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
116+
"k8s.io/apimachinery/pkg/runtime"
117+
"k8s.io/apimachinery/pkg/runtime/schema"
118+
)
109119

110120
var (
111-
// schemeBuilder is used to add go types to the GroupVersionKind scheme.
121+
// GroupVersion is group version used to register these objects.
122+
GroupVersion = schema.GroupVersion{Group: "infrastructure.cluster.x-k8s.io", Version: "v1alpha1"}
123+
124+
// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
112125
schemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
113126

114127
// AddToScheme adds the types in this group-version to the given scheme.

0 commit comments

Comments
 (0)