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,6 @@
+bin/*
+.pre-commit-config.yaml
+out
+full_example.yml
+invalid
+grid-compose.yml

grid-compose/Makefile

@@ -0,0 +1,21 @@
+test:
+	@echo "Running Tests"
+	go test -v ./...
+
+clean:
+	rm ./bin -rf
+
+getverifiers:
+	@echo "Installing golangci-lint" && go install github.com/golangci/golangci-lint/cmd/golangci-lint
+	go mod tidy
+
+lint:
+	@echo "Running $@"
+	golangci-lint run -c ../.golangci.yml
+
+build:
+	@echo "Running $@"
+	@go build -ldflags=\
+	"-X 'github.com/threefoldtech/tfgrid-sdk-go/grid-compose/cmd.commit=$(shell git rev-parse HEAD)'\
+	 -X 'github.com/threefoldtech/tfgrid-sdk-go/grid-compose/cmd.version=$(shell git tag --sort=-version:refname | head -n 1)'"\
+	 -o bin/grid-compose main.go

grid-compose/README.md

@@ -0,0 +1,163 @@
+# Grid-Compose
+
+is a tool similar to docker-compose created for running multi-vm applications on TFGrid defined using a Yaml formatted file.
+
+The yaml file's structure is defined in [docs/config](docs/config.md).
+
+## Usage
+
+`REQUIRED` EnvVars:
+
+- `MNEMONIC`: your secret words
+- `NETWORK`: one of (dev, qa, test, main)
+
+```bash
+grid-compose [OPTIONS] [COMMAND]
+
+OPTIONS:
+    -f, --file: path to yaml file, default is ./grid-compose.yml
+
+COMMANDS:
+    - version: shows the project version
+    - up:      deploy the app
+    - down:    cancel all deployments
+    - ps: list deployments on the grid
+        OPTIONS:
+            - -v, --verbose: show full details of each deployment
+```
+
+Export env vars using:
+
+```bash
+export MNEMONIC=your_mnemonics
+export NETWORK=working_network
+```
+
+Run:
+
+```bash
+make build
+```
+
+To use any of the commands, run:
+
+```bash
+./bin/grid-compose [COMMAND]
+```
+
+For example:
+
+```bash
+./bin/grid-compose ps -f example/multiple_services_diff_network_3.yml
+```
+
+## Usage For Each Command
+
+### up
+
+The up command deploys the services defined in the yaml file to the grid.
+
+Refer to the [cases](docs/cases.md) for more information on the cases supported.
+
+Refer to examples in the [examples](examples) directory to have a look at different possible configurations.
+
+```bash
+./bin/grid-compose up [OPTIONS]
+```
+
+OPTIONS:
+
+- `-f, --file`: path to the yaml file, default is `./grid-compose.yml`
+
+### Example
+
+```bash
+./bin/grid-compose up
+```
+
+output:
+
+```bash
+3:40AM INF starting peer session=tf-848216 twin=8658
+3:40AM INF deploying network... name=miaminet node_id=14
+3:41AM INF deployed successfully
+3:41AM INF deploying vm... name=database node_id=14
+3:41AM INF deployed successfully
+3:41AM INF deploying network... name=miaminet node_id=14
+3:41AM INF deployed successfully
+3:41AM INF deploying vm... name=server node_id=14
+3:41AM INF deployed successfully
+3:41AM INF all deployments deployed successfully
+```
+
+### down
+
+The down command cancels all deployments on the grid.
+
+```bash
+./bin/grid-compose down [OPTIONS]
+```
+
+OPTIONS:
+
+- `-f, --file`: path to the yaml file, default is `./grid-compose.yml`
+
+### Example
+
+```bash
+./bin/grid-compose down
+```
+
+output:
+
+```bash
+3:45AM INF starting peer session=tf-854215 twin=8658
+3:45AM INF canceling deployments projectName=vm/compose/8658/net1
+3:45AM INF canceling contracts project name=vm/compose/8658/net1
+3:45AM INF project is canceled project name=vm/compose/8658/net1
+```
+
+### ps
+
+The ps command lists all deployments on the grid.
+
+```bash
+./bin/grid-compose ps [FLAGS] [OPTIONS]
+```
+
+OPTIONS:
+
+- `-f, --file`: path to the yaml file, default is `./grid-compose.yml`
+
+### Example
+
+```bash
+./bin/grid-compose ps
+```
+
+output:
+
+```bash
+3:43AM INF starting peer session=tf-851312 twin=8658
+
+Deployment Name | Node ID         | Network         | Services        | Storage         | State      | IP Address
+------------------------------------------------------------------------------------------------------------------------------------------------------
+dl_database     | 14              | miaminet        | database        | dbdata          | ok         | wireguard: 10.20.2.2
+dl_server       | 14              | miaminet        | server          | webdata         | ok         | wireguard: 10.20.2.3
+```
+
+FLAGS:
+
+- `-v, --verbose`: show full details of each deployment
+
+### version
+
+The version command shows the project's current version.
+
+```bash
+./bin/grid-compose version
+```
+
+## Future Work
+
+Refer to [docs/future_work.md](docs/future_work.md) for more information on the future work that is to be done on the grid-compose project.

grid-compose/cmd/down.go

@@ -0,0 +1,22 @@
+package cmd
+
+import (
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+	"github.com/threefoldtech/tfgrid-sdk-go/grid-compose/internal/app"
+)
+
+var downCmd = &cobra.Command{
+	Use:   "down",
+	Short: "cancel your project on the grid",
+	Run: func(cmd *cobra.Command, args []string) {
+		app, ok := cmd.Context().Value("app").(*app.App)
+		if !ok {
+			log.Fatal().Msg("app not found in context")
+		}
+
+		if err := app.Down(); err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}

grid-compose/cmd/ps.go

@@ -0,0 +1,27 @@
+package cmd
+
+import (
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+	"github.com/threefoldtech/tfgrid-sdk-go/grid-compose/internal/app"
+)
+
+var psCmd = &cobra.Command{
+	Use:   "ps",
+	Short: "list deployments on the grid",
+	Run: func(cmd *cobra.Command, args []string) {
+		verbose, err := cmd.Flags().GetBool("verbose")
+		if err != nil {
+			log.Fatal().Err(err).Send()
+		}
+
+		app, ok := cmd.Context().Value("app").(*app.App)
+		if !ok {
+			log.Fatal().Msg("app not found in context")
+		}
+
+		if err := app.Ps(cmd.Context(), verbose); err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}

grid-compose/cmd/root.go

@@ -0,0 +1,50 @@
+package cmd
+
+import (
+	"context"
+	"os"
+
+	"github.com/rs/zerolog"
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+	"github.com/threefoldtech/tfgrid-sdk-go/grid-compose/internal/app"
+)
+
+func Execute() {
+	if err := rootCmd.Execute(); err != nil {
+		log.Fatal().Err(err).Send()
+	}
+}
+
+// TODO: validate command line arguments
+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) {
+		network := os.Getenv("NETWORK")
+		mnemonic := os.Getenv("MNEMONIC")
+		configPath, _ := cmd.Flags().GetString("file")
+
+		app, err := app.NewApp(network, mnemonic, configPath)
+
+		if err != nil {
+			log.Fatal().Err(err).Send()
+		}
+
+		ctx := context.WithValue(cmd.Context(), "app", app)
+		cmd.SetContext(ctx)
+	},
+}
+
+func init() {
+	rootCmd.PersistentFlags().StringP("file", "f", "./grid-compose.yml", "the grid-compose configuration file")
+
+	rootCmd.AddCommand(downCmd)
+	rootCmd.AddCommand(upCmd)
+	rootCmd.AddCommand(versionCmd)
+
+	psCmd.PersistentFlags().BoolP("verbose", "v", false, "all information about deployed services")
+	rootCmd.AddCommand(psCmd)
+
+	log.Logger = log.Output(zerolog.ConsoleWriter{Out: os.Stderr})
+}

grid-compose/cmd/up.go

@@ -0,0 +1,22 @@
+package cmd
+
+import (
+	"github.com/rs/zerolog/log"
+	"github.com/spf13/cobra"
+	"github.com/threefoldtech/tfgrid-sdk-go/grid-compose/internal/app"
+)
+
+var upCmd = &cobra.Command{
+	Use:   "up",
+	Short: "deploy application on the grid",
+	Run: func(cmd *cobra.Command, args []string) {
+		app, ok := cmd.Context().Value("app").(*app.App)
+		if !ok {
+			log.Fatal().Msg("app not found in context")
+		}
+
+		if err := app.Up(cmd.Context()); err != nil {
+			log.Fatal().Err(err).Send()
+		}
+	},
+}

grid-compose/cmd/version.go

@@ -0,0 +1,22 @@
+// Package cmd for parsing command line arguments
+package cmd
+
+import (
+	"log"
+
+	"github.com/spf13/cobra"
+)
+
+// set at build time
+var commit string
+var version string
+
+// versionCmd represents the version command
+var versionCmd = &cobra.Command{
+	Use:   "version",
+	Short: "Get latest build tag",
+	Run: func(cmd *cobra.Command, args []string) {
+		log.Println(version)
+		log.Println(commit)
+	},
+}