Documentation
¶
Overview ¶
Package admin owns admin credential requirements and secure interactive setup.
Index ¶
Constants ¶
const CredentialsRequiredMetadata = "admin-credentials-required"
CredentialsRequiredMetadata marks admin operations before command-tree cloning.
Variables ¶
This section is empty.
Functions ¶
func CheckCredentials ¶
CheckCredentials validates effective admin authentication after input validation.
func ConfigureCredentials ¶
ConfigureCredentials marks canonical generated operations before subgroup cloning. Request setup checks credentials after positional and required-input validation.
func ConfigureSetupHelp ¶
ConfigureSetupHelp adds the admin guide after clihelp creates help/setup.
func RegisterSetup ¶
RegisterSetup installs the secure interactive admin setup command.
Types ¶
type CredentialsError ¶
type CredentialsError struct {
// contains filtered or unexported fields
}
CredentialsError provides fixed guidance for missing admin authentication.
func (*CredentialsError) Error ¶
func (err *CredentialsError) Error() string
type Options ¶
type Options struct {
DefaultRequestOptions func(*cli.Command) []option.RequestOption
TextOutput func(*cli.Command) bool
IsTerminal func(io.Writer) bool
DiagnosticsAllowed func(*cli.Command) bool
}
Options supplies application policies at the existing setup call sites. All callbacks are required by RegisterSetup.
type SetupError ¶
type SetupError struct {
// contains filtered or unexported fields
}
SetupError preserves a safe setup diagnostic and canonical cancellation cause.
func (*SetupError) Error ¶
func (err *SetupError) Error() string
func (*SetupError) ExitCode ¶
func (err *SetupError) ExitCode() int
func (*SetupError) Unwrap ¶
func (err *SetupError) Unwrap() error