Script Runner addon

README.md

@@ -92,6 +92,10 @@ You can install some addons to your cluster using the `cluster addon` sub-comman
 $ hetzner-kube cluster addon list
 ```
 
+## Script Runner Addon
+
+The addon lets you run bash scripts on the running nodes, check [Script Runner Guide](docs/script-runner-addon.md) for more info. 
+
 ### contributing new addons
 
 You want to add some cool stuff to hetzner-kube? It's quite easy! Learn how to add new addons in the [Developing Addons](docs/cluster-addons.md) documentation.

cmd/cluster_addon.go

@@ -51,8 +51,8 @@ func validateAddonSubCommand(cmd *cobra.Command, args []string) error {
 	if idx == -1 {
 		return fmt.Errorf("cluster '%s' not found", name)
 	}
-	if len(args) != 1 {
-		return errors.New("exactly one argument expected")
+	if len(args) < 1 {
+		return errors.New("please add the addon name argument")
 	}
 	addonName := args[0]
 	provider := hetzner.NewHetznerProvider(AppConf.Context, AppConf.Client, *cluster, AppConf.CurrentContext.Token)

cmd/cluster_addon_install.go

@@ -44,7 +44,7 @@ var clusterAddonInstallCmd = &cobra.Command{
 		FatalOnError(err)
 
 		addon := addonService.GetAddon(addonName)
-		addon.Install()
+		addon.Install(args...)
 
 		log.Printf("addon %s successfully installed", addonName)
 	},

docs/script-runner-addon.md

@@ -0,0 +1,28 @@
+# Script Runner Addon Guide
+
+Script Runner lets you run a bash script on all your cluster nodes with one command. It uploads the bash script to each node then execute. The script will receive two arguments upon execution:
+1) Node group, for example (master, worker, etcd)
+2) Cluster info JSON config, which is similar to the hetzner-kube config found in `~/.hetzner-kube/config.json`
+
+### Example
+hetzner-kube Command:
+```bash
+hetzner-kube cluster addon install --name demo script-runner /path/to/script.sh  
+```
+Example script.sh:
+```bash
+
+#node group
+echo $1
+#cluster info 
+echo $2
+
+if [ "$1" == "worker" ]; then
+    apt-get install ceph-fs-common ceph-common -y
+fi
+
+
+echo $2 | python -c "import sys, json; print json.load(sys.stdin)[0]['name']"
+
+```
+

pkg/addons/addon_script_runner.go

@@ -0,0 +1,83 @@
+package addons
+
+import (
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"log"
+	"math/rand"
+	"strings"
+	"time"
+
+	"github.com/xetys/hetzner-kube/pkg/clustermanager"
+)
+
+// ScriptRunnerAddon installs script runner
+type ScriptRunnerAddon struct {
+	communicator clustermanager.NodeCommunicator
+	nodes        []clustermanager.Node
+	cluster      clustermanager.Cluster
+}
+
+// NewScriptRunnerAddon installs script runner to the cluster
+func NewScriptRunnerAddon(provider clustermanager.ClusterProvider, communicator clustermanager.NodeCommunicator) ClusterAddon {
+	return ScriptRunnerAddon{communicator: communicator, nodes: provider.GetAllNodes(), cluster: provider.GetCluster()}
+}
+
+func init() {
+	addAddon(NewScriptRunnerAddon)
+}
+
+// Name returns the addons name
+func (addon ScriptRunnerAddon) Name() string {
+	return "script-runner"
+}
+
+// Requires returns a slice with the name of required addons
+func (addon ScriptRunnerAddon) Requires() []string {
+	return []string{}
+}
+
+// Description returns the addons description
+func (addon ScriptRunnerAddon) Description() string {
+	return "Bash remote script runner"
+}
+
+// URL returns the URL of the addons underlying project
+func (addon ScriptRunnerAddon) URL() string {
+	return "https://www.gnu.org/software/bash/"
+}
+
+// Install performs all steps to install the addon
+func (addon ScriptRunnerAddon) Install(args ...string) {
+
+	if len(args) < 2 {
+		log.Fatal("path argument is missing")
+	}
+	scriptPath := args[1]
+	scriptContents, err := ioutil.ReadFile(scriptPath)
+	FatalOnError(err)
+
+	clusterInfoBin, err := json.Marshal(addon.cluster)
+	FatalOnError(err)
+
+	replacer := strings.NewReplacer("\n", "", "'", "\\'")
+	clusterInfo := replacer.Replace(string(clusterInfoBin))
+
+	for _, node := range addon.nodes {
+		scriptRemotePath := fmt.Sprintf("/tmp/script-%s-%d.sh", time.Now().Format("20060102150405"), rand.Int31())
+		err = addon.communicator.WriteFile(node, scriptRemotePath, string(scriptContents), true)
+		FatalOnError(err)
+
+		output, err := addon.communicator.RunCmd(
+			node,
+			fmt.Sprintf("bash %s %s '%s'", scriptRemotePath, node.Group, clusterInfo))
+		FatalOnError(err)
+		fmt.Printf("%s %s: script ran successfully..\n%s\n", node.Name, node.IPAddress, output)
+	}
+}
+
+// Uninstall performs all steps to remove the addon
+func (addon ScriptRunnerAddon) Uninstall() {
+	fmt.Println("no uninstall for this addon")
+}

pkg/clustermanager/types.go

@@ -4,6 +4,7 @@ package clustermanager
 type Node struct {
 	Name             string    `json:"name"`
 	Type             string    `json:"type"`
+	Group            string    `json:"group"`
 	IsMaster         bool      `json:"is_master"`
 	IsEtcd           bool      `json:"is_etcd"`
 	IPAddress        string    `json:"ip_address"`

pkg/hetzner/hetzner_provider.go

@@ -41,7 +41,7 @@ func NewHetznerProvider(context context.Context, client *hcloud.Client, cluster
 }
 
 // CreateNodes creates hetzner nodes
-func (provider *Provider) CreateNodes(suffix string, template clustermanager.Node, datacenters []string, count int, offset int) ([]clustermanager.Node, error) {
+func (provider *Provider) CreateNodes(template clustermanager.Node, datacenters []string, count int, offset int) ([]clustermanager.Node, error) {
 	sshKey, _, err := provider.client.SSHKey.Get(provider.context, template.SSHKeyName)
 
 	if err != nil {
@@ -52,7 +52,7 @@ func (provider *Provider) CreateNodes(suffix string, template clustermanager.Nod
 		return nil, fmt.Errorf("we got some problem with the SSH-Key '%s', chances are you are in the wrong context", template.SSHKeyName)
 	}
 
-	serverNameTemplate := fmt.Sprintf("%s-%s-@idx", provider.clusterName, suffix)
+	serverNameTemplate := fmt.Sprintf("%s-%s-@idx", provider.clusterName, template.Group)
 	serverOptsTemplate := hcloud.ServerCreateOpts{
 		Name: serverNameTemplate,
 		ServerType: &hcloud.ServerType{
@@ -127,20 +127,20 @@ func (provider *Provider) CreateNodes(suffix string, template clustermanager.Nod
 
 // CreateEtcdNodes creates nodes with type 'etcd'
 func (provider *Provider) CreateEtcdNodes(sshKeyName string, masterServerType string, datacenters []string, count int) ([]clustermanager.Node, error) {
-	template := clustermanager.Node{SSHKeyName: sshKeyName, IsEtcd: true, Type: masterServerType}
-	return provider.CreateNodes("etcd", template, datacenters, count, 0)
+	template := clustermanager.Node{SSHKeyName: sshKeyName, IsEtcd: true, Type: masterServerType, Group: "etcd"}
+	return provider.CreateNodes(template, datacenters, count, 0)
 }
 
 // CreateMasterNodes creates nodes with type 'master'
 func (provider *Provider) CreateMasterNodes(sshKeyName string, masterServerType string, datacenters []string, count int, isEtcd bool) ([]clustermanager.Node, error) {
-	template := clustermanager.Node{SSHKeyName: sshKeyName, IsMaster: true, Type: masterServerType, IsEtcd: isEtcd}
-	return provider.CreateNodes("master", template, datacenters, count, 0)
+	template := clustermanager.Node{SSHKeyName: sshKeyName, IsMaster: true, Type: masterServerType, IsEtcd: isEtcd, Group: "master"}
+	return provider.CreateNodes(template, datacenters, count, 0)
 }
 
 // CreateWorkerNodes create new worker node on provider
 func (provider *Provider) CreateWorkerNodes(sshKeyName string, workerServerType string, datacenters []string, count int, offset int) ([]clustermanager.Node, error) {
-	template := clustermanager.Node{SSHKeyName: sshKeyName, IsMaster: false, Type: workerServerType}
-	return provider.CreateNodes("worker", template, datacenters, count, offset)
+	template := clustermanager.Node{SSHKeyName: sshKeyName, IsMaster: false, Type: workerServerType, Group: "worker"}
+	return provider.CreateNodes(template, datacenters, count, offset)
 }
 
 // GetAllNodes retrieves all nodes