manual

Documentation

Index

• Constants
• type ManualProvider
  • func (p ManualProvider) CloudSchema() *jsonschema.Schema
  • func (p ManualProvider) ConfigDefaults() schema.Defaults
  • func (p ManualProvider) ConfigSchema() schema.Fields
  • func (ManualProvider) CredentialSchemas() map[cloud.AuthType]cloud.CredentialSchema
  • func (ManualProvider) DetectCredentials(cloudName string) (*cloud.CloudCredential, error)
  • func (p ManualProvider) DetectRegions() ([]cloud.Region, error)
  • func (ManualProvider) FinalizeCredential(_ environs.FinalizeCredentialContext, args environs.FinalizeCredentialParams) (*cloud.Credential, error)
  • func (p ManualProvider) ModelConfigDefaults(_ context.Context) (map[string]any, error)
  • func (p ManualProvider) Open(ctx context.Context, args environs.OpenParams, ...) (environs.Environ, error)
  • func (p ManualProvider) Ping(ctx envcontext.ProviderCallContext, endpoint string) error
  • func (p ManualProvider) Validate(ctx context.Context, cfg, old *config.Config) (valid *config.Config, err error)
  • func (ManualProvider) ValidateCloud(ctx context.Context, spec environscloudspec.CloudSpec) error
  • func (ManualProvider) Version() int

Constants

const (
	// BootstrapInstanceId is the instance ID used
	// for the manual provider's bootstrap instance.
	BootstrapInstanceId instance.Id = "manual:"
)

Types

type ManualProvider

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

ManualProvider contains the logic for using a random ubuntu machine as a controller, connected via SSH.

func (ManualProvider) CloudSchema

func (p ManualProvider) CloudSchema() *jsonschema.Schema

CloudSchema returns the schema for verifying the cloud configuration.

func (ManualProvider) ConfigDefaults

func (p ManualProvider) ConfigDefaults() schema.Defaults

ConfigDefaults returns the default values for this providers specific config attributes.

func (ManualProvider) ConfigSchema

func (p ManualProvider) ConfigSchema() schema.Fields

ConfigSchema returns the extra config attributes specific to this provider.

func (ManualProvider) CredentialSchemas

func (ManualProvider) CredentialSchemas() map[cloud.AuthType]cloud.CredentialSchema

CredentialSchemas is part of the environs.ProviderCredentials interface.

func (ManualProvider) DetectCredentials

func (ManualProvider) DetectCredentials(cloudName string) (*cloud.CloudCredential, error)

DetectCredentials is part of the environs.ProviderCredentials interface.

func (ManualProvider) DetectRegions

func (p ManualProvider) DetectRegions() ([]cloud.Region, error)

DetectRegions is specified in the environs.CloudRegionDetector interface.

func (ManualProvider) FinalizeCredential

func (ManualProvider) FinalizeCredential(_ environs.FinalizeCredentialContext, args environs.FinalizeCredentialParams) (*cloud.Credential, error)

FinalizeCredential is part of the environs.ProviderCredentials interface.

func (ManualProvider) ModelConfigDefaults

func (p ManualProvider) ModelConfigDefaults(_ context.Context) (map[string]any, error)

ModelConfigDefaults provides a set of default model config attributes that should be set on a models config if they have not been specified by the user.

func (ManualProvider) Open

func (p ManualProvider) Open(ctx context.Context, args environs.OpenParams, invaliator environs.CredentialInvalidator) (environs.Environ, error)

func (ManualProvider) Ping

func (p ManualProvider) Ping(ctx envcontext.ProviderCallContext, endpoint string) error

Ping tests the connection to the cloud, to verify the endpoint is valid.

func (ManualProvider) Validate

func (p ManualProvider) Validate(ctx context.Context, cfg, old *config.Config) (valid *config.Config, err error)

func (ManualProvider) ValidateCloud

func (ManualProvider) ValidateCloud(ctx context.Context, spec environscloudspec.CloudSpec) error

ValidateCloud is specified in the EnvironProvider interface.

func (ManualProvider) Version

func (ManualProvider) Version() int

Version is part of the EnvironProvider interface.