setup

Documentation

Index

• type Backend
• type Backends
  • func (b *Backends) Configure() error
  • func (b *Backends) Create() error
  • func (b *Backends) Predefined() bool
• type Dictionaries
  • func (d *Dictionaries) Configure() error
  • func (d *Dictionaries) Create() error
  • func (d *Dictionaries) Predefined() bool
• type Dictionary
• type DictionaryItem
• type Domain
• type Domains
  • func (d *Domains) Configure() error
  • func (d *Domains) Create() error
  • func (d *Domains) Missing() bool
  • func (d *Domains) Predefined() bool
  • func (d *Domains) Validate() error
• type Interface
• type Logger
• type Loggers
  • func (l *Loggers) Configure() error
  • func (l *Loggers) Predefined() bool

Types

type Backend

type Backend struct {
	Address        string
	Name           string
	OverrideHost   string
	Port           uint
	SSLSNIHostname string
}

Backend represents the configuration parameters for creating a backend via the API client.

type Backends

type Backends struct {
	// Public
	APIClient      api.Interface
	AcceptDefaults bool
	Progress       text.Progress
	ServiceID      string
	ServiceVersion int
	Setup          map[string]*manifest.SetupBackend
	Stdin          io.Reader
	Stdout         io.Writer
	// contains filtered or unexported fields
}

Backends represents the service state related to backends defined within the fastly.toml setup configuration.

NOTE: It implements the setup.Interface interface.

func (*Backends) Configure

func (b *Backends) Configure() error

Configure prompts the user for specific values related to the service resource.

func (*Backends) Create

func (b *Backends) Create() error

Create calls the relevant API to create the service resource(s).

func (*Backends) Predefined

func (b *Backends) Predefined() bool

Predefined indicates if the service resource has been specified within the fastly.toml file using a setup configuration block.

type Dictionaries

type Dictionaries struct {
	// Public
	APIClient      api.Interface
	AcceptDefaults bool
	Progress       text.Progress
	ServiceID      string
	ServiceVersion int
	Setup          map[string]*manifest.SetupDictionary
	Stdin          io.Reader
	Stdout         io.Writer
	// contains filtered or unexported fields
}

Dictionaries represents the service state related to dictionaries defined within the fastly.toml setup configuration.

NOTE: It implements the setup.Interface interface.

func (*Dictionaries) Configure

func (d *Dictionaries) Configure() error

Configure prompts the user for specific values related to the service resource.

func (*Dictionaries) Create

func (d *Dictionaries) Create() error

Create calls the relevant API to create the service resource(s).

func (*Dictionaries) Predefined

func (d *Dictionaries) Predefined() bool

Predefined indicates if the service resource has been specified within the fastly.toml file using a setup configuration block.

type Dictionary

type Dictionary struct {
	Name  string
	Items []DictionaryItem
}

Dictionary represents the configuration parameters for creating a dictionary via the API client.

NOTE: WriteOnly (i.e. private) dictionaries not supported.

type DictionaryItem

type DictionaryItem struct {
	Key   string
	Value string
}

Dictionary represents the configuration parameters for creating dictionary items via the API client.

type Domain

type Domain struct {
	Name string
}

Domain represents the configuration parameters for creating a domain via the API client.

type Domains

type Domains struct {
	// Public
	APIClient      api.Interface
	AcceptDefaults bool
	PackageDomain  string
	Progress       text.Progress
	ServiceID      string
	ServiceVersion int
	Stdin          io.Reader
	Stdout         io.Writer
	// contains filtered or unexported fields
}

Domains represents the service state related to domains defined within the fastly.toml setup configuration.

NOTE: It implements the setup.Interface interface.

func (*Domains) Configure

func (d *Domains) Configure() error

Configure prompts the user for specific values related to the service resource.

NOTE: If --domain flag is used we'll use that as the domain to create.

func (*Domains) Create

func (d *Domains) Create() error

Create calls the relevant API to create the service resource(s).

func (*Domains) Missing

func (d *Domains) Missing() bool

Missing indicates if there are missing resources that need to be created.

func (*Domains) Predefined

func (d *Domains) Predefined() bool

Predefined indicates if the service resource has been specified within the fastly.toml file using a setup configuration block.

NOTE: Domains are not configurable via the fastly.toml setup and so this becomes a no-op function that returned a canned response.

func (*Domains) Validate

func (d *Domains) Validate() error

Validate checks if the service has the required resources.

NOTE: It should set an internal `missing` field (boolean) accordingly so that the Missing() method can report the state of the resource.

type Interface

type Interface interface {
	// Configure prompts the user for specific values related to the service resource.
	Configure() error

	// Create calls the relevant API to create the service resource(s).
	Create() error

	// Missing indicates if there are missing resources that need to be
	// configured and/or created.
	Missing() bool

	// Predefined indicates if the service resource has been specified within the
	// fastly.toml file using a [setup] configuration block.
	Predefined() bool

	// Validate checks if the service has the required resources.
	Validate() error
}

Interface represents the behaviour of a setup resource.

type Logger

type Logger struct {
	Provider string
}

Logger represents the configuration parameters for creating a dictionary via the API client.

type Loggers

type Loggers struct {
	AcceptDefaults bool
	Setup          map[string]*manifest.SetupLogger
	Stdout         io.Writer
}

Loggers represents the service state related to log entries defined within the fastly.toml setup configuration.

NOTE: It implements the setup.Interface interface.

func (*Loggers) Configure

func (l *Loggers) Configure() error

Configure prompts the user for specific values related to the service resource.

func (*Loggers) Predefined

func (l *Loggers) Predefined() bool

Predefined indicates if the service resource has been specified within the fastly.toml file using a setup configuration block.