Generic way to upload files to hosts (#109)

* Generic way to upload files to hosts

Signed-off-by: Jussi Nummelin <[email protected]>

* Use explicit dstDir attribute for file upload destination

Signed-off-by: Jussi Nummelin <[email protected]>

* bump k0s to 0.12.1-rc.1

Signed-off-by: Jussi Nummelin <[email protected]>

Author: jnummelin

README.md

@@ -217,6 +217,24 @@ environment:
   HTTP_PROXY: 10.0.0.1:443
 ```
 
+###### `spec.hosts[*].files` <sequence> (optional)
+
+List of files to be uploaded to the host. 
+
+Example:
+
+```yaml
+- name: image-bundle
+  src: airgap-images.tgz
+  dstDir: /var/lib/k0s/images/
+  perm: 0700
+```
+
+* `name`: name of the file "bundle", used only for logging purposes (optional)
+* `src`: [Glob pattern](https://golang.org/pkg/path/filepath/#Match) to match files to be uploaded
+* `dstDir`: Destination directory for the file(s). `k0sctl` will create full directory structure if it does not already exist on the host.
+* `perm`: File permission mode for uploaded file(s) and created directories
+
 ##### `spec.hosts[*].ssh` <mapping> (optional)
 
 SSH connection options.

cmd/apply.go

@@ -64,6 +64,7 @@ var applyCommand = &cli.Command{
 			&phase.DownloadBinaries{},
 			&phase.UploadBinaries{},
 			&phase.DownloadK0s{},
+			&phase.UploadFiles{},
 			&phase.ConfigureK0s{},
 			&phase.InitializeK0s{},
 			&phase.InstallControllers{},

config/cluster/host.go

@@ -26,6 +26,7 @@ type Host struct {
 	UploadBinary     bool              `yaml:"uploadBinary,omitempty"`
 	K0sBinaryPath    string            `yaml:"k0sBinaryPath,omitempty"`
 	InstallFlags     Flags             `yaml:"installFlags,omitempty"`
+	Files            []UploadFile      `yaml:"files,omitempty"`
 
 	Metadata   HostMetadata `yaml:"-"`
 	Configurer configurer   `yaml:"-"`

config/cluster/uploadfile.go

@@ -0,0 +1,21 @@
+package cluster
+
+import (
+	"path/filepath"
+)
+
+// UploadFile describes a file to be uploaded for the host
+type UploadFile struct {
+	Name           string `yaml:"name,omitempty"`
+	Source         string `yaml:"src" validate:"required"`
+	DestinationDir string `yaml:"dstDir" validate:"required"`
+	PermMode       string `yaml:"perm" default:"0755"`
+}
+
+func (u *UploadFile) Resolve() ([]string, error) {
+	sources, err := filepath.Glob(u.Source)
+	if err != nil {
+		return nil, err
+	}
+	return sources, nil
+}

phase/uploadfiles.go

@@ -0,0 +1,71 @@
+package phase
+
+import (
+	"path/filepath"
+
+	"github.com/k0sproject/k0sctl/config"
+	"github.com/k0sproject/k0sctl/config/cluster"
+
+	log "github.com/sirupsen/logrus"
+)
+
+// UploadFiles implements a phase which upload files to hosts
+type UploadFiles struct {
+	GenericPhase
+
+	hosts cluster.Hosts
+}
+
+// Title for the phase
+func (p *UploadFiles) Title() string {
+	return "Upload files to hosts"
+}
+
+// Prepare the phase
+func (p *UploadFiles) Prepare(config *config.Cluster) error {
+	p.Config = config
+	p.hosts = p.Config.Spec.Hosts.Filter(func(h *cluster.Host) bool {
+		return len(h.Files) > 0
+	})
+
+	return nil
+}
+
+// ShouldRun is true when there are workers
+func (p *UploadFiles) ShouldRun() bool {
+	return len(p.hosts) > 0
+}
+
+// Run the phase
+func (p *UploadFiles) Run() error {
+	return p.Config.Spec.Hosts.ParallelEach(p.uploadFiles)
+}
+
+func (p *UploadFiles) uploadFiles(h *cluster.Host) error {
+	for _, f := range h.Files {
+		log.Infof("%s: starting to upload %s", h, f.Name)
+		files, err := f.Resolve()
+		if err != nil {
+			return err
+		}
+
+		if err := h.Execf("install -d %s -m %s", f.DestinationDir, f.PermMode); err != nil {
+			return err
+		}
+
+		for _, file := range files {
+			log.Debugf("%s: uploading %s to %s", h, file, f.DestinationDir)
+			destination := filepath.Join(f.DestinationDir, filepath.Base(file))
+
+			if err := h.Upload(file, destination); err != nil {
+				return err
+			}
+
+			if err := h.Configurer.Chmod(h, destination, f.PermMode); err != nil {
+				return err
+			}
+		}
+		log.Infof("%s: %s upload done", h, f.Name)
+	}
+	return nil
+}

smoke-test/k0sctl.yaml

@@ -15,7 +15,7 @@ spec:
         port: 9023
         keyPath: ./id_rsa_k0s
   k0s:
-    version: "0.11.0"
+    version: "0.12.1-rc.1"
     config:
       images:
         konnectivity: