voyager

README

Voyager

Contributing

Pull requests, issues and comments welcome. For pull requests:

• Add tests for new features and bug fixes
• Follow the existing style
• Separate unrelated changes into multiple pull requests

See the existing issues for things to start contributing.

For bigger changes, make sure you start a discussion first by creating an issue and explaining the intended change.

Atlassian requires contributors to sign a Contributor License Agreement, known as a CLA. This serves as a record stating that the contributor is entitled to contribute the code/documentation/translation to the project and is willing to have it used in distributions and derivative works (or is willing to transfer ownership).

Prior to accepting your contributions we ask that you please follow the appropriate link below to digitally sign the CLA. The Corporate CLA is for those who are contributing as a member of an organization and the individual CLA is for those contributing as an individual.

• CLA for corporate contributors
• CLA for individuals

License

Copyright (c) 2018 Atlassian and others. Apache 2.0 licensed, see LICENSE file.

Documentation

Index

• Constants
• type Account
• type ClusterLocation
  • func (cl ClusterLocation) Location(label Label) Location
  • func (cl ClusterLocation) String() string
• type EnvType
• type Label
• type Location
  • func (l Location) ClusterLocation() ClusterLocation
  • func (l Location) String() string
• type Region
• type ResourceName
• type ResourceType
• type ServiceName
• type Tag

Constants

const (
	Domain      = "voyager.atl-paas.net"
	ScopeGlobal = "global"

	ServiceNameLabel  = Domain + "/serviceName"
	ServiceLabelLabel = Domain + "/label"
)

Types

type Account

type Account string

type ClusterLocation

type ClusterLocation struct {
	EnvType EnvType
	Account Account
	Region  Region
}

+genset=true

func (ClusterLocation) Location

func (cl ClusterLocation) Location(label Label) Location

func (ClusterLocation) String

func (cl ClusterLocation) String() string

type EnvType

type EnvType string

const (
	EnvTypeDev        EnvType = "dev"
	EnvTypeStaging    EnvType = "staging"
	EnvTypeProduction EnvType = "prod"
)

type Label

type Label string

type Location

type Location struct {
	EnvType EnvType `json:"envType"`
	Account Account `json:"account"`
	Region  Region  `json:"region"`
	// This is an 'environment/namespace' label, NOT a kubernetes label.
	Label Label `json:"label,omitempty"`
}

+genset=true

func (Location) ClusterLocation

func (l Location) ClusterLocation() ClusterLocation

func (Location) String

func (l Location) String() string

type Region

type Region string

type ResourceName

type ResourceName string

type ResourceType

type ResourceType string

type ServiceName

type ServiceName string

type Tag

type Tag string

This is basically an AWS tag.