Skip to content

Commit 9081cab

Browse files
nicolai86stack72
authored andcommitted
Add scaleway provider (#7331)
* Add scaleway provider this PR allows the entire scaleway stack to be managed with terraform example usage looks like this: ``` provider "scaleway" { api_key = "snap" organization = "snip" } resource "scaleway_ip" "base" { server = "${scaleway_server.base.id}" } resource "scaleway_server" "base" { name = "test" # ubuntu 14.04 image = "aecaed73-51a5-4439-a127-6d8229847145" type = "C2S" } resource "scaleway_volume" "test" { name = "test" size_in_gb = 20 type = "l_ssd" } resource "scaleway_volume_attachment" "test" { server = "${scaleway_server.base.id}" volume = "${scaleway_volume.test.id}" } resource "scaleway_security_group" "base" { name = "public" description = "public gateway" } resource "scaleway_security_group_rule" "http-ingress" { security_group = "${scaleway_security_group.base.id}" action = "accept" direction = "inbound" ip_range = "0.0.0.0/0" protocol = "TCP" port = 80 } resource "scaleway_security_group_rule" "http-egress" { security_group = "${scaleway_security_group.base.id}" action = "accept" direction = "outbound" ip_range = "0.0.0.0/0" protocol = "TCP" port = 80 } ``` Note that volume attachments require the server to be stopped, which can lead to downtimes of you attach new volumes to already used servers * Update IP read to handle 404 gracefully * Read back resource on update * Ensure IP detachment works as expected Sadly this is not part of the official scaleway api just yet * Adjust detachIP helper based on feedback from @QuentinPerez in scaleway/scaleway-cli#378 * Cleanup documentation * Rename api_key to access_key following @stack72 suggestion and rename the provider api_key for more clarity * Make tests less chatty by using custom logger
1 parent 0ce6337 commit 9081cab

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+6436
-0
lines changed
+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package main
2+
3+
import (
4+
"github.com/hashicorp/terraform/builtin/providers/scaleway"
5+
"github.com/hashicorp/terraform/plugin"
6+
)
7+
8+
func main() {
9+
plugin.Serve(&plugin.ServeOpts{
10+
ProviderFunc: scaleway.Provider,
11+
})
12+
}

builtin/providers/scaleway/config.go

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
package scaleway
2+
3+
import (
4+
"fmt"
5+
"log"
6+
"net/http"
7+
"os"
8+
9+
"github.com/scaleway/scaleway-cli/pkg/api"
10+
"github.com/scaleway/scaleway-cli/pkg/scwversion"
11+
)
12+
13+
// Config contains scaleway configuration values
14+
type Config struct {
15+
Organization string
16+
APIKey string
17+
}
18+
19+
// Client contains scaleway api clients
20+
type Client struct {
21+
scaleway *api.ScalewayAPI
22+
}
23+
24+
// Client configures and returns a fully initialized Scaleway client
25+
func (c *Config) Client() (*Client, error) {
26+
api, err := api.NewScalewayAPI(
27+
c.Organization,
28+
c.APIKey,
29+
scwversion.UserAgent(),
30+
func(s *api.ScalewayAPI) {
31+
s.Logger = newTerraformLogger()
32+
},
33+
)
34+
if err != nil {
35+
return nil, err
36+
}
37+
return &Client{api}, nil
38+
}
39+
40+
func newTerraformLogger() api.Logger {
41+
return &terraformLogger{}
42+
}
43+
44+
type terraformLogger struct {
45+
}
46+
47+
func (l *terraformLogger) LogHTTP(r *http.Request) {
48+
log.Printf("[DEBUG] %s %s\n", r.Method, r.URL.Path)
49+
}
50+
func (l *terraformLogger) Fatalf(format string, v ...interface{}) {
51+
log.Printf("[FATAL] %s\n", fmt.Sprintf(format, v))
52+
os.Exit(1)
53+
}
54+
func (l *terraformLogger) Debugf(format string, v ...interface{}) {
55+
log.Printf("[DEBUG] %s\n", fmt.Sprintf(format, v))
56+
}
57+
func (l *terraformLogger) Infof(format string, v ...interface{}) {
58+
log.Printf("[INFO ] %s\n", fmt.Sprintf(format, v))
59+
}
60+
func (l *terraformLogger) Warnf(format string, v ...interface{}) {
61+
log.Printf("[WARN ] %s\n", fmt.Sprintf(format, v))
62+
}

builtin/providers/scaleway/helpers.go

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
package scaleway
2+
3+
import (
4+
"fmt"
5+
"log"
6+
"net/http"
7+
"time"
8+
9+
"github.com/scaleway/scaleway-cli/pkg/api"
10+
)
11+
12+
// Bool returns a pointer to of the bool value passed in.
13+
func Bool(val bool) *bool {
14+
return &val
15+
}
16+
17+
// String returns a pointer to of the string value passed in.
18+
func String(val string) *string {
19+
return &val
20+
}
21+
22+
// DetachIP detaches an IP from a server
23+
func DetachIP(s *api.ScalewayAPI, ipID string) error {
24+
var update struct {
25+
Address string `json:"address"`
26+
ID string `json:"id"`
27+
Organization string `json:"organization"`
28+
}
29+
30+
ip, err := s.GetIP(ipID)
31+
if err != nil {
32+
return err
33+
}
34+
update.Address = ip.IP.Address
35+
update.ID = ip.IP.ID
36+
update.Organization = ip.IP.Organization
37+
38+
resp, err := s.PutResponse(api.ComputeAPI, fmt.Sprintf("ips/%s", ipID), update)
39+
if err != nil {
40+
return err
41+
}
42+
if resp.StatusCode != http.StatusOK {
43+
return err
44+
}
45+
resp.Body.Close()
46+
return nil
47+
}
48+
49+
// NOTE copied from github.com/scaleway/scaleway-cli/pkg/api/helpers.go
50+
// the helpers.go file pulls in quite a lot dependencies, and they're just convenience wrappers anyway
51+
52+
func deleteServerSafe(s *api.ScalewayAPI, serverID string) error {
53+
server, err := s.GetServer(serverID)
54+
if err != nil {
55+
return err
56+
}
57+
58+
if server.State != "stopped" {
59+
if err := s.PostServerAction(serverID, "poweroff"); err != nil {
60+
return err
61+
}
62+
if err := waitForServerState(s, serverID, "stopped"); err != nil {
63+
return err
64+
}
65+
}
66+
67+
if err := s.DeleteServer(serverID); err != nil {
68+
return err
69+
}
70+
if rootVolume, ok := server.Volumes["0"]; ok {
71+
if err := s.DeleteVolume(rootVolume.Identifier); err != nil {
72+
return err
73+
}
74+
}
75+
76+
return nil
77+
}
78+
79+
func waitForServerState(s *api.ScalewayAPI, serverID string, targetState string) error {
80+
var server *api.ScalewayServer
81+
var err error
82+
83+
var currentState string
84+
85+
for {
86+
server, err = s.GetServer(serverID)
87+
if err != nil {
88+
return err
89+
}
90+
if currentState != server.State {
91+
log.Printf("[DEBUG] Server changed state to %q\n", server.State)
92+
currentState = server.State
93+
}
94+
if server.State == targetState {
95+
break
96+
}
97+
time.Sleep(1 * time.Second)
98+
}
99+
100+
return nil
101+
}
+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
package scaleway
2+
3+
import (
4+
"github.com/hashicorp/terraform/helper/schema"
5+
"github.com/hashicorp/terraform/terraform"
6+
)
7+
8+
// Provider returns a terraform.ResourceProvider.
9+
func Provider() terraform.ResourceProvider {
10+
return &schema.Provider{
11+
Schema: map[string]*schema.Schema{
12+
"access_key": &schema.Schema{
13+
Type: schema.TypeString,
14+
Required: true,
15+
DefaultFunc: schema.EnvDefaultFunc("SCALEWAY_ACCESS_KEY", nil),
16+
Description: "The API key for Scaleway API operations.",
17+
},
18+
"organization": &schema.Schema{
19+
Type: schema.TypeString,
20+
Required: true,
21+
DefaultFunc: schema.EnvDefaultFunc("SCALEWAY_ORGANIZATION", nil),
22+
Description: "The Organization ID for Scaleway API operations.",
23+
},
24+
},
25+
26+
ResourcesMap: map[string]*schema.Resource{
27+
"scaleway_server": resourceScalewayServer(),
28+
"scaleway_ip": resourceScalewayIP(),
29+
"scaleway_security_group": resourceScalewaySecurityGroup(),
30+
"scaleway_security_group_rule": resourceScalewaySecurityGroupRule(),
31+
"scaleway_volume": resourceScalewayVolume(),
32+
"scaleway_volume_attachment": resourceScalewayVolumeAttachment(),
33+
},
34+
35+
ConfigureFunc: providerConfigure,
36+
}
37+
}
38+
39+
func providerConfigure(d *schema.ResourceData) (interface{}, error) {
40+
config := Config{
41+
Organization: d.Get("organization").(string),
42+
APIKey: d.Get("access_key").(string),
43+
}
44+
45+
return config.Client()
46+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
package scaleway
2+
3+
import (
4+
"os"
5+
"testing"
6+
7+
"github.com/hashicorp/terraform/helper/schema"
8+
"github.com/hashicorp/terraform/terraform"
9+
)
10+
11+
var testAccProviders map[string]terraform.ResourceProvider
12+
var testAccProvider *schema.Provider
13+
14+
func init() {
15+
testAccProvider = Provider().(*schema.Provider)
16+
testAccProviders = map[string]terraform.ResourceProvider{
17+
"scaleway": testAccProvider,
18+
}
19+
}
20+
21+
func TestProvider(t *testing.T) {
22+
if err := Provider().(*schema.Provider).InternalValidate(); err != nil {
23+
t.Fatalf("err: %s", err)
24+
}
25+
}
26+
27+
func TestProvider_impl(t *testing.T) {
28+
var _ terraform.ResourceProvider = Provider()
29+
}
30+
31+
func testAccPreCheck(t *testing.T) {
32+
if v := os.Getenv("SCALEWAY_ORGANIZATION"); v == "" {
33+
t.Fatal("SCALEWAY_ORGANIZATION must be set for acceptance tests")
34+
}
35+
if v := os.Getenv("SCALEWAY_ACCESS_KEY"); v == "" {
36+
t.Fatal("SCALEWAY_ACCESS_KEY must be set for acceptance tests")
37+
}
38+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
package scaleway
2+
3+
import (
4+
"log"
5+
6+
"github.com/hashicorp/terraform/helper/schema"
7+
"github.com/scaleway/scaleway-cli/pkg/api"
8+
)
9+
10+
func resourceScalewayIP() *schema.Resource {
11+
return &schema.Resource{
12+
Create: resourceScalewayIPCreate,
13+
Read: resourceScalewayIPRead,
14+
Update: resourceScalewayIPUpdate,
15+
Delete: resourceScalewayIPDelete,
16+
Schema: map[string]*schema.Schema{
17+
"server": &schema.Schema{
18+
Type: schema.TypeString,
19+
Optional: true,
20+
},
21+
"ip": &schema.Schema{
22+
Type: schema.TypeString,
23+
Computed: true,
24+
},
25+
},
26+
}
27+
}
28+
29+
func resourceScalewayIPCreate(d *schema.ResourceData, m interface{}) error {
30+
scaleway := m.(*Client).scaleway
31+
resp, err := scaleway.NewIP()
32+
if err != nil {
33+
return err
34+
}
35+
36+
d.SetId(resp.IP.ID)
37+
return resourceScalewayIPUpdate(d, m)
38+
}
39+
40+
func resourceScalewayIPRead(d *schema.ResourceData, m interface{}) error {
41+
scaleway := m.(*Client).scaleway
42+
log.Printf("[DEBUG] Reading IP\n")
43+
44+
resp, err := scaleway.GetIP(d.Id())
45+
if err != nil {
46+
log.Printf("[DEBUG] Error reading ip: %q\n", err)
47+
if serr, ok := err.(api.ScalewayAPIError); ok {
48+
if serr.StatusCode == 404 {
49+
d.SetId("")
50+
return nil
51+
}
52+
}
53+
return err
54+
}
55+
56+
d.Set("ip", resp.IP.Address)
57+
d.Set("server", resp.IP.Server.Identifier)
58+
return nil
59+
}
60+
61+
func resourceScalewayIPUpdate(d *schema.ResourceData, m interface{}) error {
62+
scaleway := m.(*Client).scaleway
63+
if d.HasChange("server") {
64+
if d.Get("server").(string) != "" {
65+
log.Printf("[DEBUG] Attaching IP %q to server %q\n", d.Id(), d.Get("server").(string))
66+
if err := scaleway.AttachIP(d.Id(), d.Get("server").(string)); err != nil {
67+
return err
68+
}
69+
} else {
70+
log.Printf("[DEBUG] Detaching IP %q\n", d.Id())
71+
return DetachIP(scaleway, d.Id())
72+
}
73+
}
74+
75+
return resourceScalewayIPRead(d, m)
76+
}
77+
78+
func resourceScalewayIPDelete(d *schema.ResourceData, m interface{}) error {
79+
scaleway := m.(*Client).scaleway
80+
err := scaleway.DeleteIP(d.Id())
81+
if err != nil {
82+
return err
83+
}
84+
d.SetId("")
85+
return nil
86+
}

0 commit comments

Comments
 (0)