app

Documentation

Index

• type Application
• type ArgoApp
• type CD
• type CDInfo
• type Credential
• type DashBoard
• type Output
  • func Load(path string) (*Output, error)
  • func (ao *Output) ConvertOutputToStatus() Status
• type Repo
• type SCM
• type Service
• type ServiceInfo
• type Status
• type TerraformVars
• type UserService

Types

type Application

type Application struct {
	Name string `json:"name"`
}

Application is info about the application itself.

type ArgoApp

type ArgoApp struct {
	Name        string `json:"name" yaml:"name"`
	Username    string `json:"username,omitempty" yaml:"username"`
	Password    string `json:"password,omitempty" yaml:"password"`
	URL         string `json:"url,omitempty" yaml:"url,omitempty"`
	Infra       string `json:"infra,omitempty" yaml:"infra,omitempty"`
	Prompt      string `json:"prompt,omitempty" yaml:"prompt,omitempty"`
	Type        string `json:"type" yaml:"type"`
	Annotations string `json:"annotations" yaml:"annotations"`
}

ArgoApp is argoCD application.

type CD

type CD struct {
	Provider       string     `json:"provider"`
	Namespace      string     `json:"namespace"`
	Type           string     `json:"type"`
	ApplicationRef []*ArgoApp `json:"applicationRef" yaml:"applicationRef"`
	DashBoardRef   DashBoard  `json:"dashboardRef" yaml:"dashboardRef"`
}

CD now only support argoCD.

type CDInfo

type CDInfo struct {
	Provider string `json:"provider" yaml:"provider"`
	URL      string `json:"url" yaml:"url"`
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`
}

CDInfo CD info

type Credential

type Credential struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

Credential for login to dashboard.

type DashBoard

type DashBoard struct {
	URL        string     `json:"url"`
	Credential Credential `json:"credential"`
}

DashBoard information of some component.

type Output

type Output struct {
	ApplicationRef Application `json:"application"`
	Services       []Service   `json:"services,omitempty"`
	CD             CD          `json:"cd,omitempty" yaml:"cd"`
	SCM            SCM         `json:"scm,omitempty" yaml:"scm"`
}

Output defines the output structure of `hln up` command.

func Load

func Load(path string) (*Output, error)

Load read and marshal the output yaml file. Deprecated

func (*Output) ConvertOutputToStatus

func (ao *Output) ConvertOutputToStatus() Status

ConvertOutputToStatus Convert Output To Status

type Repo

type Repo struct {
	Name          string        `json:"name"`
	Visibility    string        `json:"visibility"`
	URL           string        `json:"url"`
	TerraformVars TerraformVars `json:"terraformVars" yaml:"terraformVars"`
}

Repo is a source code repository.

type SCM

type SCM struct {
	Provider     string  `json:"provider"`
	Manager      string  `json:"manager"`
	TfProvider   string  `json:"tfProvider" yaml:"tfProvider"`
	Organization string  `json:"organization"`
	Repos        []*Repo `json:"repos"`
}

SCM is source code manager like github.

type Service

type Service struct {
	Name string `json:"name"`
	URL  string `json:"url" yaml:"url"`
	Type string `json:"type" yaml:"type"`
}

Service of your app.

type ServiceInfo

type ServiceInfo struct {
	Name     string `json:"name,omitempty"`
	Type     string `json:"type,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	URL      string `json:"url"`
	Infra    string `json:"infra"`
	Prompt   string `json:"prompt"`
}

ServiceInfo service info

type Status

type Status struct {
	AppName         string // Heighliner app name
	CD              CDInfo
	Services        []ServiceInfo // addon service
	UserServices    []UserService
	SCM             SCM
	TFConfigMapName string
}

Status app status

type TerraformVars

type TerraformVars struct {
	Suffix    string `json:"suffix"`
	Namespace string `json:"namespace"`
}

TerraformVars for deleting repo.

type UserService

type UserService struct {
	Service
	*Repo
}

UserService user service