Documentation
¶
Index ¶
- Constants
- Variables
- func TestClient(t *testing.T, c Client)
- func TestRemoteLocks(t *testing.T, a, b Client)
- type ArtifactoryClient
- type AzureClient
- type Client
- type ClientLocker
- type EtcdClient
- type Factory
- type FileClient
- type GCSClient
- type HTTPClient
- type MantaClient
- type Payload
- type State
- type SwiftClient
Constants ¶
const ARTIF_TFSTATE_NAME = "terraform.tfstate"
const DEFAULT_OBJECT_NAME = "terraform.tfstate"
const TFSTATE_NAME = "tfstate.tf"
Variables ¶
var BuiltinClients = map[string]Factory{
"artifactory": artifactoryFactory,
"azure": azureFactory,
"etcd": etcdFactory,
"gcs": gcsFactory,
"http": httpFactory,
"local": fileFactory,
"swift": swiftFactory,
"manta": mantaFactory,
}
BuiltinClients is the list of built-in clients that can be used with NewClient.
Functions ¶
func TestClient ¶
TestClient is a generic function to test any client.
func TestRemoteLocks ¶
Test the lock implementation for a remote.Client. This test requires 2 client instances, in oder to have multiple remote clients since some implementations may tie the client to the lock, or may have reentrant locks.
Types ¶
type ArtifactoryClient ¶
type ArtifactoryClient struct {
// contains filtered or unexported fields
}
func (*ArtifactoryClient) Delete ¶
func (c *ArtifactoryClient) Delete() error
func (*ArtifactoryClient) Get ¶
func (c *ArtifactoryClient) Get() (*Payload, error)
func (*ArtifactoryClient) Put ¶
func (c *ArtifactoryClient) Put(data []byte) error
type AzureClient ¶
type AzureClient struct {
// contains filtered or unexported fields
}
func (*AzureClient) Delete ¶
func (c *AzureClient) Delete() error
func (*AzureClient) Get ¶
func (c *AzureClient) Get() (*Payload, error)
func (*AzureClient) Put ¶
func (c *AzureClient) Put(data []byte) error
type Client ¶
Client is the interface that must be implemented for a remote state driver. It supports dumb put/get/delete, and the higher level structs handle persisting the state properly here.
type ClientLocker ¶
ClientLocker is an optional interface that allows a remote state backend to enable state lock/unlock.
type EtcdClient ¶
EtcdClient is a remote client that stores data in etcd.
func (*EtcdClient) Delete ¶
func (c *EtcdClient) Delete() error
func (*EtcdClient) Get ¶
func (c *EtcdClient) Get() (*Payload, error)
func (*EtcdClient) Put ¶
func (c *EtcdClient) Put(data []byte) error
type FileClient ¶
type FileClient struct {
Path string
}
FileClient is a remote client that stores data locally on disk. This is only used for development reasons to test remote state... locally.
func (*FileClient) Delete ¶
func (c *FileClient) Delete() error
func (*FileClient) Get ¶
func (c *FileClient) Get() (*Payload, error)
func (*FileClient) Put ¶
func (c *FileClient) Put(data []byte) error
type HTTPClient ¶
HTTPClient is a remote client that stores data in Consul or HTTP REST.
func (*HTTPClient) Delete ¶
func (c *HTTPClient) Delete() error
func (*HTTPClient) Get ¶
func (c *HTTPClient) Get() (*Payload, error)
func (*HTTPClient) Put ¶
func (c *HTTPClient) Put(data []byte) error
type MantaClient ¶
func (*MantaClient) Delete ¶
func (c *MantaClient) Delete() error
func (*MantaClient) Get ¶
func (c *MantaClient) Get() (*Payload, error)
func (*MantaClient) Put ¶
func (c *MantaClient) Put(data []byte) error
type State ¶
type State struct {
Client Client
// contains filtered or unexported fields
}
State implements the State interfaces in the state package to handle reading and writing the remote state. This State on its own does no local caching so every persist will go to the remote storage and local writes will go to memory.
type SwiftClient ¶
type SwiftClient struct {
// contains filtered or unexported fields
}
SwiftClient implements the Client interface for an Openstack Swift server.
func (*SwiftClient) Delete ¶
func (c *SwiftClient) Delete() error
func (*SwiftClient) Get ¶
func (c *SwiftClient) Get() (*Payload, error)
func (*SwiftClient) Put ¶
func (c *SwiftClient) Put(data []byte) error
Source Files