forked from operator-framework/operator-sdk
/
types.go
95 lines (78 loc) · 3.28 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
// Copyright 2018 The Operator-SDK Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package scaffold
import (
"path/filepath"
"strings"
"github.com/operator-framework/operator-sdk/internal/pkg/scaffold/input"
)
// Types is the input needed to generate a pkg/apis/<group>/<version>/<kind>_types.go file
type Types struct {
input.Input
// Resource defines the inputs for the new types file
Resource *Resource
}
func (s *Types) GetInput() (input.Input, error) {
if s.Path == "" {
s.Path = filepath.Join(ApisDir,
s.Resource.GoImportGroup,
strings.ToLower(s.Resource.Version),
s.Resource.LowerKind+"_types.go")
}
// Error if this file exists.
s.IfExistsAction = input.Error
s.TemplateBody = typesTemplate
return s.Input, nil
}
const typesTemplate = `package {{ .Resource.Version }}
import (
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// EDIT THIS FILE! THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required. Any new fields you add must have json tags for the fields to be serialized.
// {{.Resource.Kind}}Spec defines the desired state of {{.Resource.Kind}}
// +k8s:openapi-gen=true
type {{.Resource.Kind}}Spec struct {
// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
// Add custom validation using kubebuilder tags: https://book.kubebuilder.io/beyond_basics/generating_crd.html
}
// {{.Resource.Kind}}Status defines the observed state of {{.Resource.Kind}}
// +k8s:openapi-gen=true
type {{.Resource.Kind}}Status struct {
// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
// Important: Run "operator-sdk generate k8s" to regenerate code after modifying this file
// Add custom validation using kubebuilder tags: https://book.kubebuilder.io/beyond_basics/generating_crd.html
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// {{.Resource.Kind}} is the Schema for the {{ .Resource.Resource }} API
// +k8s:openapi-gen=true
// +kubebuilder:subresource:status
type {{.Resource.Kind}} struct {
metav1.TypeMeta ` + "`" + `json:",inline"` + "`" + `
metav1.ObjectMeta ` + "`" + `json:"metadata,omitempty"` + "`" + `
Spec {{.Resource.Kind}}Spec ` + "`" + `json:"spec,omitempty"` + "`" + `
Status {{.Resource.Kind}}Status ` + "`" + `json:"status,omitempty"` + "`" + `
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// {{.Resource.Kind}}List contains a list of {{.Resource.Kind}}
type {{.Resource.Kind}}List struct {
metav1.TypeMeta ` + "`" + `json:",inline"` + "`" + `
metav1.ListMeta ` + "`" + `json:"metadata,omitempty"` + "`" + `
Items []{{ .Resource.Kind }} ` + "`" + `json:"items"` + "`" + `
}
func init() {
SchemeBuilder.Register(&{{.Resource.Kind}}{}, &{{.Resource.Kind}}List{})
}
`