sigs.k8s.io/kubebuilder/v3@v3.14.0/pkg/plugins/golang/v2/scaffolds/internal/templates/config/samples/crd_sample.go (about)

     1  /*
     2  Copyright 2018 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package samples
    18  
    19  import (
    20  	"path/filepath"
    21  
    22  	"sigs.k8s.io/kubebuilder/v3/pkg/machinery"
    23  )
    24  
    25  var _ machinery.Template = &CRDSample{}
    26  
    27  // CRDSample scaffolds a file that defines a sample manifest for the CRD
    28  type CRDSample struct {
    29  	machinery.TemplateMixin
    30  	machinery.ResourceMixin
    31  
    32  	Force bool
    33  }
    34  
    35  // SetTemplateDefaults implements file.Template
    36  func (f *CRDSample) SetTemplateDefaults() error {
    37  	if f.Path == "" {
    38  		f.Path = filepath.Join("config", "samples", "%[group]_%[version]_%[kind].yaml")
    39  	}
    40  	f.Path = f.Resource.Replacer().Replace(f.Path)
    41  
    42  	if f.Force {
    43  		f.IfExistsAction = machinery.OverwriteFile
    44  	} else {
    45  		f.IfExistsAction = machinery.Error
    46  	}
    47  
    48  	f.TemplateBody = crdSampleTemplate
    49  
    50  	return nil
    51  }
    52  
    53  const crdSampleTemplate = `apiVersion: {{ .Resource.QualifiedGroup }}/{{ .Resource.Version }}
    54  kind: {{ .Resource.Kind }}
    55  metadata:
    56    name: {{ lower .Resource.Kind }}-sample
    57  spec:
    58    # TODO(user): Add fields here
    59  `