resource

Documentation

Index

• Variables
• type ID
• type Plugin
• type Spec

Variables

var InterfaceSpec = spi.InterfaceSpec{
	Name:    "Resource",
	Version: "0.1.0",
}

InterfaceSpec is the current name and version of the Resource API.

Types

type ID

type ID string

ID is the unique identifier for a collection of resources.

type Plugin

type Plugin interface {
	Commit(spec Spec, pretend bool) (string, error)
	Destroy(spec Spec, pretend bool) (string, error)
	DescribeResources(spec Spec) (string, error)
}

Plugin defines the functions for a Resource plugin.

type Spec

type Spec struct {

	// ID is the unique identifier for the collection of resources.
	ID ID

	// Properties is the opaque configuration for the resources.
	Properties *types.Any
}

Spec is a specification of resources to provision.