Documentation
¶
Overview ¶
Copyright 2020 The Kubernetes 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.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DockerIgnore ¶
type DockerIgnore struct {
machinery.TemplateMixin
}
DockerIgnore scaffolds a file that defines which files should be ignored by the containerized build process
func (*DockerIgnore) SetTemplateDefaults ¶
func (f *DockerIgnore) SetTemplateDefaults() error
SetTemplateDefaults implements file.Template
type Dockerfile ¶
type Dockerfile struct {
machinery.TemplateMixin
}
Dockerfile scaffolds a file that defines the containerized build process
func (*Dockerfile) SetTemplateDefaults ¶
func (f *Dockerfile) SetTemplateDefaults() error
SetTemplateDefaults implements file.Template
type GitIgnore ¶
type GitIgnore struct {
machinery.TemplateMixin
}
GitIgnore scaffolds the .gitignore file
func (*GitIgnore) SetTemplateDefaults ¶
SetTemplateDefaults implements machinery.Template
type GoMod ¶
type GoMod struct {
machinery.TemplateMixin
machinery.RepositoryMixin
ControllerRuntimeVersion string
}
GoMod scaffolds a file that defines the project dependencies
func (*GoMod) SetTemplateDefaults ¶
SetTemplateDefaults implements file.Template
type Main ¶
type Main struct {
machinery.TemplateMixin
machinery.BoilerplateMixin
machinery.DomainMixin
machinery.RepositoryMixin
machinery.ComponentConfigMixin
}
Main scaffolds a file that defines the controller manager entry point
func (*Main) SetTemplateDefaults ¶
SetTemplateDefaults implements file.Template
type MainUpdater ¶
type MainUpdater struct {
machinery.RepositoryMixin
machinery.MultiGroupMixin
machinery.ResourceMixin
// Flags to indicate which parts need to be included when updating the file
WireResource, WireController, WireWebhook bool
}
MainUpdater updates main.go to run Controllers
func (*MainUpdater) GetCodeFragments ¶
func (f *MainUpdater) GetCodeFragments() machinery.CodeFragmentsMap
GetCodeFragments implements file.Inserter
func (*MainUpdater) GetIfExistsAction ¶
func (*MainUpdater) GetIfExistsAction() machinery.IfExistsAction
GetIfExistsAction implements file.Builder
func (*MainUpdater) GetMarkers ¶
func (f *MainUpdater) GetMarkers() []machinery.Marker
GetMarkers implements file.Inserter
type Makefile ¶
type Makefile struct {
machinery.TemplateMixin
// Image is controller manager image name
Image string
// Kustomize version to use in the project
KustomizeVersion string
// BoilerplatePath is the path to the boilerplate file
BoilerplatePath string
// Controller tools version to use in the project
ControllerToolsVersion string
// ControllerRuntimeVersion version to use in the project
ControllerRuntimeVersion string
// HybridOperatorVersion is the version of the hybrid oeprator binary downloaded by Makefile
HybridOperatorVersion string
}
Makefile scaffolds the Makefile
func (*Makefile) SetTemplateDefaults ¶
SetTemplateDefaults implements machinery.Template
type Watches ¶
type Watches struct {
machinery.TemplateMixin
}
Watches scaffolds the watches.yaml file
func (*Watches) SetTemplateDefaults ¶
SetTemplateDefaults implements machinery.Template
type WatchesUpdater ¶
type WatchesUpdater struct {
machinery.ResourceMixin
ChartPath string
}
func (*WatchesUpdater) GetCodeFragments ¶
func (f *WatchesUpdater) GetCodeFragments() machinery.CodeFragmentsMap
func (*WatchesUpdater) GetIfExistsAction ¶
func (*WatchesUpdater) GetIfExistsAction() machinery.IfExistsAction
func (*WatchesUpdater) GetMarkers ¶
func (f *WatchesUpdater) GetMarkers() []machinery.Marker
func (*WatchesUpdater) GetPath ¶
func (*WatchesUpdater) GetPath() string
Source Files
Directories