implement grid-compose

go.work

@@ -1,4 +1,4 @@
-go 1.21
+go 1.21.0
 
 use (
 	./activation-service
@@ -12,4 +12,5 @@ use (
 	./tfrobot
 	./tools/relay-cache-warmer
 	./user-contracts-mon
+	./grid-compose
 )

grid-compose/.gitignore

@@ -0,0 +1,3 @@
+bin/*
+.pre-commit-config.yaml
+out

grid-compose/Makefile

@@ -0,0 +1,9 @@
+BIN_PATH = bin/main
+
+.PHONY: build run
+
+build:
+	@go build -o $(BIN_PATH) ./main.go
+
+run:
+	@go run main.go up -f ./grid-compose.yaml

grid-compose/README.md

@@ -0,0 +1,22 @@
+# Grid-Compose
+
+is a tool for running multi-vm applications on TFGrid defined using a Yaml formatted file.
+
+## Usage
+
+`REQUIRED` EnvVars:
+
+- `MNEMONIC`: your secret words
+- `NETWORK`: one of (dev, qa, test, main)
+
+```bash
+grid-compose [OPTIONS] [COMMAND]
+
+OPTIONS:
+    -f path to yaml file, default is ./grid-compose.yaml
+
+COMMANDS:
+    - version: shows the project version
+    - up:      deploy the app
+    - down:    cancel all deployments
+```

grid-compose/cmd/down.go

@@ -0,0 +1,16 @@
+package cmd
+
+import (
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+)
+
+var downCmd = &cobra.Command{
+	Use:   "down",
+	Short: "cancel your project on the grid",
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := app.Down(); err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}

grid-compose/cmd/ps.go

@@ -0,0 +1,18 @@
+package cmd
+
+import (
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+)
+
+var psCmd = &cobra.Command{
+	Use:   "ps",
+	Short: "list containers",
+	Run: func(cmd *cobra.Command, args []string) {
+		flags := cmd.Flags()
+
+		if err := app.Ps(cmd.Context(), flags); err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}

grid-compose/cmd/root.go

@@ -0,0 +1,50 @@
+package cmd
+
+import (
+	"os"
+
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+	"github.com/threefoldtech/tfgrid-sdk-go/grid-compose/internal"
+)
+
+var (
+	app        *internal.App
+	configPath string
+	network    string
+	mnemonic   string
+)
+
+func Execute() {
+	if err := rootCmd.Execute(); err != nil {
+		log.Fatal().Err(err).Send()
+	}
+}
+
+var rootCmd = &cobra.Command{
+	Use:   "grid-compose",
+	Short: "Grid-Compose is a tool for running multi-vm applications on TFGrid defined using a Yaml formatted file.",
+	PersistentPreRun: func(cmd *cobra.Command, args []string) {
+		var err error
+		app, err = internal.NewApp(network, mnemonic, configPath)
+		if err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}
+
+func init() {
+	network = os.Getenv("NETWORK")
+	mnemonic = os.Getenv("MNEMONIC")
+	rootCmd.PersistentFlags().StringVarP(&configPath, "file", "f", "./grid-compose.yaml", "the grid-compose configuration file")
+	psCmd.PersistentFlags().BoolP("verbose", "v", false, "all information about deployed services")
+	psCmd.PersistentFlags().StringP("output", "o", "", "output result to a file")
+
+	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+
+	rootCmd.AddCommand(versionCmd)
+	rootCmd.AddCommand(upCmd)
+	rootCmd.AddCommand(psCmd)
+	rootCmd.AddCommand(downCmd)
+}

grid-compose/cmd/up.go

@@ -0,0 +1,20 @@
+package cmd
+
+import (
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+)
+
+// load config from file + validate
+// parse environment variables
+// deploy networks + volumes
+// deploy services
+var upCmd = &cobra.Command{
+	Use:   "up",
+	Short: "deploy application on the grid",
+	Run: func(cmd *cobra.Command, args []string) {
+		if err := app.Up(cmd.Context()); err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}

grid-compose/cmd/version.go

@@ -0,0 +1,17 @@
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+var version = "v0.0.1"
+
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "get current version number",
+	Run: func(cmd *cobra.Command, args []string) {
+		fmt.Println(version)
+	},
+}

grid-compose/example/full_example.yml

@@ -0,0 +1,58 @@
+# not all features here are implemented yet
+version: '1.0.0'
+
+# cannot figure out how to run mycelium always error deployment not configured
+networks:
+  net1:
+    type: 'wg'
+  net2:
+    type: 'myc'
+  net3:
+    type: 'ygg'
+  net4:
+    type: 'ip4'
+  net5:
+    type: 'ip6'
+
+services:
+  web:
+    flist: 'https://hub.grid.tf/tf-official-apps/nginx-latest.flist'
+    environment:
+      - ENV_VAR_NAME=value
+    volumes:
+      - web-data:/data
+    networks:
+      - net1
+    resources:
+      cpu: 2
+      memory: 2
+    depends_on:
+      - database
+  database:
+    flist: 'https://hub.grid.tf/tf-official-apps/postgresql-latest.flist'
+    environment:
+      - POSTGRES_DB=postgres
+      - POSTGRES_USER=postgres
+      - POSTGRES_PASSWORD=password
+    volumes:
+      - db-data:/var/lib/postgresql/data
+    networks:
+      - net1
+      - net2
+      - net3
+    resources:
+      cpu: 4
+      memory: 2
+    healthcheck:
+      test: ['CMD', 'curl', 'http://{myceliumip}']
+      interval: 1m30s
+      timeout: 10s
+      retries: 3
+# ask omar about the types zmount and all that
+storage:
+  web-data:
+    type: 'zmount'
+    size: 10GB
+  db-data:
+    type: 'zmount'
+    size: 10GB

grid-compose/example/full_example_v2.yml

@@ -0,0 +1,57 @@
+version: '1.0.0'
+
+networks:
+  net1:
+    name: 'nettyy'
+    nodes:
+      - 11
+      - 14
+      - 144
+    range:
+      ip:
+        type: ip4
+        ip: 10.20.0.0
+      mask:
+        type: cidr
+        mask: 16/32
+      wg: true
+
+project_name: 'example_project'
+services:
+  web5:
+    flist: 'https://hub.grid.tf/tf-official-vms/ubuntu-24.04-full.flist'
+    networks:
+      - net1
+    network_types:
+      - ip4
+      - ygg
+    node_id: 11
+    entrypoint: '/sbin/zinit init'
+    volumes:
+      - webdata:/data
+    resources:
+      cpu: 1
+      memory: 2048
+      disk: 25600
+  database:
+    flist: 'https://hub.grid.tf/tf-official-vms/ubuntu-24.04-full.flist'
+    networks:
+      - net1
+    network_types:
+      - ygg
+    volumes:
+      - dbdata:/var/lib/postgresql/data
+    node_id: 11
+    entrypoint: '/sbin/zinit init'
+    resources:
+      cpu: 1
+      memory: 2048
+      disk: 25600
+
+storage:
+  webdata:
+    type: 'zmount'
+    size: 10GB
+  dbdata:
+    type: 'zmount'
+    size: 10GB

grid-compose/example/full_example_v3.yml

@@ -0,0 +1,50 @@
+version: '1.0.0'
+
+networks:
+  net1:
+    type: 'wg'
+  net2:
+    type: 'myc'
+  net3:
+    type: 'ygg'
+  net4:
+    type: 'ip4'
+  net5:
+    type: 'ip6'
+
+services:
+  web5:
+    flist: 'https://hub.grid.tf/tf-official-vms/ubuntu-24.04-full.flist'
+    networks:
+      - net3
+      - net4
+      - net5
+    node_id: 144
+    entrypoint: '/sbin/zinit init'
+    volumes:
+      - webdata:/data
+    resources:
+      cpu: 1
+      memory: 2048
+      disk: 25600
+  database:
+    flist: 'https://hub.grid.tf/tf-official-vms/ubuntu-24.04-full.flist'
+    networks:
+      - net3
+      - net1
+    volumes:
+      - dbdata:/var/lib/postgresql/data
+    node_id: 14
+    entrypoint: '/sbin/zinit init'
+    resources:
+      cpu: 1
+      memory: 2048
+      disk: 25600
+
+storage:
+  webdata:
+    type: 'zmount'
+    size: 10GB
+  dbdata:
+    type: 'zmount'
+    size: 10GB

grid-compose/example/single_vm.yml

@@ -0,0 +1,14 @@
+version: '1.0.0'
+
+services:
+  new_single_vm:
+    flist: 'https://hub.grid.tf/omarabdulaziz.3bot/ubuntu-jammy.flist'
+    entrypoint: '/sbin/init'
+    environment:
+      - SSH_KEY=...
+    resources:
+      cpu: 1
+      memory: 512
+    node_id: 14
+    networks:
+      - yggdrasil

grid-compose/go.mod

@@ -0,0 +1,16 @@
+module github.com/threefoldtech/tfgrid-sdk-go/grid-compose
+
+go 1.21.0
+
+require (
+	github.com/rs/zerolog v1.33.0
+	github.com/spf13/cobra v1.8.0
+)
+
+require (
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
+	github.com/spf13/pflag v1.0.5 // indirect
+	golang.org/x/sys v0.12.0 // indirect
+)