✨ Add openstack plugin for csctl

.builder-image-version.txt

@@ -1 +1 @@
-0.2.4
+0.2.0

.gitignore

@@ -17,5 +17,7 @@ temp
 # build and release
 dist
 csctl
+csctl-openstack
 tmp/
 releases/
+output/

Makefile

@@ -59,6 +59,7 @@ clean: ## cleans the csctl binary
 .PHONY: build
 build: # build the csctl binary
 	go build -ldflags "$(LDFLAGS)" -o csctl main.go
+	go build -o csctl-openstack csctlopenstack/csctlopenstack_main.go
 
 .PHONY: lint-golang
 lint-golang: ## Lint Golang codebase

csctlopenstack/csctlopenstack_main.go

@@ -0,0 +1,291 @@
+/*
+Copyright 2024 The Kubernetes Authors.
+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 provides a dummy plugin for csctl. You can use that code
+// to create a real csctl plugin.
+// You can implement the "create-node-images" command to create node images during
+// a `csclt create` call.
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+	"os/exec"
+	"path/filepath"
+	"strings"
+
+	csctlclusterstack "github.com/SovereignCloudStack/csctl/pkg/clusterstack"
+	minio "github.com/minio/minio-go/v7"
+	"github.com/minio/minio-go/v7/pkg/credentials"
+	"gopkg.in/yaml.v2"
+)
+
+// RegistryConfig represents the structure of the registry.yaml file.
+type RegistryConfig struct {
+	Type   string `yaml:"type"`
+	Config struct {
+		Endpoint  string `yaml:"endpoint"`
+		Bucket    string `yaml:"bucket"`
+		AccessKey string `yaml:"accessKey"`
+		SecretKey string `yaml:"secretKey"`
+	} `yaml:"config"`
+}
+
+// OpenStackNodeImage represents the structure of the OpenStackNodeImages.
+type OpenStackNodeImage struct {
+	URL        string `yaml:"url"`
+	CreateOpts struct {
+		Name            string `yaml:"name"`
+		DiskFormat      string `yaml:"disk_format"`      //nolint:tagliatelle // The `DiskFormat` field in this struct corresponds to the `disk_format` YAML tag
+		ContainerFormat string `yaml:"container_format"` //nolint:tagliatelle // The `ContainerFormat` field in this struct corresponds to the `container_format` YAML tag
+		Visibility      string `yaml:"visibility"`
+	} `yaml:"createOpts"`
+}
+
+// NodeImages represents the structure of the config.yaml file.
+type NodeImages struct {
+	APIVersion          string               `yaml:"apiVersion"`
+	OpenStackNodeImages []OpenStackNodeImage `yaml:"openStackNodeImages"`
+}
+
+const (
+	provider        = "openstack"
+	outputDirectory = "./output"
+)
+
+func usage() {
+	fmt.Printf(`%s create-node-images cluster-stack-directory cluster-stack-release-directory
+This command is a csctl plugin.
+https://github.com/SovereignCloudStack/csctl
+`, os.Args[0])
+}
+
+func main() {
+	if len(os.Args) != 4 {
+		usage()
+		os.Exit(1)
+	}
+	if os.Args[1] != "create-node-images" {
+		usage()
+		os.Exit(1)
+	}
+	clusterStackPath := os.Args[2]
+	configFilePath := filepath.Join(clusterStackPath, "node-images", "config.yaml")
+	config, err := csctlclusterstack.GetCsctlConfig(clusterStackPath)
+	if err != nil {
+		fmt.Println(err.Error())
+		os.Exit(1)
+	}
+	if config.Config.Provider.Type != provider {
+		fmt.Printf("Wrong provider in %s. Expected %s\n", clusterStackPath, provider)
+		os.Exit(1)
+	}
+	releaseDir := os.Args[3]
+	_, err = os.Stat(releaseDir)
+	if err != nil {
+		fmt.Println(err.Error())
+		os.Exit(1)
+	}
+	method := config.Config.Provider.Config.Method
+	switch strings.ToLower(method) {
+	case "get":
+		// Copy config.yaml to releaseDir as node-images.yaml
+		dest := filepath.Join(releaseDir, "node-images.yaml")
+		if err := copyFile(configFilePath, dest); err != nil {
+			fmt.Printf("Error copying config.yaml to releaseDir: %v\n", err)
+			os.Exit(1)
+		}
+		fmt.Println("config.yaml copied to releaseDir as node-images.yaml successfully!")
+	case "build":
+		if len(config.Config.Provider.Config.Images) > 0 {
+			for _, image := range config.Config.Provider.Config.Images {
+				// Construct the path to the image folder
+				packerImagePath := filepath.Join(clusterStackPath, "node-images", *image)
+
+				if _, err := os.Stat(packerImagePath); err == nil {
+					fmt.Println("Running packer build...")
+					// #nosec G204
+					cmd := exec.Command("packer", "build", "-var", "build_name="+*image, "-var", "output_directory="+outputDirectory, packerImagePath)
+					cmd.Stdout = os.Stdout
+					cmd.Stderr = os.Stderr
+					if err := cmd.Run(); err != nil {
+						fmt.Printf("Error running packer build: %v\n", err)
+						os.Exit(1)
+					}
+					fmt.Println("Packer build completed successfully.")
+
+					registryConfigPath := filepath.Join(clusterStackPath, "node-images", "registry.yaml")
+
+					// Get the current working directory
+					currentDir, err := os.Getwd()
+					if err != nil {
+						fmt.Printf("Error getting current working directory: %v\n", err)
+						os.Exit(1)
+					}
+
+					// Path to the image created by the packer
+					// Warning: name of the image created by packer should have same name as the name of the image folder in node-images
+					ouputImagePath := filepath.Join(currentDir, outputDirectory, *image)
+
+					// Push the built image to S3
+					if err := pushToS3(ouputImagePath, *image, registryConfigPath); err != nil {
+						fmt.Printf("Error pushing image to S3: %v\n", err)
+						os.Exit(1)
+					}
+					// TODO: create node-images.yaml in releaseDir after building and pushing image to registry were successful
+					// Update URL in config.yaml if it is necessary
+					if err := updateURLNodeImages(configFilePath, registryConfigPath, *image); err != nil {
+						fmt.Printf("Error updating URL in config.yaml: %v\n", err)
+						os.Exit(1)
+					}
+					// Copy config.yaml to releaseDir as node-images.yaml
+					dest := filepath.Join(releaseDir, "node-images.yaml")
+					if err := copyFile(configFilePath, dest); err != nil {
+						fmt.Printf("Error copying config.yaml to releaseDir: %v\n", err)
+						os.Exit(1)
+					}
+					fmt.Println("config.yaml copied to releaseDir as node-images.yaml successfully!")
+				} else {
+					fmt.Printf("Image folder %s does not exist\n", packerImagePath)
+				}
+			}
+		} else {
+			fmt.Println("No images to build")
+		}
+	default:
+		fmt.Println("Unknown method:", method)
+	}
+}
+
+func pushToS3(filePath, fileName, registryConfigPath string) error {
+	// Load registry configuration from YAML file
+	// #nosec G304
+	registryConfigFile, err := os.Open(registryConfigPath)
+	if err != nil {
+		return fmt.Errorf("error opening registry config file: %w", err)
+	}
+	defer registryConfigFile.Close()
+
+	var registryConfig RegistryConfig
+	decoder := yaml.NewDecoder(registryConfigFile)
+	if err := decoder.Decode(&registryConfig); err != nil {
+		return fmt.Errorf("error decoding registry config file: %w", err)
+	}
+
+	// Initialize Minio client
+	minioClient, err := minio.New(registryConfig.Config.Endpoint, &minio.Options{
+		Creds:  credentials.NewStaticV4(registryConfig.Config.AccessKey, registryConfig.Config.SecretKey, ""),
+		Secure: true,
+	})
+	if err != nil {
+		return fmt.Errorf("error initializing Minio client: %w", err)
+	}
+
+	// Open file to upload
+	// #nosec G304
+	file, err := os.Open(filePath)
+	if err != nil {
+		return fmt.Errorf("error opening file: %w", err)
+	}
+	defer file.Close()
+
+	// Get file info
+	fileInfo, err := file.Stat()
+	if err != nil {
+		return fmt.Errorf("error getting file info: %w", err)
+	}
+
+	// Upload file to bucket
+	_, err = minioClient.PutObject(context.Background(), registryConfig.Config.Bucket, fileName, file, fileInfo.Size(), minio.PutObjectOptions{})
+	if err != nil {
+		return fmt.Errorf("error uploading file: %w", err)
+	}
+	return nil
+}
+
+func updateURLNodeImages(configFilePath, registryConfigPath, imageName string) error {
+	// Read the config.yaml file
+	// #nosec G304
+	nodeImageData, err := os.ReadFile(configFilePath)
+	if err != nil {
+		return fmt.Errorf("failed to read config.yaml: %w", err)
+	}
+
+	// Unmarshal YAML data into NodeImages struct
+	var nodeImages NodeImages
+	if err := yaml.Unmarshal(nodeImageData, &nodeImages); err != nil {
+		return fmt.Errorf("failed to unmarshal YAML: %w", err)
+	}
+
+	// Check if the URL already exists for the given image
+	var imageURLExists bool
+	for _, image := range nodeImages.OpenStackNodeImages {
+		if image.URL != "" {
+			imageURLExists = true
+			break
+		}
+	}
+	// If the URL doesn't exist, update it for the image
+	if !imageURLExists {
+		// Load registry configuration from YAML file
+		// #nosec G304
+		registryConfigFile, err := os.Open(registryConfigPath)
+		if err != nil {
+			return fmt.Errorf("error opening registry config file: %w", err)
+		}
+		defer registryConfigFile.Close()
+
+		var registryConfig RegistryConfig
+		decoder := yaml.NewDecoder(registryConfigFile)
+		if err := decoder.Decode(&registryConfig); err != nil {
+			return fmt.Errorf("error decoding registry config file: %w", err)
+		}
+		// Generate URL
+		newURL := fmt.Sprintf("%s%s/%s/%s", "https://", registryConfig.Config.Endpoint, registryConfig.Config.Bucket, imageName)
+		for i := range nodeImages.OpenStackNodeImages {
+			nodeImages.OpenStackNodeImages[i].URL = newURL
+			break
+		}
+
+		// Marshal the updated struct back to YAML
+		updatedNodeImageData, err := yaml.Marshal(&nodeImages)
+		if err != nil {
+			return fmt.Errorf("failed to marshal YAML: %w", err)
+		}
+
+		// Write the updated YAML data back to the file
+		if err := os.WriteFile(configFilePath, updatedNodeImageData, os.FileMode(0o644)); err != nil {
+			return fmt.Errorf("failed to write config.yaml: %w", err)
+		}
+
+		fmt.Printf("URL updated for image: %s\n", newURL)
+	} else {
+		fmt.Printf("URL already exists for the image\n")
+	}
+	return nil
+}
+
+func copyFile(src, dest string) error {
+	// #nosec G304
+	data, err := os.ReadFile(src)
+	if err != nil {
+		return fmt.Errorf("error reading source file: %w", err)
+	}
+
+	if err := os.WriteFile(dest, data, os.FileMode(0o644)); err != nil {
+		return fmt.Errorf("error writing to destination file: %w", err)
+	}
+
+	return nil
+}

csctlopenstack/example/cluster-stacks/openstack/ferrol/cluster-addon-values.yaml

@@ -0,0 +1,5 @@
+values: |
+  metrics-server:
+    commonLabels:
+      domain: "{{ .Cluster.spec.controlPlaneEndpoint.host }}"
+      clusterAddonVersion: "v2"

csctlopenstack/example/cluster-stacks/openstack/ferrol/cluster-addon/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/

csctlopenstack/example/cluster-stacks/openstack/ferrol/cluster-addon/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: metrics-server
+  repository: https://kubernetes-sigs.github.io/metrics-server/
+  version: 3.11.0
+digest: sha256:d92caa34d06b047b0390aa33a6f5d15d4fe0566143625204ebbbc69085133c4e
+generated: "2023-09-12T12:02:23.747094767+02:00"

csctlopenstack/example/cluster-stacks/openstack/ferrol/cluster-addon/Chart.yaml

@@ -0,0 +1,14 @@
+apiVersion: v2
+dependencies:
+- alias: metrics-server
+  name: metrics-server
+  repository: https://kubernetes-sigs.github.io/metrics-server/
+  version: 3.11.0
+description: 'This chart installs and configures: * Openstack Ferrol Cluster Class '
+maintainers:
+- email: info@syself.com
+  name: Syself
+  url: https://github.com/syself
+name: openstack-ferrol-1-27-cluster-addon
+type: application
+version: << .ClusterAddonVersion >>

csctlopenstack/example/cluster-stacks/openstack/ferrol/cluster-addon/charts/metrics-server/.helmignore

@@ -0,0 +1,23 @@
+# Patterns to ignore when building packages.
+# This supports shell glob matching, relative path matching, and
+# negation (prefixed with !). Only one pattern per line.
+.DS_Store
+# Common VCS dirs
+.git/
+.gitignore
+.bzr/
+.bzrignore
+.hg/
+.hgignore
+.svn/
+# Common backup files
+*.swp
+*.bak
+*.tmp
+*.orig
+*~
+# Various IDEs
+.project
+.idea/
+*.tmproj
+.vscode/