compute

Documentation

Overview

Package compute contains commands to manage Compute@Edge packages.

Index

• Constants
• type AssemblyScript
  • func NewAssemblyScript() *AssemblyScript
  • func (a AssemblyScript) Build(out io.Writer, verbose bool) error
  • func (a AssemblyScript) Initialize(out io.Writer) error
  • func (a AssemblyScript) Verify(out io.Writer) error
• type BuildCommand
  • func NewBuildCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *BuildCommand
  • func (c *BuildCommand) Exec(in io.Reader, out io.Writer) (err error)
• type CargoCrateVersion
• type CargoCrateVersions
• type CargoManifest
  • func (m *CargoManifest) Read(fpath string) error
• type CargoMetadata
  • func (m *CargoMetadata) Read() error
• type CargoPackage
• type DeployCommand
  • func NewDeployCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *DeployCommand
  • func (c *DeployCommand) Exec(in io.Reader, out io.Writer) (err error)
• type InitCommand
  • func NewInitCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *InitCommand
  • func (c *InitCommand) Exec(in io.Reader, out io.Writer) (err error)
• type Language
  • func NewLanguage(options *LanguageOptions) *Language
• type LanguageOptions
• type PublishCommand
  • func NewPublishCommand(parent common.Registerer, globals *config.Data, build *BuildCommand, ...) *PublishCommand
  • func (c *PublishCommand) Exec(in io.Reader, out io.Writer) (err error)
• type RootCommand
  • func NewRootCommand(parent common.Registerer, globals *config.Data) *RootCommand
  • func (c *RootCommand) Exec(in io.Reader, out io.Writer) error
• type Rust
  • func NewRust(client api.HTTPClient, config *config.Data) *Rust
  • func (r Rust) Build(out io.Writer, verbose bool) error
  • func (r Rust) IncludeFiles() []string
  • func (r Rust) Initialize(out io.Writer) error
  • func (r Rust) SourceDirectory() string
  • func (r Rust) Verify(out io.Writer) error
• type Toolchain
• type UpdateCommand
  • func NewUpdateCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *UpdateCommand
  • func (c *UpdateCommand) Exec(in io.Reader, out io.Writer) (err error)
• type ValidateCommand
  • func NewValidateCommand(parent common.Registerer, globals *config.Data) *ValidateCommand
  • func (c *ValidateCommand) Exec(in io.Reader, out io.Writer) error

Constants

const IgnoreFilePath = ".fastlyignore"

IgnoreFilePath is the filepath name of the Fastly ignore file.

const ManifestFilename = "fastly.toml"

ManifestFilename is the name of the package manifest file.

Types

type AssemblyScript

type AssemblyScript struct{}

AssemblyScript implements Toolchain for the AssemblyScript language.

func NewAssemblyScript

func NewAssemblyScript() *AssemblyScript

NewAssemblyScript constructs a new AssemblyScript.

func (AssemblyScript) Build

func (a AssemblyScript) Build(out io.Writer, verbose bool) error

Build implements the Toolchain interface and attempts to compile the package AssemblyScript source to a Wasm binary.

func (AssemblyScript) Initialize

func (a AssemblyScript) Initialize(out io.Writer) error

Initialize implements the Toolchain interface and initializes a newly cloned package by installing required dependencies.

func (AssemblyScript) Verify

func (a AssemblyScript) Verify(out io.Writer) error

Verify implements the Toolchain interface and verifies whether the AssemblyScript language toolchain is correctly configured on the host.

type BuildCommand

type BuildCommand struct {
	common.Base

	// NOTE: these are public so that the "publish" composite command can set the
	// values appropriately before calling the Exec() function.
	PackageName string
	Lang        string
	IncludeSrc  bool
	Force       bool
	// contains filtered or unexported fields
}

BuildCommand produces a deployable artifact from files on the local disk.

func NewBuildCommand

func NewBuildCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *BuildCommand

NewBuildCommand returns a usable command registered under the parent.

func (*BuildCommand) Exec

func (c *BuildCommand) Exec(in io.Reader, out io.Writer) (err error)

Exec implements the command interface.

type CargoCrateVersion

type CargoCrateVersion struct {
	Version string `json:"num"`
}

CargoCrateVersion models a Cargo crate version returned by the crates.io API.

type CargoCrateVersions

type CargoCrateVersions struct {
	Versions []CargoCrateVersion `json:"versions"`
}

CargoCrateVersions models a Cargo crate version returned by the crates.io API.

type CargoManifest

type CargoManifest struct {
	Package CargoPackage
}

CargoManifest models the package configuration properties of a Rust Cargo manifest which we are interested in and are read from the Cargo.toml manifest file within the $PWD of the package.

func (*CargoManifest) Read

func (m *CargoManifest) Read(fpath string) error

Read the contents of the Cargo.toml manifest from filename.

type CargoMetadata

type CargoMetadata struct {
	Package         []CargoPackage `json:"packages"`
	TargetDirectory string         `json:"target_directory"`
}

CargoMetadata models information about the workspace members and resolved dependencies of the current package via `cargo metadata` command output.

func (*CargoMetadata) Read

func (m *CargoMetadata) Read() error

Read the contents of the Cargo.lock file from filename.

type CargoPackage

type CargoPackage struct {
	Name         string         `toml:"name" json:"name"`
	Version      string         `toml:"version" json:"version"`
	Dependencies []CargoPackage `toml:"-" json:"dependencies"`
}

CargoPackage models the package configuration properties of a Rust Cargo package which we are interested in and is embedded within CargoManifest and CargoLock.

type DeployCommand

type DeployCommand struct {
	common.Base

	// NOTE: these are public so that the "publish" composite command can set the
	// values appropriately before calling the Exec() function.
	Path    string
	Version common.OptionalInt
	// contains filtered or unexported fields
}

DeployCommand deploys an artifact previously produced by build.

func NewDeployCommand

func NewDeployCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *DeployCommand

NewDeployCommand returns a usable command registered under the parent.

func (*DeployCommand) Exec

func (c *DeployCommand) Exec(in io.Reader, out io.Writer) (err error)

Exec implements the command interface.

type InitCommand

type InitCommand struct {
	common.Base
	// contains filtered or unexported fields
}

InitCommand initializes a Compute@Edge project package on the local machine.

func NewInitCommand

func NewInitCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *InitCommand

NewInitCommand returns a usable command registered under the parent.

func (*InitCommand) Exec

func (c *InitCommand) Exec(in io.Reader, out io.Writer) (err error)

Exec implements the command interface.

type Language

type Language struct {
	Name            string
	DisplayName     string
	StarterKits     []config.StarterKit
	SourceDirectory string
	IncludeFiles    []string

	Toolchain
}

Language models a Compute@Edge source language.

func NewLanguage

func NewLanguage(options *LanguageOptions) *Language

NewLanguage constructs a new Language from a LangaugeOptions.

type LanguageOptions

type LanguageOptions struct {
	Name            string
	DisplayName     string
	StarterKits     []config.StarterKit
	SourceDirectory string
	IncludeFiles    []string
	Toolchain       Toolchain
}

LanguageOptions models configuration options for a Language.

type PublishCommand

type PublishCommand struct {
	common.Base
	// contains filtered or unexported fields
}

PublishCommand produces and deploys an artifact from files on the local disk.

func NewPublishCommand

func NewPublishCommand(parent common.Registerer, globals *config.Data, build *BuildCommand, deploy *DeployCommand) *PublishCommand

NewPublishCommand returns a usable command registered under the parent.

func (*PublishCommand) Exec

func (c *PublishCommand) Exec(in io.Reader, out io.Writer) (err error)

Exec implements the command interface.

NOTE: unlike other non-aggregate commands that initialize a new text.Progress type for displaying progress information to the user, we don't use that in this command because the nested commands overlap the output in non-deterministic ways. It's best to leave those nested commands to handle the progress indicator.

type RootCommand

type RootCommand struct {
	common.Base
}

RootCommand is the parent command for all subcommands in this package. It should be installed under the primary root command.

func NewRootCommand

func NewRootCommand(parent common.Registerer, globals *config.Data) *RootCommand

NewRootCommand returns a new command registered in the parent.

func (*RootCommand) Exec

func (c *RootCommand) Exec(in io.Reader, out io.Writer) error

Exec implements the command interface.

type Rust

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

Rust is an implements Toolchain for the Rust language.

func NewRust

func NewRust(client api.HTTPClient, config *config.Data) *Rust

NewRust constructs a new Rust.

func (Rust) Build

func (r Rust) Build(out io.Writer, verbose bool) error

Build implements the Toolchain interface and attempts to compile the package Rust source to a Wasm binary.

func (Rust) IncludeFiles

func (r Rust) IncludeFiles() []string

IncludeFiles implements the Toolchain interface and returns a list of additional files to include in the package archive for Rust packages.

func (Rust) Initialize

func (r Rust) Initialize(out io.Writer) error

Initialize implements the Toolchain interface and initializes a newly cloned package. It is a noop for Rust as the Cargo toolchain handles these steps.

func (Rust) SourceDirectory

func (r Rust) SourceDirectory() string

SourceDirectory implements the Toolchain interface and returns the source directory for Rust packages.

func (Rust) Verify

func (r Rust) Verify(out io.Writer) error

Verify implments the Toolchain interface and verifies whether the Rust language toolchain is correctly configured on the host.

type Toolchain

type Toolchain interface {
	Initialize(out io.Writer) error
	Verify(out io.Writer) error
	Build(out io.Writer, verbose bool) error
}

Toolchain abstracts a Compute@Edge source language toolchain.

type UpdateCommand

type UpdateCommand struct {
	common.Base
	// contains filtered or unexported fields
}

UpdateCommand calls the Fastly API to update packages.

func NewUpdateCommand

func NewUpdateCommand(parent common.Registerer, client api.HTTPClient, globals *config.Data) *UpdateCommand

NewUpdateCommand returns a usable command registered under the parent.

func (*UpdateCommand) Exec

func (c *UpdateCommand) Exec(in io.Reader, out io.Writer) (err error)

Exec invokes the application logic for the command.

type ValidateCommand

type ValidateCommand struct {
	common.Base
	// contains filtered or unexported fields
}

ValidateCommand validates a package archive.

func NewValidateCommand

func NewValidateCommand(parent common.Registerer, globals *config.Data) *ValidateCommand

NewValidateCommand returns a usable command registered under the parent.

func (*ValidateCommand) Exec

func (c *ValidateCommand) Exec(in io.Reader, out io.Writer) error

Exec implements the command interface.