Documentation
¶
Overview ¶
Package setup owns safe first-run initialization for a local Starport instance.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // ErrPathsRequired reports incomplete managed paths. ErrPathsRequired = errors.New("setup paths are required") // ErrAlreadyInitialized reports existing configuration or identity storage. ErrAlreadyInitialized = errors.New("starport is already initialized") // ErrPartialState reports an incomplete managed configuration directory. ErrPartialState = errors.New("starport setup state is incomplete") // ErrProviderRequired reports an absent provider selection. ErrProviderRequired = errors.New("setup provider is required") // ErrUnsupportedProvider reports a provider absent from the current catalog. ErrUnsupportedProvider = errors.New("setup provider is not in the current Starmap catalog") // ErrProviderCredentialRequired reports incomplete catalog-declared material. ErrProviderCredentialRequired = errors.New("required provider credential is not configured") // ErrRollbackRefused reports state that does not match an initialization result. ErrRollbackRefused = errors.New("setup rollback refused") )
Functions ¶
func InitializeIdentity ¶
func InitializeIdentity( ctx context.Context, store storage.KVStore, name string, ) (identity.IssueResult, error)
InitializeIdentity creates the first named identity in configured storage. It refuses a repository that already contains an identity.
Types ¶
type Option ¶ added in v1.0.2
type Option func(*Service)
Option configures catalog and environment setup boundaries.
func WithEnvironmentLookup ¶ added in v1.0.2
WithEnvironmentLookup replaces process environment access.
func WithProviderLookup ¶ added in v1.0.2
func WithProviderLookup(lookup ProviderLookup) Option
WithProviderLookup replaces the current Starmap provider lookup.
type ProviderLookup ¶ added in v1.0.2
ProviderLookup returns one exact provider from the setup catalog.
type Request ¶
type Request struct {
Provider catalogs.ProviderID
IdentityName string
}
Request contains the explicit choices for local initialization.
type Result ¶
type Result struct {
Provider catalogs.ProviderID
IdentityName string
ConfigFile string
DataDir string
APIKey string
// contains filtered or unexported fields
}
Result contains initialized paths and the one-time gateway credential.
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service initializes one local configuration and identity store.
func (*Service) Initialize ¶
Initialize creates local configuration and one named gateway identity. It never replaces an existing configuration file or identity store.
type State ¶
type State string
State describes the durable local setup state.
const ( // StateAbsent means the managed configuration directory does not exist. StateAbsent State = "absent" // StatePartial means the directory exists without both required artifacts. StatePartial State = "partial" // StateReady means the configuration file and identity store both exist. StateReady State = "ready" )
Source Files