-
Notifications
You must be signed in to change notification settings - Fork 13
/
provider.go
325 lines (267 loc) · 11.1 KB
/
provider.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
package ddcloud
import (
"fmt"
"log"
"os"
"strconv"
"strings"
"sync"
"time"
"github.com/DimensionDataResearch/dd-cloud-compute-terraform/retry"
"github.com/DimensionDataResearch/go-dd-cloud-compute/compute"
"github.com/hashicorp/terraform/helper/schema"
"github.com/hashicorp/terraform/terraform"
)
// Provider creates the Dimension Data Cloud resource provider.
func Provider() terraform.ResourceProvider {
return &schema.Provider{
// Provider settings schema
Schema: map[string]*schema.Schema{
"region": &schema.Schema{
Type: schema.TypeString,
Optional: true,
Default: "",
Description: "The region code that identifies the target end-point for the Dimension Data CloudControl API.",
ConflictsWith: []string{"cloudcontrol_endpoint"},
},
"cloudcontrol_endpoint": &schema.Schema{
Type: schema.TypeString,
Optional: true,
Default: "",
Description: "The base URL of a custom target end-point for the Dimension Data CloudControl API.",
ConflictsWith: []string{"region"},
},
"username": &schema.Schema{
Type: schema.TypeString,
Optional: true,
Default: "",
Description: "The user name used to authenticate to the Dimension Data CloudControl API (if not specified, then the MCP_USER environment variable will be used).",
},
"password": &schema.Schema{
Type: schema.TypeString,
Optional: true,
Sensitive: true,
Default: "",
Description: "The password used to authenticate to the Dimension Data CloudControl API (if not specified, then the MCP_PASSWORD environment variable will be used).",
},
"allow_server_reboot": &schema.Schema{
Type: schema.TypeBool,
Optional: true,
Default: true,
Description: "Allow rebooting of ddcloud_server instances (e.g. for adding / removing NICs)?",
},
"retry_timeout": &schema.Schema{
Type: schema.TypeInt,
Optional: true,
Default: 10 * 60, // 10 minutes
Description: "The number of seconds before retrying an operation times out.",
},
"retry_delay": &schema.Schema{
Type: schema.TypeInt,
Optional: true,
Default: 30,
Description: "The maximum delay, in seconds, between retries of operations that fail due to a RESOURCE_BUSY response from CloudControl.",
},
},
// Provider resource definitions
ResourcesMap: map[string]*schema.Resource{
// A network domain.
"ddcloud_networkdomain": resourceNetworkDomain(),
// A VLAN.
"ddcloud_vlan": resourceVLAN(),
// A server (virtual machine).
"ddcloud_server": resourceServer(),
// A storage controller (e.g. SCSI controller) in a server
"ddcloud_storage_controller": resourceStorageController(),
// A network adapter.
"ddcloud_network_adapter": resourceNetworkAdapter(),
// A server anti-affinity rule.
"ddcloud_server_anti_affinity": resourceAntiAffinityRule(),
// Cloud Backup configuration for a server.
"ddcloud_server_backup": resourceServerBackup(),
// A Network Address Translation (NAT) rule.
"ddcloud_nat": resourceNAT(),
// A firewall rule.
"ddcloud_firewall_rule": resourceFirewallRule(),
// An IP address list.
"ddcloud_address_list": resourceAddressList(),
// A port list.
"ddcloud_port_list": resourcePortList(),
// A VIP node.
"ddcloud_vip_node": resourceVIPNode(),
// A VIP pool.
"ddcloud_vip_pool": resourceVIPPool(),
// A VIP pool member (links pool, node, and optionally port).
"ddcloud_vip_pool_member": resourceVIPPoolMember(),
// A virtual listener is the top-level entity for load-balancing functionality.
"ddcloud_virtual_listener": resourceVirtualListener(),
// An SSL-offload profile for a virtual listener.
"ddcloud_ssl_offload_profile": resourceSSLOffloadProfile(),
// An SSL certificate (with private key) for a domain.
"ddcloud_ssl_domain_certificate": resourceSSLDomainCertificate(),
// An SSL certificate chain.
"ddcloud_ssl_certificate_chain": resourceSSLCertificateChain(),
// A reserved IPv6 or private IPv4 address on a VLAN.
"ddcloud_ip_address_reservation": resourceIPAddressReservation(),
},
DataSourcesMap: map[string]*schema.Resource{
// A network domain.
"ddcloud_networkdomain": dataSourceNetworkDomain(),
// A virtual network (VLAN).
"ddcloud_vlan": dataSourceVLAN(),
// A PKCS12 (PFX) file.
"ddcloud_pfx": dataSourcePFX(),
},
// Provider configuration
ConfigureFunc: configureProvider,
}
}
// Configure the provider.
// Returns the provider's compute API client.
func configureProvider(providerSettings *schema.ResourceData) (interface{}, error) {
// Log provider version (for diagnostic purposes).
log.Print("ddcloud provider version is " + ProviderVersion)
log.Printf("ProviderSettings = %#v", providerSettings)
region := strings.ToLower(
providerSettings.Get("region").(string),
)
customEndPoint := providerSettings.Get("cloudcontrol_endpoint").(string)
if region == "" && customEndPoint == "" {
return nil, fmt.Errorf("neither the 'region' nor the 'cloudcontrol_endpoint' provider properties were specified (the 'ddcloud' provider requires exactly one of these properties to be configured)")
}
username := providerSettings.Get("username").(string)
if isEmpty(username) {
username = os.Getenv("MCP_USER")
if isEmpty(username) {
return nil, fmt.Errorf("the 'username' property was not specified for the 'ddcloud' provider, and the 'MCP_USER' environment variable is not present. Please supply either one of these to configure the user name used to authenticate to Dimension Data CloudControl")
}
}
password := providerSettings.Get("password").(string)
if isEmpty(password) {
password = os.Getenv("MCP_PASSWORD")
if isEmpty(password) {
return nil, fmt.Errorf("the 'password' property was not specified for the 'ddcloud' provider, and the 'MCP_PASSWORD' environment variable is not present. Please supply either one of these to configure the password used to authenticate to Dimension Data CloudControl")
}
}
var client *compute.Client
if region != "" {
client = compute.NewClient(region, username, password)
} else {
client = compute.NewClientWithBaseAddress(customEndPoint, username, password)
}
// Configure retry, if required.
retryCount := 0
retryDelay := 30 // Seconds
// Override default retry configuration with environment variables, if required.
retryValue, err := strconv.Atoi(os.Getenv("MCP_MAX_RETRY"))
if err == nil {
retryCount = retryValue
retryValue, err = strconv.Atoi(os.Getenv("MCP_RETRY_DELAY"))
if err == nil {
retryDelay = retryValue
}
}
client.ConfigureRetry(retryCount, time.Duration(retryDelay)*time.Second)
settings := &ProviderSettings{
RetryDelay: time.Duration(providerSettings.Get("retry_delay").(int)) * time.Second,
RetryTimeout: time.Duration(providerSettings.Get("retry_timeout").(int)) * time.Second,
AllowServerReboots: providerSettings.Get("allow_server_reboot").(bool),
}
// Override server reboot behaviour with environment variables, if required.
allowRebootValue, err := strconv.ParseBool(os.Getenv("MCP_ALLOW_SERVER_REBOOT"))
if err == nil {
settings.AllowServerReboots = allowRebootValue
}
provider := newProvider(client, settings)
return provider, nil
}
// ProviderSettings represents the configuration for the ddcloud provider.
type ProviderSettings struct {
// Allow rebooting of ddcloud_server instances if required during an update?
//
// For example, servers must be rebooted to add or remove network adapters.
AllowServerReboots bool
// The period of time between retry attempts for asynchronous operations.
RetryDelay time.Duration
// The period of time before retrying of asynchronous operations time out.
RetryTimeout time.Duration
}
type providerState struct {
// The CloudControl API client.
apiClient *compute.Client
// The provider settings.
settings *ProviderSettings
// Global lock for provider state.
stateLock *sync.Mutex
// Global lock for initiating asynchronous operations.
asyncOperationLock *sync.Mutex
// Provider-global retry executor for asynchronous operations.
retry retry.Do
}
func newProvider(client *compute.Client, settings *ProviderSettings) *providerState {
state := &providerState{
apiClient: client,
settings: settings,
stateLock: &sync.Mutex{},
asyncOperationLock: &sync.Mutex{},
retry: retry.NewDo(settings.RetryDelay),
}
return state
}
// Client retrieves the CloudControl API client from provider state.
func (state *providerState) Client() *compute.Client {
return state.apiClient
}
// Settings retrieves a copy of the provider settings.
func (state *providerState) Settings() ProviderSettings {
return *state.settings // We return a copy because these settings should be read-only once the provider has been created.
}
// Retry retrieves the provider's operation-retry executor.
//
// Note that, for performance reasons, this executor is shared by all actions in the provider.
// This means that the retry period is shared across all actions being perfomed.
func (state *providerState) Retry() retry.Do {
return state.retry
}
// RetryAction performs an action with retry using the provider's shared operation-retry executor.
//
// description is a short description of the function used for logging.
// timeout is the period of time before the process
// action is the action function to invoke
//
// Returns the error (if any) passed to Context.Fail or caused by the operation timing out.
//
// Note that, for performance reasons, the executor is shared by all actions in the provider.
// This means that the retry period is shared across all actions being perfomed.
func (state *providerState) RetryAction(description string, action retry.ActionFunc) error {
return state.Retry().Action(description, state.Settings().RetryTimeout, action)
}
// AcquireAsyncOperationLock acquires (locks) the global lock used to synchronise initiation of global operations.
//
// CloudControl exhibits weird behaviour if more than one asynchronous operation is initated at a time (returns UNEXPECTED_ERROR).
func (state *providerState) AcquireAsyncOperationLock(ownerNameOrFormat string, formatArgs ...interface{}) *asyncOperationLock {
asyncLock := &asyncOperationLock{
ownerName: fmt.Sprintf(ownerNameOrFormat, formatArgs...),
lock: state.asyncOperationLock,
releaseOnce: &sync.Once{},
}
log.Printf("%s acquiring global asynchronous operation lock...", asyncLock.ownerName)
asyncLock.lock.Lock()
log.Printf("%s acquired global asynchronous operation lock.", asyncLock.ownerName)
return asyncLock
}
type asyncOperationLock struct {
ownerName string
lock *sync.Mutex
releaseOnce *sync.Once
}
// Release the global asynchronous operation lock.
//
// Safe to call multiple times - subsequent calls to Release have no effect (call providerState.AcquireAsyncOperationLock to reacquire the lock).
func (asyncLock *asyncOperationLock) Release() {
asyncLock.releaseOnce.Do(func() {
log.Printf("%s releasing global asynchronous operation lock...", asyncLock.ownerName)
asyncLock.lock.Unlock()
log.Printf("%s released global asynchronous operation lock.", asyncLock.ownerName)
})
}