bootstrap

Documentation

Index

• Constants
• func GetHost(repo *gogit.Repository) string
• func GetURLParts(remoteURL string) parts
• func ParseGitRemote(log logger.Logger, workingDir string) (*gogit.Repository, error)
• func ParseRemoteURL(repo *gogit.Repository) string
• type Bootstrap
  • func NewBootstrap(clusterPath string, options BootstrapCmdOptions, provider GitProvider) Bootstrap
• type BootstrapCmdOptions
• type BootstrapCommon
• type BootstrapForge
  • func (b *BootstrapForge) RunBootstrapCmd(ctx context.Context, flux *fluxexec.Flux) error
  • func (b *BootstrapForge) SyncResources(ctx context.Context, log logger.Logger, commitFiles []gitprovider.CommitFile) error
• type BootstrapRaw
  • func (b *BootstrapRaw) RunBootstrapCmd(ctx context.Context, flux *fluxexec.Flux) error
  • func (b *BootstrapRaw) SyncResources(ctx context.Context, log logger.Logger, commitFiles []gitprovider.CommitFile) error
• type BootstrapWizard
  • func NewBootstrapWizard(log logger.Logger, gitProvider GitProvider, repo *gogit.Repository) (*BootstrapWizard, error)
  • func (wizard *BootstrapWizard) BuildCmd(log logger.Logger) BootstrapWizardCmd
  • func (wizard *BootstrapWizard) Run(log logger.Logger) error
• type BootstrapWizardCmd
• type BootstrapWizardTask
• type DefaultValueGetter
• type GitProvider
  • func ParseGitProvider(hostname string) GitProvider
  • func SelectGitProvider(log logger.Logger) (GitProvider, error)

Constants

const (
	BranchOptionKey         = "branch"
	HostnameOptionKey       = "hostname"
	OwnerOptionKey          = "owner"
	PasswordOptionKey       = "password"
	PersonalOptionKey       = "personal"
	PrivateKeyFileOptionKey = "private-key-file"
	PrivateOptionKey        = "private"
	RepositoryOptionKey     = "repository"
	PATOptionKey            = "pat"
	URLOptionKey            = "url"
	UsernameOptionKey       = "username"
)

Functions

func GetHost

func GetHost(repo *gogit.Repository) string

func GetURLParts

func GetURLParts(remoteURL string) parts

GetURLParts splits URL to URL parts. This takes inspiration from https://github.com/fluxcd/go-git-providers/blob/cda93bf5a5fa65bd994a60d6d3ef9ad119cfb684/gitprovider/repositoryref.go#L309 except it has to do it in reverse

func ParseGitRemote

func ParseGitRemote(log logger.Logger, workingDir string) (*gogit.Repository, error)

ParseGitRemote parses the git remote (if it exists) from the working directory to autofill some command options.

func ParseRemoteURL

func ParseRemoteURL(repo *gogit.Repository) string

ParseRemoteURL extracts remote URL from the repository

Types

type Bootstrap

type Bootstrap interface {
	RunBootstrapCmd(context.Context, *fluxexec.Flux) error
	SyncResources(context.Context, logger.Logger, []gitprovider.CommitFile) error
}

func NewBootstrap

func NewBootstrap(clusterPath string, options BootstrapCmdOptions, provider GitProvider) Bootstrap

type BootstrapCmdOptions

type BootstrapCmdOptions map[string]string

type BootstrapCommon

type BootstrapCommon struct {
	// contains filtered or unexported fields
}

type BootstrapForge

type BootstrapForge struct {
	BootstrapCommon
	// contains filtered or unexported fields
}

func (*BootstrapForge) RunBootstrapCmd

func (b *BootstrapForge) RunBootstrapCmd(ctx context.Context, flux *fluxexec.Flux) error

func (*BootstrapForge) SyncResources

func (b *BootstrapForge) SyncResources(ctx context.Context, log logger.Logger, commitFiles []gitprovider.CommitFile) error

type BootstrapRaw

type BootstrapRaw struct {
	BootstrapCommon
	// contains filtered or unexported fields
}

TODO: this needs to be implemented using plain go-git

func (*BootstrapRaw) RunBootstrapCmd

func (b *BootstrapRaw) RunBootstrapCmd(ctx context.Context, flux *fluxexec.Flux) error

func (*BootstrapRaw) SyncResources

func (b *BootstrapRaw) SyncResources(ctx context.Context, log logger.Logger, commitFiles []gitprovider.CommitFile) error

type BootstrapWizard

type BootstrapWizard struct {
	// contains filtered or unexported fields
}

func NewBootstrapWizard

func NewBootstrapWizard(log logger.Logger, gitProvider GitProvider, repo *gogit.Repository) (*BootstrapWizard, error)

NewBootstrapWizard creates a wizard to gather all bootstrap config options before running flux bootstrap.

func (*BootstrapWizard) BuildCmd

func (wizard *BootstrapWizard) BuildCmd(log logger.Logger) BootstrapWizardCmd

BuildCmd builds flux bootstrap command options as key/values pairs.

func (*BootstrapWizard) Run

func (wizard *BootstrapWizard) Run(log logger.Logger) error

Run displays text inputs to enter or edit all command flag values.

type BootstrapWizardCmd

type BootstrapWizardCmd struct {
	Provider GitProvider
	Options  BootstrapCmdOptions
}

type BootstrapWizardTask

type BootstrapWizardTask struct {
	// contains filtered or unexported fields
}

type DefaultValueGetter

type DefaultValueGetter func(*gogit.Repository) string

type GitProvider

type GitProvider int32

const (
	GitProviderUnknown         GitProvider = 0
	GitProviderGitHub          GitProvider = 1
	GitProviderGitLab          GitProvider = 2
	GitProviderGit             GitProvider = 3
	GitProviderBitbucketServer GitProvider = 4
)

func ParseGitProvider

func ParseGitProvider(hostname string) GitProvider

ParseGitProvider extracts git provider from the remote URL, if possible

func SelectGitProvider

func SelectGitProvider(log logger.Logger) (GitProvider, error)

SelectGitProvider displays text inputs to enter or edit all command flag values.