Documentation
¶
Index ¶
- Constants
- type AptSource
- func (*AptSource) CheckChanges(a, e, changes *AptSource) error
- func (e *AptSource) Find(c *fi.Context) (*AptSource, error)
- func (f *AptSource) GetName() *string
- func (f *AptSource) RenderLocal(t *local.LocalTarget, a, e, changes *AptSource) error
- func (f *AptSource) Run(c *fi.Context) error
- func (f *AptSource) String() string
- type Archive
- func (_ *Archive) CheckChanges(a, e, changes *Archive) error
- func (e *Archive) Dir() string
- func (e *Archive) Find(c *fi.Context) (*Archive, error)
- func (e *Archive) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (e *Archive) GetName() *string
- func (_ *Archive) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Archive) error
- func (_ *Archive) RenderLocal(t *local.LocalTarget, a, e, changes *Archive) error
- func (e *Archive) Run(c *fi.Context) error
- func (e *Archive) String() string
- type BindMount
- func (s *BindMount) CheckChanges(a, e, changes *BindMount) error
- func (e *BindMount) Dir() string
- func (e *BindMount) Find(c *fi.Context) (*BindMount, error)
- func (e *BindMount) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (e *BindMount) GetName() *string
- func (_ *BindMount) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *BindMount) error
- func (_ *BindMount) RenderLocal(t *local.LocalTarget, a, e, changes *BindMount) error
- func (e *BindMount) Run(c *fi.Context) error
- func (s *BindMount) String() string
- type BootstrapCert
- type BootstrapClientTask
- type Chattr
- func (s *Chattr) CheckChanges(a, e, changes *Chattr) error
- func (e *Chattr) Find(c *fi.Context) (*Chattr, error)
- func (e *Chattr) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (e *Chattr) GetName() *string
- func (_ *Chattr) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Chattr) error
- func (_ *Chattr) RenderLocal(t *local.LocalTarget, a, e, changes *Chattr) error
- func (e *Chattr) Run(c *fi.Context) error
- func (s *Chattr) String() string
- type CreatesDir
- type Executor
- type File
- func (s *File) CheckChanges(a, e, changes *File) error
- func (f *File) Dir() string
- func (e *File) Find(c *fi.Context) (*File, error)
- func (e *File) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (f *File) GetName() *string
- func (_ *File) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *File) error
- func (_ *File) RenderLocal(t *local.LocalTarget, a, e, changes *File) error
- func (e *File) Run(c *fi.Context) error
- func (f *File) String() string
- type GroupTask
- func (_ *GroupTask) CheckChanges(a, e, changes *GroupTask) error
- func (e *GroupTask) Find(c *fi.Context) (*GroupTask, error)
- func (f *GroupTask) GetName() *string
- func (_ *GroupTask) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *GroupTask) error
- func (_ *GroupTask) RenderLocal(t *local.LocalTarget, a, e, changes *GroupTask) error
- func (e *GroupTask) Run(c *fi.Context) error
- func (e *GroupTask) String() string
- type IssueCert
- func (i *IssueCert) AddFileTasks(c *fi.ModelBuilderContext, dir string, name string, caName string, ...) error
- func (i *IssueCert) GetName() *string
- func (i *IssueCert) GetResources() (certResource, keyResource, caResource *fi.TaskDependentResource)
- func (e *IssueCert) Run(c *fi.Context) error
- func (i *IssueCert) String() string
- type KopsBootstrapClient
- type KubeConfig
- type LoadImageTask
- func (_ *LoadImageTask) CheckChanges(a, e, changes *LoadImageTask) error
- func (e *LoadImageTask) Find(c *fi.Context) (*LoadImageTask, error)
- func (t *LoadImageTask) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (t *LoadImageTask) GetName() *string
- func (_ *LoadImageTask) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *LoadImageTask) error
- func (_ *LoadImageTask) RenderLocal(t *local.LocalTarget, a, e, changes *LoadImageTask) error
- func (e *LoadImageTask) Run(c *fi.Context) error
- func (t *LoadImageTask) String() string
- type PKIXName
- type Package
- func (_ *Package) CheckChanges(a, e, changes *Package) error
- func (e *Package) Find(c *fi.Context) (*Package, error)
- func (e *Package) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (f *Package) GetName() *string
- func (_ *Package) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Package) error
- func (_ *Package) RenderLocal(t *local.LocalTarget, a, e, changes *Package) error
- func (e *Package) Run(c *fi.Context) error
- func (p *Package) String() string
- type Prefix
- func (_ *Prefix) CheckChanges(a, e, changes *Prefix) error
- func (e *Prefix) Find(c *fi.Context) (*Prefix, error)
- func (f *Prefix) GetName() *string
- func (_ *Prefix) RenderLocal(t *local.LocalTarget, a, e, changes *Prefix) error
- func (e *Prefix) Run(c *fi.Context) error
- func (p *Prefix) String() string
- type PullImageTask
- type Service
- func (s *Service) CheckChanges(a, e, changes *Service) error
- func (e *Service) Find(c *fi.Context) (*Service, error)
- func (p *Service) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (f *Service) GetName() *string
- func (s *Service) InitDefaults() *Service
- func (_ *Service) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Service) error
- func (_ *Service) RenderLocal(t *local.LocalTarget, a, e, changes *Service) error
- func (e *Service) Run(c *fi.Context) error
- func (s *Service) String() string
- type UpdatePackages
- func (s *UpdatePackages) CheckChanges(a, e, changes *UpdatePackages) error
- func (e *UpdatePackages) Find(c *fi.Context) (*UpdatePackages, error)
- func (p *UpdatePackages) GetDependencies(tasks map[string]fi.Task) []fi.Task
- func (_ *UpdatePackages) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *UpdatePackages) error
- func (_ *UpdatePackages) RenderLocal(t *local.LocalTarget, a, e, changes *UpdatePackages) error
- func (e *UpdatePackages) Run(c *fi.Context) error
- func (p *UpdatePackages) String() string
- type UserTask
- func (_ *UserTask) CheckChanges(a, e, changes *UserTask) error
- func (e *UserTask) Find(c *fi.Context) (*UserTask, error)
- func (f *UserTask) GetName() *string
- func (_ *UserTask) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *UserTask) error
- func (_ *UserTask) RenderLocal(t *local.LocalTarget, a, e, changes *UserTask) error
- func (e *UserTask) Run(c *fi.Context) error
- func (e *UserTask) String() string
Constants ¶
const ( // FileType_Symlink defines a symlink FileType_Symlink = "symlink" // FileType_Directory defines a directory FileType_Directory = "directory" // FileType_File is a regular file FileType_File = "file" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AptSource ¶ added in v1.21.3
func (*AptSource) CheckChanges ¶ added in v1.21.3
func (*AptSource) RenderLocal ¶ added in v1.21.3
func (f *AptSource) RenderLocal(t *local.LocalTarget, a, e, changes *AptSource) error
type Archive ¶ added in v1.10.0
type Archive struct {
Name string
// Source is the location for the archive
Source string `json:"source,omitempty"`
// Hash is the source tar
Hash string `json:"hash,omitempty"`
// TargetDir is the directory for extraction
TargetDir string `json:"target,omitempty"`
// StripComponents is the number of components to remove when expanding the archive
StripComponents int `json:"stripComponents,omitempty"`
// MapFiles is the list of files to extract with corresponding directories to extract
MapFiles map[string]string `json:"mapFiles,omitempty"`
}
Archive task downloads and extracts a tar file
func (*Archive) CheckChanges ¶ added in v1.10.0
CheckChanges implements fi.Task::CheckChanges
func (*Archive) GetDependencies ¶ added in v1.10.0
GetDependencies implements HasDependencies::GetDependencies
func (*Archive) RenderCloudInit ¶ added in v1.10.0
func (_ *Archive) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Archive) error
RenderCloudInit implements fi.Task::Render functionality for a CloudInit target
func (*Archive) RenderLocal ¶ added in v1.10.0
func (_ *Archive) RenderLocal(t *local.LocalTarget, a, e, changes *Archive) error
RenderLocal implements the fi.Task::Render functionality for a local target
type BindMount ¶ added in v1.10.0
type BindMount struct {
Source string `json:"source"`
Mountpoint string `json:"mountpoint"`
Options []string `json:"options,omitempty"`
Recursive bool `json:"recursive"`
}
BindMount performs bind mounts
func (*BindMount) CheckChanges ¶ added in v1.10.0
func (*BindMount) GetDependencies ¶ added in v1.10.0
GetDependencies implements HasDependencies::GetDependencies
func (*BindMount) RenderCloudInit ¶ added in v1.10.0
func (_ *BindMount) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *BindMount) error
func (*BindMount) RenderLocal ¶ added in v1.10.0
func (_ *BindMount) RenderLocal(t *local.LocalTarget, a, e, changes *BindMount) error
type BootstrapCert ¶ added in v1.19.0
type BootstrapCert struct {
Cert *fi.TaskDependentResource
Key *fi.TaskDependentResource
}
type BootstrapClientTask ¶ added in v1.21.0
type BootstrapClientTask struct {
// Certs are the requested certificates.
Certs map[string]*BootstrapCert
// KeypairIDs are the keypair IDs of the CAs to use for issuing certificates.
KeypairIDs map[string]string
// Client holds the client wrapper for the kops-bootstrap protocol
Client *KopsBootstrapClient
// contains filtered or unexported fields
}
func (*BootstrapClientTask) GetDependencies ¶ added in v1.21.0
func (*BootstrapClientTask) GetName ¶ added in v1.21.0
func (b *BootstrapClientTask) GetName() *string
func (*BootstrapClientTask) Run ¶ added in v1.21.0
func (b *BootstrapClientTask) Run(c *fi.Context) error
func (*BootstrapClientTask) String ¶ added in v1.21.0
func (b *BootstrapClientTask) String() string
type Chattr ¶ added in v1.15.1
type Chattr struct {
File string `json:"file"`
Mode string `json:"mode"`
Deps []fi.Task `json:"-"`
}
Chattr performs a chattr command, in particular to set a file as immutable
func (*Chattr) CheckChanges ¶ added in v1.15.1
func (*Chattr) GetDependencies ¶ added in v1.15.1
GetDependencies implements HasDependencies::GetDependencies
func (*Chattr) RenderCloudInit ¶ added in v1.15.1
func (_ *Chattr) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Chattr) error
func (*Chattr) RenderLocal ¶ added in v1.15.1
func (_ *Chattr) RenderLocal(t *local.LocalTarget, a, e, changes *Chattr) error
type CreatesDir ¶ added in v1.10.0
type CreatesDir interface {
Dir() string
}
CreatesDir is a marker interface for tasks that create directories, used for dependencies
type Executor ¶ added in v1.10.0
Executor allows execution of a command; it makes for testing of commands
type File ¶
type File struct {
AfterFiles []string `json:"afterFiles,omitempty"`
BeforeServices []string `json:"beforeServices,omitempty"`
Contents fi.Resource `json:"contents,omitempty"`
Group *string `json:"group,omitempty"`
IfNotExists bool `json:"ifNotExists,omitempty"`
Mode *string `json:"mode,omitempty"`
OnChangeExecute [][]string `json:"onChangeExecute,omitempty"`
Owner *string `json:"owner,omitempty"`
Path string `json:"path,omitempty"`
Symlink *string `json:"symlink,omitempty"`
Type string `json:"type"`
}
func (*File) CheckChanges ¶
func (*File) GetDependencies ¶
GetDependencies implements HasDependencies::GetDependencies
func (*File) RenderCloudInit ¶
func (_ *File) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *File) error
func (*File) RenderLocal ¶
func (_ *File) RenderLocal(t *local.LocalTarget, a, e, changes *File) error
type GroupTask ¶ added in v1.11.0
GroupTask is responsible for creating a group, by calling groupadd
func (*GroupTask) CheckChanges ¶ added in v1.11.0
func (*GroupTask) RenderCloudInit ¶ added in v1.11.0
func (_ *GroupTask) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *GroupTask) error
func (*GroupTask) RenderLocal ¶ added in v1.11.0
func (_ *GroupTask) RenderLocal(t *local.LocalTarget, a, e, changes *GroupTask) error
type IssueCert ¶ added in v1.19.0
type IssueCert struct {
Name string
Signer string `json:"signer"`
KeypairID string `json:"keypairID"`
Type string `json:"type"`
Subject PKIXName `json:"subject"`
AlternateNames []string `json:"alternateNames,omitempty"`
// IncludeRootCertificate will force the certificate data to include the full chain, not just the leaf
IncludeRootCertificate bool `json:"includeRootCertificate,omitempty"`
// contains filtered or unexported fields
}
func (*IssueCert) AddFileTasks ¶ added in v1.19.0
func (*IssueCert) GetResources ¶ added in v1.19.0
func (i *IssueCert) GetResources() (certResource, keyResource, caResource *fi.TaskDependentResource)
type KopsBootstrapClient ¶ added in v1.21.0
type KopsBootstrapClient struct {
// Authenticator generates authentication credentials for requests.
Authenticator bootstrap.Authenticator
// CAs are the CA certificates for kops-controller.
CAs []byte
// BaseURL is the base URL for the server
BaseURL url.URL
// Resolver is a custom resolver that supports resolution of hostnames without requiring DNS.
// In particular, this supports gossip mode.
Resolver resolver.Resolver
// contains filtered or unexported fields
}
func (*KopsBootstrapClient) QueryBootstrap ¶ added in v1.21.0
func (b *KopsBootstrapClient) QueryBootstrap(ctx context.Context, req *nodeup.BootstrapRequest) (*nodeup.BootstrapResponse, error)
type KubeConfig ¶ added in v1.19.0
type KubeConfig struct {
Name string
Cert fi.Resource
Key fi.Resource
CA fi.Resource
ServerURL string
// contains filtered or unexported fields
}
func (*KubeConfig) GetConfig ¶ added in v1.19.0
func (k *KubeConfig) GetConfig() *fi.TaskDependentResource
func (*KubeConfig) GetDependencies ¶ added in v1.19.0
func (*KubeConfig) GetName ¶ added in v1.19.0
func (k *KubeConfig) GetName() *string
func (*KubeConfig) String ¶ added in v1.19.0
func (k *KubeConfig) String() string
String returns a string representation, implementing the Stringer interface
type LoadImageTask ¶
LoadImageTask is responsible for downloading a docker image
func (*LoadImageTask) CheckChanges ¶
func (_ *LoadImageTask) CheckChanges(a, e, changes *LoadImageTask) error
func (*LoadImageTask) Find ¶
func (e *LoadImageTask) Find(c *fi.Context) (*LoadImageTask, error)
func (*LoadImageTask) GetDependencies ¶ added in v1.10.0
func (*LoadImageTask) GetName ¶ added in v1.18.0
func (t *LoadImageTask) GetName() *string
func (*LoadImageTask) RenderCloudInit ¶
func (_ *LoadImageTask) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *LoadImageTask) error
func (*LoadImageTask) RenderLocal ¶
func (_ *LoadImageTask) RenderLocal(t *local.LocalTarget, a, e, changes *LoadImageTask) error
func (*LoadImageTask) String ¶
func (t *LoadImageTask) String() string
type PKIXName ¶ added in v1.19.0
type PKIXName struct {
fi.NotADependency
CommonName string
Organization []string `json:",omitempty"`
}
PKIXName is a simplified form of pkix.Name, for better golden test output
type Package ¶
type Package struct {
Name string
Version *string `json:"version,omitempty"`
Source *string `json:"source,omitempty"`
Hash *string `json:"hash,omitempty"`
PreventStart *bool `json:"preventStart,omitempty"`
// Healthy is true if the package installation did not fail
Healthy *bool `json:"healthy,omitempty"`
// Additional dependencies that must be installed before this package.
// These will actually be passed together with this package to rpm/dpkg,
// which will then figure out the correct order in which to install them.
// This means that Deps don't get installed unless this package needs to
// get installed.
Deps []*Package `json:"deps,omitempty"`
}
func (*Package) CheckChanges ¶
func (*Package) GetDependencies ¶
GetDependencies computes dependencies for the package task
func (*Package) RenderCloudInit ¶
func (_ *Package) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Package) error
func (*Package) RenderLocal ¶
func (_ *Package) RenderLocal(t *local.LocalTarget, a, e, changes *Package) error
type Prefix ¶ added in v1.23.0
type Prefix struct {
Name string
}
func (*Prefix) CheckChanges ¶ added in v1.23.0
func (*Prefix) RenderLocal ¶ added in v1.23.0
func (_ *Prefix) RenderLocal(t *local.LocalTarget, a, e, changes *Prefix) error
type PullImageTask ¶ added in v1.21.0
PullImageTask is responsible for pulling a docker image
func (*PullImageTask) GetDependencies ¶ added in v1.21.0
func (*PullImageTask) GetName ¶ added in v1.21.0
func (t *PullImageTask) GetName() *string
type Service ¶
type Service struct {
Name string
Definition *string `json:"definition,omitempty"`
Running *bool `json:"running,omitempty"`
// Enabled configures the service to start at boot (or not start at boot)
Enabled *bool `json:"enabled,omitempty"`
ManageState *bool `json:"manageState,omitempty"`
SmartRestart *bool `json:"smartRestart,omitempty"`
}
func (*Service) CheckChanges ¶
func (*Service) GetDependencies ¶
func (*Service) InitDefaults ¶ added in v1.10.0
func (*Service) RenderCloudInit ¶
func (_ *Service) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *Service) error
func (*Service) RenderLocal ¶
func (_ *Service) RenderLocal(t *local.LocalTarget, a, e, changes *Service) error
type UpdatePackages ¶
type UpdatePackages struct {
// We can't be completely empty or we don't run
Updated bool
}
func NewUpdatePackages ¶ added in v1.4.1
func NewUpdatePackages() *UpdatePackages
func (*UpdatePackages) CheckChanges ¶
func (s *UpdatePackages) CheckChanges(a, e, changes *UpdatePackages) error
func (*UpdatePackages) Find ¶
func (e *UpdatePackages) Find(c *fi.Context) (*UpdatePackages, error)
func (*UpdatePackages) GetDependencies ¶
func (*UpdatePackages) RenderCloudInit ¶
func (_ *UpdatePackages) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *UpdatePackages) error
func (*UpdatePackages) RenderLocal ¶
func (_ *UpdatePackages) RenderLocal(t *local.LocalTarget, a, e, changes *UpdatePackages) error
func (*UpdatePackages) String ¶
func (p *UpdatePackages) String() string
type UserTask ¶
type UserTask struct {
Name string
UID int `json:"uid"`
Shell string `json:"shell"`
Home string `json:"home"`
}
UserTask is responsible for creating a user, by calling useradd
func (*UserTask) CheckChanges ¶
func (*UserTask) RenderCloudInit ¶
func (_ *UserTask) RenderCloudInit(t *cloudinit.CloudInitTarget, a, e, changes *UserTask) error
func (*UserTask) RenderLocal ¶
func (_ *UserTask) RenderLocal(t *local.LocalTarget, a, e, changes *UserTask) error