manifest

Documentation

Index

• type AuthConfig
• type Author
• type Authorization
• type BuiltInAuth
• type BuiltInTeamMapping
• type Environment
• type EnvironmentService
• type GitConfig
  • func LoadGitConfigFromGhValues(url, ghToken, authorName, authorEmail string) GitConfig
• type GitHubConfig
• type IDPTeamMapping
• type Notifications
• type OIDCAuth
• type Orchestrator
• type Organization
• type Platform
• type SAMLAuth
• type SSHConfig
• type Secret
• type Service
  • func (s *Service) UnmarshalJSON(data []byte) error
  • func (s *Service) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Team
• type TeamEnvironment
• type TeamMappings

Types

type AuthConfig

type AuthConfig struct {
	Type  *string    `json:"type,omitempty" yaml:"type,omitempty"`
	SSH   *SSHConfig `json:"ssh,omitempty" yaml:"ssh,omitempty"`
	Token *Secret    `json:"token,omitempty" yaml:"token,omitempty"`
}

AuthConfig represents git authentication configuration

type Author

type Author struct {
	Name  *string `json:"name,omitempty" yaml:"name,omitempty"`
	Email *string `json:"email,omitempty" yaml:"email,omitempty"`
}

Author represents git commit author configuration

type Authorization

type Authorization struct {
	BuiltIn      *BuiltInAuth `json:"built-in,omitempty" yaml:"built-in,omitempty"`
	OIDC         *OIDCAuth    `json:"oidc,omitempty" yaml:"oidc,omitempty"`
	SAML         *SAMLAuth    `json:"saml,omitempty" yaml:"saml,omitempty"`
	TeamMappings TeamMappings `json:"team-mappings" yaml:"team-mappings"`
}

Authorization represents the organization's authentication configuration

type BuiltInAuth

type BuiltInAuth struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

BuiltInAuth represents built-in authentication configuration

type BuiltInTeamMapping

type BuiltInTeamMapping struct {
	Enabled bool `json:"enabled" yaml:"enabled"`
}

BuiltInTeamMapping represents built-in team mapping configuration

type Environment

type Environment struct {
	Type   string                      `json:"type" yaml:"type"`
	Region string                      `json:"region" yaml:"region"`
	Teams  map[string]*TeamEnvironment `json:"teams,omitempty" yaml:"teams,omitempty"`
}

type EnvironmentService

type EnvironmentService struct {
	Branch string `json:"branch" yaml:"branch"`
}

type GitConfig

type GitConfig struct {
	Remote *string       `json:"remote,omitempty" yaml:"remote,omitempty"`
	Author *Author       `json:"author,omitempty" yaml:"author,omitempty"`
	Auth   *AuthConfig   `json:"auth,omitempty" yaml:"auth,omitempty"`
	GitHub *GitHubConfig `json:"github,omitempty" yaml:"github,omitempty"`
}

GitConfig represents git repository configuration

func LoadGitConfigFromGhValues

func LoadGitConfigFromGhValues(url, ghToken, authorName, authorEmail string) GitConfig

type GitHubConfig

type GitHubConfig struct {
	Token *Secret `json:"token,omitempty" yaml:"token,omitempty"`
}

type IDPTeamMapping

type IDPTeamMapping struct {
	Enabled  bool                `json:"enabled" yaml:"enabled"`
	Mappings map[string][]string `json:"mappings" yaml:"mappings"`
}

IDPTeamMapping represents IDP team mapping configuration

type Notifications

type Notifications struct {
	Email *bool `json:"email,omitempty" yaml:"email,omitempty"`
	InApp *bool `json:"in-app,omitempty" yaml:"in-app,omitempty"`
}

type OIDCAuth

type OIDCAuth struct {
	Enabled       bool              `json:"enabled" yaml:"enabled"`
	LoginPath     string            `json:"login-path" yaml:"login-path"`
	Issuer        string            `json:"issuer" yaml:"issuer"`
	ClientID      string            `json:"client-id" yaml:"client-id"`
	ClientSecret  Secret            `json:"client-secret" yaml:"client-secret"`
	ClaimMappings map[string]string `json:"claim-mappings" yaml:"claim-mappings"`
	Scopes        []string          `json:"scopes" yaml:"scopes"`
}

OIDCAuth represents OIDC authentication configuration

type Orchestrator

type Orchestrator struct {
	Platform      *Platform                `json:"platform,omitempty" yaml:"platform,omitempty"`
	Teams         map[string]*Team         `json:"teams,omitempty" yaml:"teams,omitempty"`
	Organizations map[string]*Organization `json:"organizations,omitempty" yaml:"organizations,omitempty"`
}

type Organization

type Organization struct {
	AccessToken         Secret                  `json:"access-token" yaml:"access-token"`
	Environments        map[string]*Environment `json:"environments,omitempty" yaml:"environments,omitempty"`
	Authorization       *Authorization          `json:"authorization,omitempty" yaml:"authorization,omitempty"`
	Notifications       *Notifications          `json:"notifications,omitempty" yaml:"notifications,omitempty"`
	EnableCustomReports *bool                   `json:"enable-custom-reports,omitempty" yaml:"enable-custom-reports,omitempty"`
}

type Platform

type Platform struct {
	Git *GitConfig `json:"git,omitempty" yaml:"git,omitempty"`
}

Platform represents the platform team configuration

type SAMLAuth

type SAMLAuth struct {
	Enabled        bool   `json:"enabled" yaml:"enabled"`
	LoginPath      string `json:"login-path" yaml:"login-path"`
	IDPMetadataURL string `json:"idp-metadata-url" yaml:"idp-metadata-url"`
}

SAMLAuth represents SAML authentication configuration

type SSHConfig

type SSHConfig struct {
	Key *Secret `json:"key,omitempty" yaml:"key,omitempty"`
}

SSHConfig represents SSH key configuration

type Secret

type Secret struct {
	// Type is the storage type of secret, e.g. file, env, literal
	Type string `json:"type" yaml:"type"`
	// Value is the value of the secret, e.g. the file path, env var name, or literal value
	Value string `json:"value" yaml:"value"`
}

type Service

type Service struct {
	Name        *string    `json:"name,omitempty" yaml:"name,omitempty"`
	Git         *GitConfig `json:"git,omitempty" yaml:"git,omitempty"`
	Description *string    `json:"description,omitempty" yaml:"description,omitempty"`
	SpecPath    string     `json:"spec-path" yaml:"spec-path,omitempty"`
	ProdBranch  string     `json:"prod-branch-name" yaml:"prod-branch-name"`
	DevBranch   string     `json:"dev-branch-name" yaml:"dev-branch-name"`
}

func (*Service) UnmarshalJSON

func (s *Service) UnmarshalJSON(data []byte) error

func (*Service) UnmarshalYAML

func (s *Service) UnmarshalYAML(unmarshal func(interface{}) error) error

type Team

type Team struct {
	Description *string             `json:"description,omitempty" yaml:"description,omitempty"`
	Users       []string            `json:"users,omitempty" yaml:"users,omitempty"`
	Services    map[string]*Service `json:"services,omitempty" yaml:"services,omitempty"`
}

type TeamEnvironment

type TeamEnvironment struct {
	ControlPlaneName *string                        `json:"control-plane-name,omitempty" yaml:"control-plane-name,omitempty"`
	Services         map[string]*EnvironmentService `json:"services,omitempty" yaml:"services,omitempty"`
}

type TeamMappings

type TeamMappings struct {
	BuiltIn BuiltInTeamMapping `json:"built-in" yaml:"built-in"`
	IDP     IDPTeamMapping     `json:"idp" yaml:"idp"`
}

TeamMappings represents team mapping configuration for SAML