apis

Documentation

Overview

The apis package describes the comment directives that may be applied to apis / resources

Example

package main

import (
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func main() {}

// FooSpec defines the desired state of Foo
type FooSpec struct {
	// +kubebuilder:validation:Maximum=10
	// +kubebuilder:validation:ExclusiveMinimum=3
	Count int `json:"count"`
}

// FooStatus defines the observed state of Foo
type FooStatus struct{}

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

// Foo
// +k8s:openapi-gen=true
// +resource:path=foos
type Foo struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   FooSpec   `json:"spec,omitempty"`
	Status FooStatus `json:"status,omitempty"`
}

Index

• Constants

Examples

• Package

Constants

const ExclusiveMaximum = "// +kubebuilder:validation:ExclusiveMaximum="

ExclusiveMaximum annotates a go struct field for CRD validation

const ExclusiveMinimum = "// +kubebuilder:validation:ExclusiveMinimum="

ExclusiveMinimum annotates a go struct field for CRD validation

const Maximum = "// +kubebuilder:validation:Maximum="

Maximum annotates a go struct field for CRD validation

const Minimum = "// +kubebuilder:validation:Minimum="

Minimum annotates a go struct field for CRD validation

const Resource = "// +resource:path="

Resource annotates a type as a resource