config

package

v0.1.37 Latest Latest Go to latest Published: Jul 16, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/feichashao/backplane-cli

Links

Open Source Insights

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 ¶

View Source

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

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

Variables ¶

View Source

var JiraConfigForAccessRequestsDefaultValue = AccessRequestsJiraConfiguration{
	DefaultProject:   "SDAINT",
	DefaultIssueType: "Story",
	ProdProject:      "OHSS",
	ProdIssueType:    "Incident",
	ProjectToTransitionsNames: map[string]JiraTransitionsNamesForAccessRequests{
		"SDAINT": JiraTransitionsNamesForAccessRequests{
			OnCreation: "In Progress",
			OnApproval: "In Progress",
			OnError:    "Closed",
		},
		"OHSS": JiraTransitionsNamesForAccessRequests{
			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"`
}

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"`
}

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL