Merge pull request #919 from arithx/openstack

platform: add OpenStack

Author: arithx

README.md

@@ -56,7 +56,7 @@ Ideally, all software needed for a test should be included by building
 it into the image from the SDK.
 
 Kola supports running tests on multiple platforms, currently QEMU, GCE,
-AWS, VMware VSphere, and Packet. In the future systemd-nspawn and other
+AWS, VMware VSphere, Packet, and OpenStack. In the future systemd-nspawn and other
 platforms may be added.
 Local platforms do not rely on access to the Internet as a design
 principle of kola, minimizing external dependencies. Any network
@@ -261,6 +261,25 @@ you can paste in. This will populate the `.boto` file.
 See [Google Cloud Platform's Documentation](https://cloud.google.com/storage/docs/boto-gsutil)
 for more information about the `.boto` file.
 
+### openstack
+`openstack` uses `~/.config/openstack.json`. This can be configured manually:
+```
+{
+    "default": {
+        "auth_url": "auth url here",
+        "tenant_id": "tenant id here",
+        "tenant_name": "tenant name here",
+        "username": "username here",
+        "password": "password here",
+        "user_domain": "domain id here",
+        "floating_ip_pool": "floating ip pool here",
+        "region_name": "region here"
+    }
+}
+```
+
+`user_domain` is required on some newer versions of OpenStack using Keystone V3 but is optional on older versions. `floating_ip_pool` and `region_name` can be optionally specified here to be used as a default if not specified on the command line.
+
 ### packet
 `packet` uses `~/.config/packet.json`. This can be configured manually:
 ```

auth/openstack.go

@@ -0,0 +1,69 @@
+// Copyright 2018 Red Hat
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package auth
+
+import (
+	"encoding/json"
+	"fmt"
+	"os"
+	"os/user"
+	"path/filepath"
+)
+
+const OpenStackConfigPath = ".config/openstack.json"
+
+type OpenStackProfile struct {
+	AuthURL    string `json:"auth_url"`
+	TenantID   string `json:"tenant_id"`
+	TenantName string `json:"tenant_name"`
+	Username   string `json:"username"`
+	Password   string `json:"password"`
+
+	//Optional
+	Domain         string `json:"user_domain"`
+	FloatingIPPool string `json:"floating_ip_pool"`
+	Region         string `json:"region_name"`
+}
+
+// ReadOpenStackConfig decodes an OpenStack config file,
+// which is a custom format used by Mantle to hold OpenStack
+// server information.
+//
+// If path is empty, $HOME/.config/openstack.json is read.
+func ReadOpenStackConfig(path string) (map[string]OpenStackProfile, error) {
+	if path == "" {
+		user, err := user.Current()
+		if err != nil {
+			return nil, err
+		}
+		path = filepath.Join(user.HomeDir, OpenStackConfigPath)
+	}
+
+	f, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer f.Close()
+
+	var profiles map[string]OpenStackProfile
+	if err := json.NewDecoder(f).Decode(&profiles); err != nil {
+		return nil, err
+	}
+	if len(profiles) == 0 {
+		return nil, fmt.Errorf("OpenStack config %q contains no profiles", path)
+	}
+
+	return profiles, nil
+}

cmd/kola/kola.go

@@ -148,6 +148,11 @@ func writeProps() error {
 		Image       string `json:"image"`
 		MachineType string `json:"type"`
 	}
+	type OpenStack struct {
+		Region string `json:"region"`
+		Image  string `json:"image"`
+		Flavor string `json:"flavor"`
+	}
 	type Packet struct {
 		Facility              string `json:"facility"`
 		Plan                  string `json:"plan"`
@@ -159,16 +164,17 @@ func writeProps() error {
 		Mangled bool   `json:"mangled"`
 	}
 	return enc.Encode(&struct {
-		Cmdline  []string `json:"cmdline"`
-		Platform string   `json:"platform"`
-		Distro   string   `json:"distro"`
-		Board    string   `json:"board"`
-		AWS      AWS      `json:"aws"`
-		DO       DO       `json:"do"`
-		ESX      ESX      `json:"esx"`
-		GCE      GCE      `json:"gce"`
-		Packet   Packet   `json:"packet"`
-		QEMU     QEMU     `json:"qemu"`
+		Cmdline   []string  `json:"cmdline"`
+		Platform  string    `json:"platform"`
+		Distro    string    `json:"distro"`
+		Board     string    `json:"board"`
+		AWS       AWS       `json:"aws"`
+		DO        DO        `json:"do"`
+		ESX       ESX       `json:"esx"`
+		GCE       GCE       `json:"gce"`
+		OpenStack OpenStack `json:"openstack"`
+		Packet    Packet    `json:"packet"`
+		QEMU      QEMU      `json:"qemu"`
 	}{
 		Cmdline:  os.Args,
 		Platform: kolaPlatform,
@@ -192,6 +198,11 @@ func writeProps() error {
 			Image:       kola.GCEOptions.Image,
 			MachineType: kola.GCEOptions.MachineType,
 		},
+		OpenStack: OpenStack{
+			Region: kola.OpenStackOptions.Region,
+			Image:  kola.OpenStackOptions.Image,
+			Flavor: kola.OpenStackOptions.Flavor,
+		},
 		Packet: Packet{
 			Facility:              kola.PacketOptions.Facility,
 			Plan:                  kola.PacketOptions.Plan,

cmd/kola/options.go

@@ -29,7 +29,7 @@ var (
 	outputDir          string
 	kolaPlatform       string
 	defaultTargetBoard = sdk.DefaultBoard()
-	kolaPlatforms      = []string{"aws", "do", "esx", "gce", "packet", "qemu"}
+	kolaPlatforms      = []string{"aws", "do", "esx", "gce", "openstack", "packet", "qemu"}
 	kolaDistros        = []string{"cl", "fcos", "rhcos"}
 	kolaDefaultImages  = map[string]string{
 		"amd64-usr": sdk.BuildRoot() + "/images/amd64-usr/latest/coreos_production_image.bin",
@@ -95,6 +95,16 @@ func init() {
 	bv(&kola.GCEOptions.ServiceAuth, "gce-service-auth", false, "for non-interactive auth when running within GCE")
 	sv(&kola.GCEOptions.JSONKeyFile, "gce-json-key", "", "use a service account's JSON key for authentication")
 
+	// openstack-specific options
+	sv(&kola.OpenStackOptions.ConfigPath, "openstack-config-file", "", "OpenStack config file (default \"~/"+auth.OpenStackConfigPath+"\")")
+	sv(&kola.OpenStackOptions.Profile, "openstack-profile", "", "OpenStack profile (default \"default\")")
+	sv(&kola.OpenStackOptions.Region, "openstack-region", "", "OpenStack region")
+	sv(&kola.OpenStackOptions.Image, "openstack-image", "", "OpenStack image ref")
+	sv(&kola.OpenStackOptions.Flavor, "openstack-flavor", "1", "OpenStack flavor ref")
+	sv(&kola.OpenStackOptions.Network, "openstack-network", "", "OpenStack network")
+	sv(&kola.OpenStackOptions.Domain, "openstack-domain", "", "OpenStack domain ID")
+	sv(&kola.OpenStackOptions.FloatingIPPool, "openstack-floating-ip-pool", "", "OpenStack floating IP pool for Compute v2 networking")
+
 	// packet-specific options
 	sv(&kola.PacketOptions.ConfigPath, "packet-config-file", "", "Packet config file (default \"~/"+auth.PacketConfigPath+"\")")
 	sv(&kola.PacketOptions.Profile, "packet-profile", "", "Packet profile (default \"default\")")

cmd/ore/openstack.go

@@ -0,0 +1,23 @@
+// Copyright 2018 Red Hat
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package main
+
+import (
+	"github.com/coreos/mantle/cmd/ore/openstack"
+)
+
+func init() {
+	root.AddCommand(openstack.OpenStack)
+}

cmd/ore/openstack/create.go

@@ -0,0 +1,56 @@
+// Copyright 2018 Red Hat
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package openstack
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/coreos/mantle/sdk"
+	"github.com/spf13/cobra"
+)
+
+var (
+	cmdCreate = &cobra.Command{
+		Use:   "create-image",
+		Short: "Create image on OpenStack",
+		Long: `Upload an image to OpenStack.
+
+After a successful run, the final line of output will be the ID of the image.
+`,
+		RunE: runCreate,
+	}
+
+	path string
+	name string
+)
+
+func init() {
+	OpenStack.AddCommand(cmdCreate)
+	cmdCreate.Flags().StringVar(&path, "file",
+		sdk.BuildRoot()+"/images/amd64-usr/latest/coreos_production_openstack_image.img",
+		"path to CoreOS image (build with: ./image_to_vm.sh --format=openstack ...)")
+	cmdCreate.Flags().StringVar(&name, "name", "", "image name")
+}
+
+func runCreate(cmd *cobra.Command, args []string) error {
+	id, err := API.UploadImage(name, path)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Couldn't create image: %v\n", err)
+		os.Exit(1)
+	}
+	fmt.Println(id)
+	return nil
+}

cmd/ore/openstack/delete.go

@@ -0,0 +1,52 @@
+// Copyright 2018 Red Hat
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package openstack
+
+import (
+	"fmt"
+	"os"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	cmdDelete = &cobra.Command{
+		Use:   "delete-image",
+		Short: "Delete image on OpenStack",
+		Long:  `Delete an image from OpenStack.`,
+		RunE:  runDelete,
+	}
+
+	id string
+)
+
+func init() {
+	OpenStack.AddCommand(cmdDelete)
+	cmdDelete.Flags().StringVar(&id, "id", "", "image ID")
+}
+
+func runDelete(cmd *cobra.Command, args []string) error {
+	img, err := API.ResolveImage(id)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Couldn't find image: %v\n", err)
+		os.Exit(1)
+	}
+	err = API.DeleteImage(img)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Couldn't delete image: %v\n", err)
+		os.Exit(1)
+	}
+	return nil
+}

cmd/ore/openstack/gc.go

@@ -0,0 +1,48 @@
+// Copyright 2018 Red Hat
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package openstack
+
+import (
+	"fmt"
+	"os"
+	"time"
+
+	"github.com/spf13/cobra"
+)
+
+var (
+	cmdGC = &cobra.Command{
+		Use:   "gc",
+		Short: "GC resources in OpenStack",
+		Long:  `Delete instances created over the given duration ago`,
+		RunE:  runGC,
+	}
+
+	gcDuration time.Duration
+)
+
+func init() {
+	OpenStack.AddCommand(cmdGC)
+	cmdGC.Flags().DurationVar(&gcDuration, "duration", 5*time.Hour, "how old resources must be before they're considered garbage")
+}
+
+func runGC(cmd *cobra.Command, args []string) error {
+	err := API.GC(gcDuration)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Couldn't gc: %v\n", err)
+		os.Exit(1)
+	}
+	return nil
+}