config

Documentation

Index

• Constants
• Variables
• func GetConfigDirectory() (string, error)
• func GetConfigFilePath() (string, error)
• type AccessRequestsJiraConfiguration
• type BackplaneConfiguration
  • func GetBackplaneConfiguration() (bpConfig BackplaneConfiguration, err error)
  • func (config BackplaneConfiguration) CheckAPIConnection() error
  • func (config *BackplaneConfiguration) GetBackplaneURL() (string, error)
• type JiraTransitionsNamesForAccessRequests

Constants

const (
	JiraTokenViperKey              = "jira-token"
	JiraConfigForAccessRequestsKey = "jira-config-for-access-requests"

	JiraBaseURLDefaultValue = "https://issues.redhat.com"
)

Variables

var JiraConfigForAccessRequestsDefaultValue = AccessRequestsJiraConfiguration{
	DefaultProject:   "SDAINT",
	DefaultIssueType: "Story",
	ProdProject:      "OHSS",
	ProdIssueType:    "Incident",
	ProjectToTransitionsNames: map[string]JiraTransitionsNamesForAccessRequests{
		"SDAINT": {
			OnCreation: "In Progress",
			OnApproval: "In Progress",
			OnError:    "Closed",
		},
		"OHSS": {
			OnCreation: "Pending Customer",
			OnApproval: "New",
			OnError:    "Cancelled",
		},
	},
}

Functions

func GetConfigDirectory

func GetConfigDirectory() (string, error)

GetConfigDirectory returns the backplane config path

func GetConfigFilePath

func GetConfigFilePath() (string, error)

GetConfigFilePath returns the Backplane CLI configuration filepath

Types

type AccessRequestsJiraConfiguration

type AccessRequestsJiraConfiguration struct {
	DefaultProject            string                                           `json:"default-project"`
	DefaultIssueType          string                                           `json:"default-issue-type"`
	ProdProject               string                                           `json:"prod-project"`
	ProdIssueType             string                                           `json:"prod-issue-type"`
	ProjectToTransitionsNames map[string]JiraTransitionsNamesForAccessRequests `json:"project-to-transitions-names"`
}

type BackplaneConfiguration

type BackplaneConfiguration struct {
	URL                         string                          `json:"url"`
	ProxyURL                    *string                         `json:"proxy-url"`
	SessionDirectory            string                          `json:"session-dir"`
	AssumeInitialArn            string                          `json:"assume-initial-arn"`
	ProdEnvName                 string                          `json:"prod-env-name"`
	PagerDutyAPIKey             string                          `json:"pd-key"`
	JiraBaseURL                 string                          `json:"jira-base-url"`
	JiraToken                   string                          `json:"jira-token"`
	JiraConfigForAccessRequests AccessRequestsJiraConfiguration `json:"jira-config-for-access-requests"`
	VPNCheckEndpoint            string                          `json:"vpn-check-endpoint"`
	ProxyCheckEndpoint          string                          `json:"proxy-check-endpoint"`
}

Please update the validateConfig function if there is any required config key added

func GetBackplaneConfiguration

func GetBackplaneConfiguration() (bpConfig BackplaneConfiguration, err error)

GetBackplaneConfiguration parses and returns the given backplane configuration

func (BackplaneConfiguration) CheckAPIConnection

func (config BackplaneConfiguration) CheckAPIConnection() error

CheckAPIConnection validate API connection via configured proxy and VPN

func (*BackplaneConfiguration) GetBackplaneURL

func (config *BackplaneConfiguration) GetBackplaneURL() (string, error)

GetBackplaneURL returns API URL

type JiraTransitionsNamesForAccessRequests

type JiraTransitionsNamesForAccessRequests struct {
	OnCreation string `json:"on-creation"`
	OnApproval string `json:"on-approval"`
	OnError    string `json:"on-error"`
}