describe

package
v0.1.0 Latest Latest
Warning

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

 Go to latest Published: Jun 25, 2020 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func IsStackNotExistsErr added in v0.0.8 

func IsStackNotExistsErr(err error) bool

IsStackNotExistsErr returns true if error type is stack not exist.

Types

type App added in v0.1.0 

type App struct {
	Name     string                `json:"name"`
	URI      string                `json:"uri"`
	Envs     []*config.Environment `json:"environments"`
	Services []*config.Service     `json:"services"`
}

App contains serialized parameters for an application.

func (*App) HumanString added in v0.1.0 

func (a *App) HumanString() string

HumanString returns the stringified App struct with human readable format.

func (*App) JSONString added in v0.1.0 

func (a *App) JSONString() (string, error)

JSONString returns the stringified App struct with json format.

type BackendServiceDescriber added in v0.1.0 

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

BackendServiceDescriber retrieves information about a backend service.

func NewBackendServiceDescriber added in v0.1.0 

func NewBackendServiceDescriber(app, svc string) (*BackendServiceDescriber, error)

NewBackendServiceDescriber instantiates a backend service describer.

func NewBackendServiceDescriberWithResources added in v0.1.0 

func NewBackendServiceDescriberWithResources(app, svc string) (*BackendServiceDescriber, error)

NewBackendServiceDescriberWithResources instantiates a backend service describer with stack resources.

func (*BackendServiceDescriber) Describe added in v0.1.0 

func (d *BackendServiceDescriber) Describe() (HumanJSONStringer, error)

Describe returns info of a backend service.

func (*BackendServiceDescriber) URI added in v0.1.0 

func (d *BackendServiceDescriber) URI(envName string) (string, error)

URI returns the service discovery namespace and is used to make BackendServiceDescriber have the same signature as WebServiceDescriber.

type CfnResource added in v0.0.5 

type CfnResource struct {
	Type       string `json:"type"`
	PhysicalID string `json:"physicalID"`
}

CfnResource contains application resources created by cloudformation.

func (CfnResource) HumanString added in v0.1.0 

func (c CfnResource) HumanString() string

type EnvDescriber added in v0.0.8 

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

EnvDescriber retrieves information about an environment.

func NewEnvDescriber added in v0.0.8 

func NewEnvDescriber(appName, envName string) (*EnvDescriber, error)

NewEnvDescriber instantiates an environment describer.

func NewEnvDescriberWithResources added in v0.1.0 

func NewEnvDescriberWithResources(appName, envName string) (*EnvDescriber, error)

NewEnvDescriberWithResources instantiates an environment describer with stack resources.

func (*EnvDescriber) Describe added in v0.0.8 

func (e *EnvDescriber) Describe() (*EnvDescription, error)

Describe returns info about an application's environment.

type EnvDescription added in v0.0.8 

type EnvDescription struct {
	Environment *config.Environment `json:"environment"`
	Services    []*config.Service   `json:"services"`
	Tags        map[string]string   `json:"tags,omitempty"`
	Resources   []*CfnResource      `json:"resources,omitempty"`
}

EnvDescription contains the information about an environment.

func (*EnvDescription) HumanString added in v0.0.8 

func (e *EnvDescription) HumanString() string

HumanString returns the stringified EnvDescription struct with human readable format.

func (*EnvDescription) JSONString added in v0.0.8 

func (e *EnvDescription) JSONString() (string, error)

JSONString returns the stringified EnvDescription struct with json format.

type EnvVars added in v0.0.8 

type EnvVars struct {
	Environment string `json:"environment"`
	Name        string `json:"name"`
	Value       string `json:"value"`
}

EnvVars contains serialized environment variables for a service.

type HumanJSONStringer added in v0.0.8 

type HumanJSONStringer interface {
	HumanString() string
	JSONString() (string, error)
}

HumanJSONStringer contains methods that stringify app info for output.

type Pipeline added in v0.1.0 

type Pipeline struct {
	codepipeline.Pipeline

	Resources []*CfnResource `json:"resources,omitempty"`
}

Project contains serialized parameters for a pipeline.

func (*Pipeline) HumanString added in v0.1.0 

func (p *Pipeline) HumanString() string

HumanString returns the stringified Pipeline struct with human readable format.

func (*Pipeline) JSONString added in v0.1.0 

func (p *Pipeline) JSONString() (string, error)

JSONString returns the stringified Pipeline struct with JSON format.

type PipelineDescriber added in v0.1.0 

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

PipelineDescriber retrieves information about an application.

func NewPipelineDescriber added in v0.1.0 

func NewPipelineDescriber(pipelineName string, showResources bool) (*PipelineDescriber, error)

NewPipelineDescriber instantiates a new pipeline describer

func (*PipelineDescriber) Describe added in v0.1.0 

func (d *PipelineDescriber) Describe() (HumanJSONStringer, error)

type PipelineStatus added in v0.1.0 

type PipelineStatus struct {
	codepipeline.PipelineState
}

PipelineStatus contains the status for a pipeline.

func (PipelineStatus) HumanString added in v0.1.0 

func (p PipelineStatus) HumanString() string

func (PipelineStatus) JSONString added in v0.1.0 

func (p PipelineStatus) JSONString() (string, error)

type PipelineStatusDescriber added in v0.1.0 

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

PipelineStatus retrieves status of a pipeline.

func NewPipelineStatusDescriber added in v0.1.0 

func NewPipelineStatusDescriber(pipelineName string) (*PipelineStatusDescriber, error)

NewPipelineStatus instantiates a new PipelineStatus struct.

func (*PipelineStatusDescriber) Describe added in v0.1.0 

func (d *PipelineStatusDescriber) Describe() (HumanJSONStringer, error)

Describe returns status of a pipeline.

type ServiceConfig added in v0.1.0 

type ServiceConfig struct {
	Environment string `json:"environment"`
	Port        string `json:"port"`
	Tasks       string `json:"tasks"`
	CPU         string `json:"cpu"`
	Memory      string `json:"memory"`
}

ServiceConfig contains serialized configuration parameters for a service.

type ServiceDescriber added in v0.1.0 

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

ServiceDescriber retrieves information about a service.

func NewServiceDescriber added in v0.1.0 

func NewServiceDescriber(app, env, svc string) (*ServiceDescriber, error)

NewServiceDescriber instantiates a new service.

func (*ServiceDescriber) EnvOutputs added in v0.1.0 

func (d *ServiceDescriber) EnvOutputs() (map[string]string, error)

EnvOutputs returns the output of the environment stack.

func (*ServiceDescriber) EnvVars added in v0.1.0 

func (d *ServiceDescriber) EnvVars() (map[string]string, error)

EnvVars returns the environment variables of the task definition.

func (*ServiceDescriber) GetServiceArn added in v0.1.0 

func (d *ServiceDescriber) GetServiceArn() (*ecs.ServiceArn, error)

GetServiceArn returns the ECS service ARN of the service in an environment.

func (*ServiceDescriber) Params added in v0.1.0 

func (d *ServiceDescriber) Params() (map[string]string, error)

Params returns the parameters of the service stack.

func (*ServiceDescriber) ServiceStackResources added in v0.1.0 

func (d *ServiceDescriber) ServiceStackResources() ([]*cloudformation.StackResource, error)

ServiceStackResources returns the filtered service stack resources created by CloudFormation.

type ServiceDiscovery added in v0.0.8 

type ServiceDiscovery struct {
	Environment []string `json:"environment"`
	Namespace   string   `json:"namespace"`
}

ServiceDiscovery contains serialized service discovery info for an service.

type ServiceStatus added in v0.1.0 

type ServiceStatus struct {
	AppName string
	EnvName string
	SvcName string

	Describer serviceArnGetter
	EcsSvc    ecsServiceGetter
	CwSvc     alarmStatusGetter
}

ServiceStatus retrieves status of a service.

func NewServiceStatus added in v0.1.0 

func NewServiceStatus(appName, envName, svcName string) (*ServiceStatus, error)

NewServiceStatus instantiates a new ServiceStatus struct.

func (*ServiceStatus) Describe added in v0.1.0 

func (w *ServiceStatus) Describe() (*ServiceStatusDesc, error)

Describe returns status of a service.

type ServiceStatusDesc added in v0.1.0 

type ServiceStatusDesc struct {
	Service ecs.ServiceStatus        `json:",flow"`
	Tasks   []ecs.TaskStatus         `json:"tasks"`
	Alarms  []cloudwatch.AlarmStatus `json:"alarms"`
}

ServiceStatusDesc contains the status for a service.

func (*ServiceStatusDesc) HumanString added in v0.1.0 

func (w *ServiceStatusDesc) HumanString() string

HumanString returns the stringified ServiceStatusDesc struct with human readable format.

func (*ServiceStatusDesc) JSONString added in v0.1.0 

func (w *ServiceStatusDesc) JSONString() (string, error)

JSONString returns the stringified ServiceStatusDesc struct with json format.

type WebServiceDescriber added in v0.1.0 

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

WebServiceDescriber retrieves information about a load balanced web service.

func NewWebServiceDescriber added in v0.1.0 

func NewWebServiceDescriber(app, svc string) (*WebServiceDescriber, error)

NewWebServiceDescriber instantiates a load balanced service describer.

func NewWebServiceDescriberWithResources added in v0.1.0 

func NewWebServiceDescriberWithResources(app, svc string) (*WebServiceDescriber, error)

NewWebServiceDescriberWithResources instantiates a load balanced service with stack resources.

func (*WebServiceDescriber) Describe added in v0.1.0 

func (d *WebServiceDescriber) Describe() (HumanJSONStringer, error)

Describe returns info of a web service.

func (*WebServiceDescriber) URI added in v0.1.0 

func (d *WebServiceDescriber) URI(envName string) (string, error)

URI returns the WebServiceURI to identify this service uniquely given an environment name.

type WebServiceRoute added in v0.1.0 

type WebServiceRoute struct {
	Environment string `json:"environment"`
	URL         string `json:"url"`
}

WebServiceRoute contains serialized route parameters for a web service.

type WebServiceURI added in v0.1.0 

type WebServiceURI struct {
	DNSName string // The environment's subdomain if the service is served on HTTPS. Otherwise, the public load balancer's DNS.
	Path    string // Empty if the service is served on HTTPS. Otherwise, the pattern used to match the service.
}

WebServiceURI represents the unique identifier to access a web service.

func (*WebServiceURI) String added in v0.1.0 

func (uri *WebServiceURI) String() string

Source Files

View all Source files

Directories

Path Synopsis
Package mocks is a generated GoMock package.
 Package mocks is a generated GoMock package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.