Documentation
¶
Index ¶
- Variables
- type Config
- type Deployment
- type Platform
- func (p *Platform) Config() (interface{}, error)
- func (p *Platform) Deploy(ctx context.Context, log hclog.Logger, ...) (*Deployment, error)
- func (p *Platform) DeployFunc() interface{}
- func (p *Platform) Destroy(ctx context.Context, log hclog.Logger, deployment *Deployment, ui terminal.UI) error
- func (p *Platform) DestroyFunc() interface{}
- func (p *Platform) Documentation() (*docs.Documentation, error)
- func (p *Platform) Generation(ctx context.Context) ([]byte, error)
- func (p *Platform) GenerationFunc() interface{}
- func (p *Platform) Status(ctx context.Context, log hclog.Logger, deployment *Deployment, ui terminal.UI) (*sdk.StatusReport, error)
- func (p *Platform) StatusFunc() interface{}
Constants ¶
This section is empty.
Variables ¶
View Source
var File_waypoint_builtin_k8s_helm_plugin_proto protoreflect.FileDescriptor
View Source
var Options = []sdk.Option{
sdk.WithComponents(&Platform{}),
}
Options are the SDK options to use for instantiation for the plugin.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
Name string `hcl:"name,attr"`
Repository string `hcl:"repository,optional"`
Chart string `hcl:"chart,attr"`
Version string `hcl:"version,optional"`
Devel bool `hcl:"devel,optional"`
Values []string `hcl:"values,optional"`
Set []*struct {
Name string `hcl:"name,attr"`
Value string `hcl:"value,attr"`
Type string `hcl:"type,optional"`
} `hcl:"set,block"`
Driver string `hcl:"driver,optional"`
Namespace string `hcl:"namespace,optional"`
KubeconfigPath string `hcl:"kubeconfig,optional"`
Context string `hcl:"context,optional"`
CreateNamespace bool `hcl:"create_namespace,optional"`
SkipCRDs bool `hcl:"skip_crds,optional"`
}
Config is the configuration structure for the Platform.
For docs on the fields, please see the Documentation function.
type Deployment ¶
type Deployment struct {
// Release is the Helm release name.
Release string `protobuf:"bytes,1,opt,name=release,proto3" json:"release,omitempty"`
// contains filtered or unexported fields
}
func (*Deployment) Descriptor
deprecated
func (*Deployment) Descriptor() ([]byte, []int)
Deprecated: Use Deployment.ProtoReflect.Descriptor instead.
func (*Deployment) GetRelease ¶
func (x *Deployment) GetRelease() string
func (*Deployment) ProtoMessage ¶
func (*Deployment) ProtoMessage()
func (*Deployment) ProtoReflect ¶
func (x *Deployment) ProtoReflect() protoreflect.Message
type Platform ¶
type Platform struct {
// contains filtered or unexported fields
}
Platform is the Platform implementation
func (*Platform) Config ¶
func (p *Platform) Config() (interface{}, error)
Config implements Configurable
func (*Platform) Deploy ¶
func (p *Platform) Deploy(
ctx context.Context,
log hclog.Logger,
deployConfig *component.DeploymentConfig,
ui terminal.UI,
) (*Deployment, error)
Deploy deploys to Kubernetes
func (*Platform) DeployFunc ¶
func (p *Platform) DeployFunc() interface{}
DeployFunc implements component.Platform
func (*Platform) Destroy ¶
func (p *Platform) Destroy(
ctx context.Context,
log hclog.Logger,
deployment *Deployment,
ui terminal.UI,
) error
Destroy
func (*Platform) DestroyFunc ¶
func (p *Platform) DestroyFunc() interface{}
DestroyFunc implements component.Destroyer
func (*Platform) Documentation ¶
func (p *Platform) Documentation() (*docs.Documentation, error)
func (*Platform) Generation ¶
func (p *Platform) Generation(
ctx context.Context,
) ([]byte, error)
Generation returns the generation ID.
func (*Platform) GenerationFunc ¶
func (p *Platform) GenerationFunc() interface{}
GenerationFunc implements component.Generation
func (*Platform) Status ¶
func (p *Platform) Status(
ctx context.Context,
log hclog.Logger,
deployment *Deployment,
ui terminal.UI,
) (*sdk.StatusReport, error)
func (*Platform) StatusFunc ¶
func (p *Platform) StatusFunc() interface{}
Click to show internal directories.
Click to hide internal directories.