remoteconfig

Documentation

Index

• Constants
• Variables
• type AppConfig
• type ApplicationDeployments
  • func (s *ApplicationDeployments) GetDeployment(appName, deploymentName string) (deployment Deployment)
  • func (s *ApplicationDeployments) ListApps() (appNameList []string)
  • func (s *ApplicationDeployments) ListDeployments(appName string) (deploymentList []string)
• type ConfigFetcher
  • func (s *ConfigFetcher) Fetch(filePath string) (buf *bytes.Buffer, err error)
  • func (s *ConfigFetcher) FetchConfig() (appD *ApplicationDeployments, err error)
  • func (s *ConfigFetcher) UseOauthClient()
• type Deployment
• type GithubContentResponse

Constants

const (
	//DefaultGithubURL - the default url for a github repo
	DefaultGithubURL = "https://api.github.com"
	//DownloadURLElement - element in json response used for file download
	DownloadURLElement = "download_url"
)

Variables

var (
	//DefaultConfigPath - the default path for the deployment config file
	DefaultConfigPath = "config.yml"
)

Types

type AppConfig

type AppConfig struct {
	Deployments []Deployment
}

AppConfig - a config object for a single app

type ApplicationDeployments

type ApplicationDeployments struct {
	Applications map[string]AppConfig
}

ApplicationDeployments - the root object for a config.yml

func (*ApplicationDeployments) GetDeployment

func (s *ApplicationDeployments) GetDeployment(appName, deploymentName string) (deployment Deployment)

GetDeployment - get the deployment details for the given app.deployment

func (*ApplicationDeployments) ListApps

func (s *ApplicationDeployments) ListApps() (appNameList []string)

ListApps - list the apps available in the configuration file

func (*ApplicationDeployments) ListDeployments

func (s *ApplicationDeployments) ListDeployments(appName string) (deploymentList []string)

ListDeployments - list the deployments available for the given application

type ConfigFetcher

type ConfigFetcher struct {
	GithubOauthToken string
	ClientRepo       ghClientDoer
	GithubURL        string
	GithubOrg        string
	Repo             string
	Branch           string
}

ConfigFetcher - an object that can fetch remote config files

func (*ConfigFetcher) Fetch

func (s *ConfigFetcher) Fetch(filePath string) (buf *bytes.Buffer, err error)

Fetch - executes a remote fetch against the given filepath in the repo

func (*ConfigFetcher) FetchConfig

func (s *ConfigFetcher) FetchConfig() (appD *ApplicationDeployments, err error)

FetchConfig - executes a fetch using the default configpath value and parses the response into a applicationDeployment object

func (*ConfigFetcher) UseOauthClient

func (s *ConfigFetcher) UseOauthClient()

UseOauthClient - adds the oauth2 github token to the client

type Deployment

type Deployment struct {
	Name    string
	URL     string
	Space   string
	Org     string
	Path    string
	PushCmd string `yaml:"push_cmd"`
}

Deployment - a deployment object

type GithubContentResponse

type GithubContentResponse struct {
	DownloadURL string `json:"download_url"`
}