openstack

Documentation

Overview

This set of code handles all functions required to configure networking on an openstack_compute_instance_v2 resource.

This is a complicated task because it's not possible to obtain all information in a single API call. In fact, it even traverses multiple OpenStack services.

The end result, from the user's point of view, is a structured set of understandable network information within the instance resource.

Index

• func AddValueSpecs(body map[string]interface{}) map[string]interface{}
• func BuildRequest(opts interface{}, parent string) (map[string]interface{}, error)
• func CheckDeleted(d *schema.ResourceData, err error, msg string) error
• func GetRegion(d *schema.ResourceData, config *Config) string
• func GetTokenDetails(sc *gophercloud.ServiceClient) (*tokens3.User, *tokens3.Domain, *tokens3.Project, []tokens3.Role, error)
• func GetTokenInfo(sc *gophercloud.ServiceClient) (string, string, error)
• func GetTokenInfoV2(t tokens2.CreateResult) (string, string, error)
• func GetTokenInfoV3(t interface{}) (string, string, error)
• func MapValueSpecs(d *schema.ResourceData) map[string]string
• func Provider() terraform.ResourceProvider
• func ServerV2StateRefreshFunc(client *gophercloud.ServiceClient, instanceID string) resource.StateRefreshFunc
• type ComputeKeyPairV2CreateOpts
  • func (opts ComputeKeyPairV2CreateOpts) ToKeyPairCreateMap() (map[string]interface{}, error)
• type ComputeServerGroupV2CreateOpts
  • func (opts ComputeServerGroupV2CreateOpts) ToServerGroupCreateMap() (map[string]interface{}, error)
• type Config
• type EndpointGroupCreateOpts
• type Firewall
• type FirewallCreateOpts
  • func (opts FirewallCreateOpts) ToFirewallCreateMap() (map[string]interface{}, error)
• type FirewallUpdateOpts
  • func (opts FirewallUpdateOpts) ToFirewallUpdateMap() (map[string]interface{}, error)
• type FloatingIPCreateOpts
  • func (opts FloatingIPCreateOpts) ToFloatingIPCreateMap() (map[string]interface{}, error)
• type IKEPolicyCreateOpts
• type IKEPolicyLifetimeCreateOpts
• type IPSecPolicyCreateOpts
• type InstanceAddresses
• type InstanceNIC
• type InstanceNetwork
• type NetworkCreateOpts
  • func (opts NetworkCreateOpts) ToNetworkCreateMap() (map[string]interface{}, error)
• type PolicyCreateOpts
  • func (opts PolicyCreateOpts) ToFirewallPolicyCreateMap() (map[string]interface{}, error)
• type PortCreateOpts
  • func (opts PortCreateOpts) ToPortCreateMap() (map[string]interface{}, error)
• type QoSPolicyCreateOpts
• type RecordSetCreateOpts
  • func (opts RecordSetCreateOpts) ToRecordSetCreateMap() (map[string]interface{}, error)
• type RouterCreateOpts
  • func (opts RouterCreateOpts) ToRouterCreateMap() (map[string]interface{}, error)
• type RuleCreateOpts
  • func (opts RuleCreateOpts) ToRuleCreateMap() (map[string]interface{}, error)
• type ServiceCreateOpts
• type SiteConnectionCreateOpts
• type SubnetCreateOpts
  • func (opts SubnetCreateOpts) ToSubnetCreateMap() (map[string]interface{}, error)
• type SubnetPoolCreateOpts
• type ZoneCreateOpts
  • func (opts ZoneCreateOpts) ToZoneCreateMap() (map[string]interface{}, error)

Functions

func AddValueSpecs

func AddValueSpecs(body map[string]interface{}) map[string]interface{}

AddValueSpecs expands the 'value_specs' object and removes 'value_specs' from the reqeust body.

func BuildRequest

func BuildRequest(opts interface{}, parent string) (map[string]interface{}, error)

BuildRequest takes an opts struct and builds a request body for Gophercloud to execute

func CheckDeleted

func CheckDeleted(d *schema.ResourceData, err error, msg string) error

CheckDeleted checks the error to see if it's a 404 (Not Found) and, if so, sets the resource ID to the empty string instead of throwing an error.

func GetRegion

func GetRegion(d *schema.ResourceData, config *Config) string

GetRegion returns the region that was specified in the resource. If a region was not set, the provider-level region is checked. The provider-level region can either be set by the region argument or by OS_REGION_NAME.

func GetTokenDetails

func GetTokenDetails(sc *gophercloud.ServiceClient) (*tokens3.User, *tokens3.Domain, *tokens3.Project, []tokens3.Role, error)

func GetTokenInfo

func GetTokenInfo(sc *gophercloud.ServiceClient) (string, string, error)

func GetTokenInfoV2

func GetTokenInfoV2(t tokens2.CreateResult) (string, string, error)

func GetTokenInfoV3

func GetTokenInfoV3(t interface{}) (string, string, error)

func MapValueSpecs

func MapValueSpecs(d *schema.ResourceData) map[string]string

MapValueSpecs converts ResourceData into a map

func Provider

func Provider() terraform.ResourceProvider

Provider returns a schema.Provider for OpenStack.

func ServerV2StateRefreshFunc

func ServerV2StateRefreshFunc(client *gophercloud.ServiceClient, instanceID string) resource.StateRefreshFunc

ServerV2StateRefreshFunc returns a resource.StateRefreshFunc that is used to watch an OpenStack instance.

Types

type ComputeKeyPairV2CreateOpts

type ComputeKeyPairV2CreateOpts struct {
	keypairs.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

ComputeKeyPairV2CreateOpts is a custom KeyPair struct to include the ValueSpecs field.

func (ComputeKeyPairV2CreateOpts) ToKeyPairCreateMap

func (opts ComputeKeyPairV2CreateOpts) ToKeyPairCreateMap() (map[string]interface{}, error)

ToKeyPairCreateMap casts a CreateOpts struct to a map. It overrides keypairs.ToKeyPairCreateMap to add the ValueSpecs field.

type ComputeServerGroupV2CreateOpts

type ComputeServerGroupV2CreateOpts struct {
	servergroups.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

ServerGroupCreateOpts is a custom ServerGroup struct to include the ValueSpecs field.

func (ComputeServerGroupV2CreateOpts) ToServerGroupCreateMap

func (opts ComputeServerGroupV2CreateOpts) ToServerGroupCreateMap() (map[string]interface{}, error)

ToServerGroupCreateMap casts a CreateOpts struct to a map. It overrides routers.ToServerGroupCreateMap to add the ValueSpecs field.

type Config

type Config struct {
	auth.Config
}

Use openstackbase.Config as the base/foundation of this provider's Config struct.

type EndpointGroupCreateOpts

type EndpointGroupCreateOpts struct {
	endpointgroups.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

EndpointGroupCreateOpts represents the attributes used when creating a new endpoint group.

type Firewall

type Firewall struct {
	firewalls.Firewall
	routerinsertion.FirewallExt
}

Firewall is an OpenStack firewall.

type FirewallCreateOpts

type FirewallCreateOpts struct {
	firewalls.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

FirewallCreateOpts represents the attributes used when creating a new firewall.

func (FirewallCreateOpts) ToFirewallCreateMap

func (opts FirewallCreateOpts) ToFirewallCreateMap() (map[string]interface{}, error)

ToFirewallCreateMap casts a CreateOptsExt struct to a map. It overrides firewalls.ToFirewallCreateMap to add the ValueSpecs field.

type FirewallUpdateOpts

type FirewallUpdateOpts struct {
	firewalls.UpdateOptsBuilder
}

FirewallUpdateOpts

func (FirewallUpdateOpts) ToFirewallUpdateMap

func (opts FirewallUpdateOpts) ToFirewallUpdateMap() (map[string]interface{}, error)

type FloatingIPCreateOpts

type FloatingIPCreateOpts struct {
	floatingips.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

FloatingIPCreateOpts represents the attributes used when creating a new floating ip.

func (FloatingIPCreateOpts) ToFloatingIPCreateMap

func (opts FloatingIPCreateOpts) ToFloatingIPCreateMap() (map[string]interface{}, error)

ToFloatingIPCreateMap casts a CreateOpts struct to a map. It overrides floatingips.ToFloatingIPCreateMap to add the ValueSpecs field.

type IKEPolicyCreateOpts

type IKEPolicyCreateOpts struct {
	ikepolicies.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

IKEPolicyCreateOpts represents the attributes used when creating a new IKE policy.

type IKEPolicyLifetimeCreateOpts

type IKEPolicyLifetimeCreateOpts struct {
	ikepolicies.LifetimeCreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

IKEPolicyLifetimeCreateOpts represents the attributes used when creating a new lifetime for an IKE policy.

type IPSecPolicyCreateOpts

type IPSecPolicyCreateOpts struct {
	ipsecpolicies.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

IPSecPolicyCreateOpts represents the attributes used when creating a new IPSec policy.

type InstanceAddresses

type InstanceAddresses struct {
	NetworkName  string
	InstanceNICs []InstanceNIC
}

InstanceAddresses is a collection of InstanceNICs, grouped by the network name. An instance/server could have multiple NICs on the same network.

type InstanceNIC

type InstanceNIC struct {
	FixedIPv4 string
	FixedIPv6 string
	MAC       string
}

InstanceNIC is a structured representation of a Gophercloud servers.Server virtual NIC.

type InstanceNetwork

type InstanceNetwork struct {
	UUID          string
	Name          string
	Port          string
	FixedIP       string
	AccessNetwork bool
}

InstanceNetwork represents a collection of network information that a Terraform instance needs to satisfy all network information requirements.

type NetworkCreateOpts

type NetworkCreateOpts struct {
	networks.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

NetworkCreateOpts represents the attributes used when creating a new network.

func (NetworkCreateOpts) ToNetworkCreateMap

func (opts NetworkCreateOpts) ToNetworkCreateMap() (map[string]interface{}, error)

ToNetworkCreateMap casts a CreateOpts struct to a map. It overrides networks.ToNetworkCreateMap to add the ValueSpecs field.

type PolicyCreateOpts

type PolicyCreateOpts struct {
	policies.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

PolicyCreateOpts represents the attributes used when creating a new firewall policy.

func (PolicyCreateOpts) ToFirewallPolicyCreateMap

func (opts PolicyCreateOpts) ToFirewallPolicyCreateMap() (map[string]interface{}, error)

ToPolicyCreateMap casts a CreateOpts struct to a map. It overrides policies.ToFirewallPolicyCreateMap to add the ValueSpecs field.

type PortCreateOpts

type PortCreateOpts struct {
	ports.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

PortCreateOpts represents the attributes used when creating a new port.

func (PortCreateOpts) ToPortCreateMap

func (opts PortCreateOpts) ToPortCreateMap() (map[string]interface{}, error)

ToPortCreateMap casts a CreateOpts struct to a map. It overrides ports.ToPortCreateMap to add the ValueSpecs field.

type QoSPolicyCreateOpts

type QoSPolicyCreateOpts struct {
	policies.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

QoSPolicyCreateOpts represents the attributes used when creating a new QoS policy.

type RecordSetCreateOpts

type RecordSetCreateOpts struct {
	recordsets.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

RecordSetCreateOpts represents the attributes used when creating a new DNS record set.

func (RecordSetCreateOpts) ToRecordSetCreateMap

func (opts RecordSetCreateOpts) ToRecordSetCreateMap() (map[string]interface{}, error)

ToRecordSetCreateMap casts a CreateOpts struct to a map. It overrides recordsets.ToRecordSetCreateMap to add the ValueSpecs field.

type RouterCreateOpts

type RouterCreateOpts struct {
	routers.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

RouterCreateOpts represents the attributes used when creating a new router.

func (RouterCreateOpts) ToRouterCreateMap

func (opts RouterCreateOpts) ToRouterCreateMap() (map[string]interface{}, error)

ToRouterCreateMap casts a CreateOpts struct to a map. It overrides routers.ToRouterCreateMap to add the ValueSpecs field.

type RuleCreateOpts

type RuleCreateOpts struct {
	rules.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

RuleCreateOpts represents the attributes used when creating a new firewall rule.

func (RuleCreateOpts) ToRuleCreateMap

func (opts RuleCreateOpts) ToRuleCreateMap() (map[string]interface{}, error)

ToRuleCreateMap casts a CreateOpts struct to a map. It overrides rules.ToRuleCreateMap to add the ValueSpecs field.

type ServiceCreateOpts

type ServiceCreateOpts struct {
	services.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

ServiceCreateOpts represents the attributes used when creating a new VPN service.

type SiteConnectionCreateOpts

type SiteConnectionCreateOpts struct {
	siteconnections.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

SiteConnectionCreateOpts represents the attributes used when creating a new IPSec site connection.

type SubnetCreateOpts

type SubnetCreateOpts struct {
	subnets.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

SubnetCreateOpts represents the attributes used when creating a new subnet.

func (SubnetCreateOpts) ToSubnetCreateMap

func (opts SubnetCreateOpts) ToSubnetCreateMap() (map[string]interface{}, error)

ToSubnetCreateMap casts a CreateOpts struct to a map. It overrides subnets.ToSubnetCreateMap to add the ValueSpecs field.

type SubnetPoolCreateOpts

type SubnetPoolCreateOpts struct {
	subnetpools.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

SubnetPoolCreateOpts represents the attributes used when creating a new subnet pool.

type ZoneCreateOpts

type ZoneCreateOpts struct {
	zones.CreateOpts
	ValueSpecs map[string]string `json:"value_specs,omitempty"`
}

ZoneCreateOpts represents the attributes used when creating a new DNS zone.

func (ZoneCreateOpts) ToZoneCreateMap

func (opts ZoneCreateOpts) ToZoneCreateMap() (map[string]interface{}, error)

ToZoneCreateMap casts a CreateOpts struct to a map. It overrides zones.ToZoneCreateMap to add the ValueSpecs field.