config

type Config struct {
	// +optional
	Kind string `json:"kind,omitempty"`

	// +optional
	APIVersion string `json:"apiVersion,omitempty"`

	// Permissions is a struct of permissions for file and directory
	Permissions Permissions `json:"permissions,omitempty"`

	// Contexts is a map of referenceable names to context configs
	Contexts map[string]*Context `json:"contexts"`

	// Manifests is a map of referenceable names to documents
	Manifests map[string]*Manifest `json:"manifests"`

	// CurrentContext is the name of the context that you would like to use by default
	CurrentContext string `json:"currentContext"`

	// Management configuration defines management information for all baremetal hosts in a cluster.
	ManagementConfiguration map[string]*ManagementConfiguration `json:"managementConfiguration"`
	// contains filtered or unexported fields
}

type Context struct {
	// Manifest is the default manifest to be use with this context
	// +optional
	Manifest string `json:"manifest,omitempty"`

	// Management configuration which will be used for all hosts in the cluster
	ManagementConfiguration string `json:"managementConfiguration"`
}

type ContextOption func(ctx *Context)

type ContextOptions struct {
	Name                    string
	CurrentContext          bool
	Manifest                string
	Current                 bool
	ManagementConfiguration string
	Format                  string
}

type ErrAuthTypeNotSupported struct {
}

type ErrCheckFile struct {
	FlagName    string
	Path        string
	InternalErr error
}

type ErrConfigFailed struct {
}

type ErrConfigFileExists struct {
	Path string
}

type ErrConflictingAuthOptions struct {
}

type ErrConflictingClusterOptions struct {
}

type ErrConflictingContextOptions struct {
}

type ErrDecodingCredentials struct {
	Given string
}

type ErrEmptyContextName struct {
}

type ErrEmptyManagementConfigurationName struct {
}

type ErrIncompatibleAuthOptions struct {
	ForbiddenOptions []string
	AuthType         string
}

type ErrInvalidConfig struct {
	What string
}

type ErrManagementConfigurationNotFound struct {
	Name string
}

type ErrMissingConfig struct {
	What string
}

type ErrMissingCurrentContext struct {
}

type ErrMissingFlag struct {
	FlagName string
}

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

type ErrMissingManifestName struct {
}

type ErrMissingPhaseDocument struct {
	PhaseName string
}

type ErrMissingPhaseRepo struct {
}

type ErrMissingRepoCheckoutOptions struct {
}

type ErrMissingRepoURL struct {
}

type ErrMissingRepositoryName struct {
	RepoType string
}

type ErrMutuallyExclusiveCheckout struct {
}

type ErrRepoSpecRequiresURL struct {
}

type ErrRepositoryNotFound struct {
	Name string
}

type ErrUnknownManagementType struct {
	Type string
}

type ErrWrongOutputFormat struct {
	Wrong    string
	Possible []string
}

type Factory func() (*Config, error)

type InventoryMeta struct {
	Path string `json:"path,omitempty"`
}

type ManagementConfigOption func(mgmtConf *ManagementConfiguration)

type ManagementConfiguration struct {
	// Insecure indicates whether the SSL certificate should be checked on remote management requests.
	Insecure bool `json:"insecure,omitempty"`

	// SystemActionRetries is the number of attempts to poll a host for a status.
	SystemActionRetries int `json:"systemActionRetries,omitempty"`

	// SystemRebootDelay is the number of seconds to wait between power actions (e.g. shutdown, startup).
	SystemRebootDelay int `json:"systemRebootDelay,omitempty"`

	// Type the type of out-of-band management that will be used for baremetal orchestration, e.g. redfish.
	Type string `json:"type"`

	// UseProxy indicates whether airshipctl should transmit remote management requests through a proxy server when
	// one is configured in an environment.
	UseProxy bool `json:"useproxy,omitempty"`
}

type Manifest struct {
	// PhaseRepositoryName is a name of the repo, that contains site/<site-name> directory
	// and is a starting point for building document bundle
	PhaseRepositoryName string `json:"phaseRepositoryName"`
	// InventoryRepositoryName is a name of the repo contains inventory objects
	// to be used mostly with baremetal deployments
	// If not defined PhaseRepositoryName will be used to locate inventory
	InventoryRepositoryName string `json:"inventoryRepositoryName"`
	// ExtraRepositories is the map of extra repositories addressable by a name
	Repositories map[string]*Repository `json:"repositories,omitempty"`
	// TargetPath Local Target path for working or home directory for all Manifest Cloned/Returned/Generated
	TargetPath string `json:"targetPath"`
	// MetadataPath path to a metadata file relative to TargetPath
	MetadataPath string `json:"metadataPath"`
}

type ManifestOptions struct {
	Name         string
	RepoName     string
	URL          string
	Branch       string
	CommitHash   string
	Tag          string
	Force        bool
	IsPhase      bool
	TargetPath   string
	MetadataPath string
}

type Metadata struct {
	Inventory *InventoryMeta `json:"inventory,omitempty"`
	PhaseMeta *PhaseMeta     `json:"phase,omitempty"`
}

type Permissions struct {
	DirectoryPermission uint32
	FilePermission      uint32
}

type PhaseMeta struct {
	// path is a kustomize entrypoint against which we will build bundle with phase objects
	Path string `json:"path,omitempty"`
	// docEntryPointPrefix is the path prefix for documentEntryPoint field in the phase config
	// If it is defined in the manifest metadata then it will be prepended
	// to the documentEntryPoint defined in the phase itself. So in this case the full path will be
	// targetPath + phaseRepoDir + docEntryPointPrefix + documentEntryPoint
	// E.g. let
	// targetPath (defined in airship config file) be /tmp
	// phaseRepoDir (this is the last part of the repo url given in the airship config file) be reponame
	// docEntryPointPrefix (defined in metadata) be foo/bar and
	// documentEntryPoint (defined in a phase) be baz/xyz
	// then the full path to the document bundle will be /tmp/reponame/foo/bar/baz/xyz
	// If docEntryPointPrefix is empty or not given at all, then the full path will be
	// targetPath + phaseRepoDir + documentEntryPoint (in our case /tmp/reponame/baz/xyz)
	DocEntryPointPrefix string `json:"docEntryPointPrefix,omitempty"`
}

type RepoAuth struct {
	// Type of authentication method to be used with given repository
	// supported types are "ssh-key", "ssh-pass", "http-basic", "none"
	Type string `json:"type,omitempty"`
	//KeyPassword is a password decrypt ssh private key (used with ssh-key auth type)
	KeyPassword string `json:"keyPass,omitempty"`
	// KeyPath is path to private ssh key on disk (used with ssh-key auth type)
	KeyPath string `json:"sshKey,omitempty"`
	//HTTPPassword is password for basic http authentication (used with http-basic auth type)
	HTTPPassword string `json:"httpPass,omitempty"`
	// SSHPassword is password for ssh password authentication (used with ssh-pass)
	SSHPassword string `json:"sshPass,omitempty"`
	// Username to authenticate against git remote (used with any type)
	Username string `json:"username,omitempty"`
}

type RepoCheckout struct {
	// CommitHash is full hash of the commit that will be used to checkout
	CommitHash string `json:"commitHash"`
	// Branch is the branch name to checkout
	Branch string `json:"branch"`
	// Tag is the tag name to checkout
	Tag string `json:"tag"`
	// Ref is the ref to checkout
	// for example refs/changes/04/691202/5
	Ref string `json:"ref,omitempty"`
	// ForceCheckout is a boolean to indicate whether to use the `--force` option when checking out
	ForceCheckout bool `json:"force"`
	// LocalBranch is a boolean to indicate whether the Branch is local one. False by default
	LocalBranch bool `json:"localBranch"`
}

type RepoFetch struct {
	// RemoteRefSpec is used for remote fetches such as gerrit change
	// requests and github pull requests. The format of the refspec is an
	// optional +, followed by <src>:<dst>, where <src> is the pattern for
	// references on the remote side and <dst> is where those references
	// will be written locally. The + tells Git to update the reference
	// even if it isn't a fast-forward.
	// eg.: refs/changes/04/691202/5:refs/changes/04/691202/5
	RemoteRefSpec string `json:"remoteRefSpec,omitempty"`
}

type Repository struct {
	// URLString for Repository
	URLString string `json:"url"`
	// Auth holds authentication options against remote
	Auth *RepoAuth `json:"auth,omitempty"`
	// CheckoutOptions holds options to checkout repository
	CheckoutOptions *RepoCheckout `json:"checkout,omitempty"`
	// FetchOptions holds options for fetching remote refs
	FetchOptions *RepoFetch `json:"fetch,omitempty"`
}

type RunSetContextOptions struct {
	CfgFactory Factory
	CtxName    string
	Current    bool
	Writer     io.Writer
}

type RunSetManagementConfigOptions struct {
	CfgFactory  Factory
	MgmtCfgName string
	Writer      io.Writer
}