Skip to content

Latest commit

 

History

History
46 lines (31 loc) · 1.27 KB

adding_non_namespaced_resources.md

File metadata and controls

46 lines (31 loc) · 1.27 KB
Raw

Adding non-namespaced resources

This document covers how to create a non-namespaced resource using apiserver-boot.

Prerequisites

Creating a non-namespaced resource with apiserver-boot

Use the --non-namespaced=true flag when creating a resource:

apiserver-boot create group version resource --non-namespaced=true --group <group> --version <version> --kind <Kind>

Non-namespaced resources

Non-namespaced resources have the following differences from namespaced resources:

  • nonNamespaced comment directive above the type
    • // +nonNamespaced=true comment under // +genclient=true
  • Strategy and StatusStrategy override NamespacedScoped to false
    • func ({{.Kind}}Strategy) NamespaceScoped() bool { return false }
    • func ({{.Kind}}StatusStrategy) NamespaceScoped() bool { return false }
  • Do not provide namespace when creating the client from a clientset

Example:

// +genclient=true
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +nonNamespaced=true

// +resource:path=foos
// +k8s:openapi-gen=true
// Foo defines some thing
type Foo struct {
...
}

...

func (FooStrategy) NamespaceScoped() bool { return false }

func (FooStatusStrategy) NamespaceScoped() bool { return false }