Help us shape the future of Go! Take the 2026 Go Developer Survey

platform

package
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 29, 2022 License: MIT Imports: 21 Imported by: 0

Documentation

Index

Constants

View Source
const DefaultDeploymentTimeout = 5 * time.Minute

Variables

View Source
var File_platform_output_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Config

type Config struct {
	Organisation             string             `hcl:"organisation"`
	Space                    string             `hcl:"space"`
	Docker                   *DockerConfig      `hcl:"docker,block"`
	Domain                   string             `hcl:"domain"`
	Quota                    *QuotaConfig       `hcl:"quota,block"`
	HealthCheck              *HealthCheckConfig `hcl:"health_check,block"`
	Env                      map[string]string  `hcl:"env,optional"`
	EnvFromFile              string             `hcl:"env_from_file,optional"`
	ServiceBindings          []string           `hcl:"service_bindings,optional"`
	DeploymentTimeoutSeconds string             `hcl:"deployment_timeout_seconds,optional"`
	// contains filtered or unexported fields
}

type Deployment

type Deployment struct {
	Url              string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	Id               string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	OrganisationGUID string `protobuf:"bytes,3,opt,name=OrganisationGUID,proto3" json:"OrganisationGUID,omitempty"`
	SpaceGUID        string `protobuf:"bytes,4,opt,name=SpaceGUID,proto3" json:"SpaceGUID,omitempty"`
	AppGUID          string `protobuf:"bytes,5,opt,name=AppGUID,proto3" json:"AppGUID,omitempty"`
	Name             string `protobuf:"bytes,6,opt,name=Name,proto3" json:"Name,omitempty"`
	// contains filtered or unexported fields
}

You can customise this message to change the fields for the output value from your Deployment

func (*Deployment) Descriptor deprecated

func (*Deployment) Descriptor() ([]byte, []int)

Deprecated: Use Deployment.ProtoReflect.Descriptor instead.

func (*Deployment) GetAppGUID

func (x *Deployment) GetAppGUID() string

func (*Deployment) GetId

func (x *Deployment) GetId() string

func (*Deployment) GetName

func (x *Deployment) GetName() string

func (*Deployment) GetOrganisationGUID

func (x *Deployment) GetOrganisationGUID() string

func (*Deployment) GetSpaceGUID

func (x *Deployment) GetSpaceGUID() string

func (*Deployment) GetUrl

func (x *Deployment) GetUrl() string

func (*Deployment) ProtoMessage

func (*Deployment) ProtoMessage()

func (*Deployment) ProtoReflect

func (x *Deployment) ProtoReflect() protoreflect.Message

func (*Deployment) Reset

func (x *Deployment) Reset()

func (*Deployment) String

func (x *Deployment) String() string

func (*Deployment) URL

func (x *Deployment) URL() string

type DeploymentState

type DeploymentState struct {
	// contains filtered or unexported fields
}

type DockerConfig

type DockerConfig struct {
	Username string `hcl:"username"`
}

type HealthCheckConfig

type HealthCheckConfig struct {
	Type              string `hcl:"type"`
	Endpoint          string `hcl:"endpoint,optional"`
	InvocationTimeout int64  `hcl:"invocation_timeout,optional"`
	Timeout           int64  `hcl:"timeout,optional"`
}

type HealthCheckParams

type HealthCheckParams struct {
	Type              constant.HealthCheckType
	Endpoint          string
	InvocationTimeout int64
	Timeout           int64
}

type Platform

type Platform struct {
	// contains filtered or unexported fields
}

func (*Platform) Config

func (p *Platform) Config() (interface{}, error)

Config implements Configurable

func (*Platform) ConfigSet

func (p *Platform) ConfigSet(config interface{}) error

ConfigSet implements ConfigurableNotify

func (*Platform) Deploy

func (*Platform) DeployFunc

func (p *Platform) DeployFunc() interface{}

DeployFunc implements Builder

func (*Platform) DestroyFunc

func (p *Platform) DestroyFunc() interface{}

DestroyFunc implements the Destroyer interface

func (*Platform) Generation

func (p *Platform) Generation() ([]byte, error)

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,
) (*proto.StatusReport, error)

func (*Platform) StatusFunc

func (p *Platform) StatusFunc() interface{}

type PlatformConfig

type PlatformConfig struct {
	ApiUrl      string `hcl:"api_url"`
	EncodedAuth string `hcl:"encoded_auth"`
}

type QuotaConfig

type QuotaConfig struct {
	Memory    string `hcl:"memory,optional"`
	Disk      string `hcl:"disk,optional"`
	Instances uint64 `hcl:"instances,optional"`
}

type QuotaParams

type QuotaParams struct {
	// contains filtered or unexported fields
}

type UserPasswordCredentials

type UserPasswordCredentials struct {
	Username string
	Password string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL