feat: add environment support

Add support for deploying to different environments.

config

@@ -1 +1 @@
-Subproject commit 40b13ab1b1b52d617851f56d89c4017e0360c3b3
+Subproject commit 4d9d8e21385c3c9fe481930ab157724f8d5d0dcc

magefiles/config.go

@@ -6,13 +6,13 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"path/filepath"
 )
 
 type config struct {
 	RootDomain          string           `json:"rootDomain"`
 	FlowGID             int32            `json:"flowGID"`
-	DockerNetworkSubnet string           `json:"dockerNetworkSubnet"`
-	DockerHost          string           `json:"dockerHost"`
+	Docker              dockerConfig     `json:"docker"`
 	Traefik             traefikConfig    `json:"traefik"`
 	Forgejo             forgejoConfig    `json:"forgejo"`
 	GoToSocial          gotosocialConfig `json:"gotosocial"`
@@ -20,6 +20,16 @@ type config struct {
 	Landing             landingConfig    `json:"landing"`
 }
 
+type dockerConfig struct {
+	Host    string              `json:"host"`
+	Network dockerNetworkConfig `json:"network"`
+}
+
+type dockerNetworkConfig struct {
+	Name   string `json:"name"`
+	Subnet string `json:"subnet"`
+}
+
 type traefikConfig struct {
 	Version                string `json:"version"`
 	CheckNewVersion        bool   `json:"checkNewVersion"`
@@ -108,14 +118,16 @@ type landingConfig struct {
 }
 
 type landingConfigLinks struct {
-	Title string
-	URL   string
-	Rel   string
+	Title string `json:"title"`
+	URL   string `json:"url"`
+	Rel   string `json:"rel"`
 }
 
-func newConfig(path string) (config, error) {
+func newConfig(environment string) (config, error) {
 	var c config
 
+	path := filepath.Join(configDir, environment, configFileName)
+
 	f, err := os.Open(path)
 	if err != nil {
 		return c, fmt.Errorf("unable to open the file; %w", err)

magefiles/const.go

@@ -3,7 +3,8 @@
 package main
 
 const (
-	configFile        string = "./config/services.json"
+	configDir         string = "./config/"
+	configFileName    string = "services.json"
 	rootBuildDir      string = "./build"
 	templateExtension string = ".gotmpl"
 	rootTemplatesDir  string = "./templates"

magefiles/deploy.go

@@ -11,25 +11,25 @@ import (
 )
 
 // Deploy deploys the services to the Flow Platform.
-func Deploy(name string) error {
+func Deploy(environment, name string) error {
 	os.Setenv("MAGEFILE_VERBOSE", "true")
 
 	mg.Deps(
 		mg.F(Prepare, name),
 	)
 
-	cfg, err := newConfig(configFile)
+	cfg, err := newConfig(environment)
 	if err != nil {
 		return fmt.Errorf("unable to load the configuration; %w", err)
 	}
 
-	os.Setenv("DOCKER_HOST", cfg.DockerHost)
+	os.Setenv("DOCKER_HOST", cfg.Docker.Host)
 
 	command := []string{
 		"docker",
 		"compose",
 		"--project-directory",
-		rootBuildDir+"/compose",
+		fmt.Sprintf("%s/%s/compose", rootBuildDir, environment),
 		"up",
 		"-d",
 		"--build",

magefiles/download.go

@@ -14,23 +14,23 @@ import (
 )
 
 // Download downloads the binaries for a given service.
-func Download(name string) error {
-	cfg, err := newConfig(configFile)
+func Download(environment, name string) error {
+	cfg, err := newConfig(environment)
 	if err != nil {
 		return fmt.Errorf("unable to load the configuration; %v", err)
 	}
 
 	switch name {
 	case "forgejo":
-		if err := downloadForgejo(cfg.Forgejo.Version); err != nil {
+		if err := downloadForgejo(environment, cfg.Forgejo.Version); err != nil {
 			return fmt.Errorf("an error occurred whilst getting the forgejo binary; %w", err)
 		}
 	case "gotosocial":
-		if err := downloadGoToSocial(cfg.GoToSocial.Version); err != nil {
+		if err := downloadGoToSocial(environment, cfg.GoToSocial.Version); err != nil {
 			return fmt.Errorf("an error occurred whilst getting the packages for GoToSocial; %w", err)
 		}
 	case "woodpecker":
-		if err := downloadWoodpecker(cfg.Woodpecker.Version); err != nil {
+		if err := downloadWoodpecker(environment, cfg.Woodpecker.Version); err != nil {
 			return fmt.Errorf("an error occurred whilst getting the packages for Woodpecker; %w", err)
 		}
 	default:
@@ -41,8 +41,8 @@ func Download(name string) error {
 }
 
 // downloadWoodpecker downloads and validates the files for the Woodpecker deployment.
-func downloadWoodpecker(version string) error {
-	destinationDir := filepath.Join(rootBuildDir, "woodpecker")
+func downloadWoodpecker(environment, version string) error {
+	destinationDir := filepath.Join(rootBuildDir, environment, "woodpecker")
 
 	binaryTarUrl := fmt.Sprintf(
 		"https://github.com/woodpecker-ci/woodpecker/releases/download/v%s/woodpecker-server_linux_amd64.tar.gz",
@@ -69,14 +69,14 @@ func downloadWoodpecker(version string) error {
 		packages: []pack{
 			{
 				file: object{
-					source: binaryTarUrl,
+					source:      binaryTarUrl,
 					destination: binaryTarFilepath,
 				},
 			},
 		},
 		validateGPGSignature: false,
 		checksum: object{
-			source: checksumUrl,
+			source:      checksumUrl,
 			destination: checksumFilePath,
 		},
 		validateChecksum: false,
@@ -90,7 +90,7 @@ func downloadWoodpecker(version string) error {
 }
 
 // downloadForgejo downloads and validates the Forgejo files.
-func downloadForgejo(version string) error {
+func downloadForgejo(environment, version string) error {
 	var (
 		forgejoBinaryFileFormat   = "forgejo-%s-linux-amd64"
 		forgejoDigestExtension    = ".sha256"
@@ -98,7 +98,7 @@ func downloadForgejo(version string) error {
 		forgejoJson               = "./magefiles/forgejo.json"
 	)
 
-	destinationDir := filepath.Join(rootBuildDir, "forgejo")
+	destinationDir := filepath.Join(rootBuildDir, environment, "forgejo")
 
 	binaryPath := filepath.Join(
 		destinationDir,
@@ -144,8 +144,8 @@ func downloadForgejo(version string) error {
 }
 
 // downloadGoToSocial downloads and validates the files for GoToSocial.
-func downloadGoToSocial(version string) error {
-	destinationDir := filepath.Join(rootBuildDir, "gotosocial")
+func downloadGoToSocial(environment, version string) error {
+	destinationDir := filepath.Join(rootBuildDir, environment, "gotosocial")
 
 	binaryTarUrl := fmt.Sprintf(
 		"https://github.com/superseriousbusiness/gotosocial/releases/download/v%s/gotosocial_%s_linux_amd64.tar.gz",

magefiles/prepare.go

@@ -16,8 +16,8 @@ import (
 )
 
 // Prepare prepares the service's build directory.
-func Prepare(service string) error {
-	cfg, err := newConfig(configFile)
+func Prepare(environment, service string) error {
+	cfg, err := newConfig(environment)
 	if err != nil {
 		return fmt.Errorf("unable to load the configuration; %v", err)
 	}
@@ -35,53 +35,53 @@ func Prepare(service string) error {
 
 			service := o.Name()
 
-			buildDir := filepath.Join(rootBuildDir, service)
+			buildDir := filepath.Join(rootBuildDir, environment, service)
 
 			if _, err := os.Stat(buildDir); err != nil {
-				if err := os.Mkdir(buildDir, 0o700); err != nil {
+				if err := os.MkdirAll(buildDir, 0o700); err != nil {
 					return fmt.Errorf("unable to make %s; %w", buildDir, err)
 				}
 			}
 
 			if service != "compose" {
 				mg.Deps(
-					mg.F(Download, service),
+					mg.F(Download, environment, service),
 				)
 
 				log.Printf("Copying assets for %s.\n", service)
-				if err := copyAssets(service); err != nil {
+				if err := copyAssets(environment, service); err != nil {
 					return fmt.Errorf("unable to copy the assets for %s; %w", service, err)
 				}
 			}
 
 			log.Printf("Rendering templates for %s.\n", service)
-			if err := render(cfg, service); err != nil {
+			if err := render(cfg, environment, service); err != nil {
 				return fmt.Errorf("unable to render templates for %s; %w", service, err)
 			}
 
 		}
 	} else {
-		buildDir := filepath.Join(rootBuildDir, service)
+		buildDir := filepath.Join(rootBuildDir, environment, service)
 
 		if _, err := os.Stat(buildDir); err != nil {
-			if err := os.Mkdir(buildDir, 0o700); err != nil {
+			if err := os.MkdirAll(buildDir, 0o700); err != nil {
 				return fmt.Errorf("unable to make %s; %w", buildDir, err)
 			}
 		}
 
 		if service != "compose" {
 			mg.Deps(
-				mg.F(Download, service),
-				mg.F(Prepare, "compose"),
+				mg.F(Download, environment, service),
+				mg.F(Prepare, environment, "compose"),
 			)
 
 			log.Printf("Copying assets for %s.\n", service)
-			if err := copyAssets(service); err != nil {
+			if err := copyAssets(environment, service); err != nil {
 				return fmt.Errorf("unable to copy the assets for %s; %w", service, err)
 			}
 		}
 
-		if err := render(cfg, service); err != nil {
+		if err := render(cfg, environment, service); err != nil {
 			return fmt.Errorf("an error occurred whilst rendering the templates; %w", err)
 		}
 
@@ -90,8 +90,8 @@ func Prepare(service string) error {
 	return nil
 }
 
-func render(cfg config, component string) error {
-	buildDirName := filepath.Join(rootBuildDir, component)
+func render(cfg config, environment, component string) error {
+	buildDirName := filepath.Join(rootBuildDir, environment, component)
 
 	templateDirName := filepath.Join(rootTemplatesDir, component)
 
@@ -147,7 +147,7 @@ func render(cfg config, component string) error {
 	return nil
 }
 
-func copyAssets(service string) error {
+func copyAssets(environment, service string) error {
 	assetsDirName := filepath.Join(rootAssetsDir, service)
 	if _, err := os.Stat(assetsDirName); err != nil {
 		if os.IsNotExist(err) {
@@ -158,7 +158,7 @@ func copyAssets(service string) error {
 		return err
 	}
 
-	buildDirName := filepath.Join(rootBuildDir, service, "assets")
+	buildDirName := filepath.Join(rootBuildDir, environment, service, "assets")
 
 	walkDirFunc := func(path string, d fs.DirEntry, err error) error {
 		if err != nil {

templates/compose/docker-compose.yaml.gotmpl

@@ -13,11 +13,11 @@ version: "3.9"
 
 networks:
   flow:
-    name: "flow"
+    name: "{{ .Docker.Network.Name }}"
     ipam:
       driver: "default"
       config:
-      - subnet: "{{ .DockerNetworkSubnet }}"
+      - subnet: "{{ .Docker.Network.Subnet }}"
 
 services:
   # -- Traffic flow --
@@ -27,7 +27,7 @@ services:
     build:
       context: "../traefik"
     networks:
-      flow:
+      {{ .Docker.Network.Name }}:
         ipv4_address: "{{ .Traefik.ContainerIpv4Address }}"
     ports:
     - target: 80
@@ -59,7 +59,7 @@ services:
     - "{{ .Forgejo.SshPort }}"
     - "{{ .Forgejo.HttpPort }}"
     networks:
-      flow:
+      {{ .Docker.Network.Name }}:
         ipv4_address: "{{ .Forgejo.ContainerIpv4Address }}"
     restart: "always"
     volumes:
@@ -79,7 +79,7 @@ services:
     expose:
     - "{{ .GoToSocial.Port }}"
     networks:
-      flow:
+      {{ .Docker.Network.Name }}:
         ipv4_address: "{{ .GoToSocial.ContainerIpv4Address }}"
     restart: "always"
     volumes:
@@ -114,7 +114,7 @@ services:
     - "{{ .Woodpecker.HttpPort }}"
     - "{{ .Woodpecker.GrpcPort }}"
     networks:
-      flow:
+      {{ .Docker.Network.Name }}:
         ipv4_address: "{{ .Woodpecker.ContainerIpv4Address }}"
     restart: "always"
     volumes:
@@ -138,7 +138,7 @@ services:
     expose:
     - "{{ .Landing.Port }}"
     networks:
-      flow:
+      {{ .Docker.Network.Name }}:
         ipv4_address: "{{ .Landing.ContainerIpv4Address }}"
     restart: "always"
     volumes:

templates/gotosocial/config.yaml.gotmpl

@@ -110,7 +110,7 @@ port: {{ .GoToSocial.Port }}
 # Example: ["127.0.0.1/32", "172.20.0.1"]
 # Default: ["127.0.0.1/32", "::1"] (localhost ipv4 + ipv6)
 trusted-proxies:
-- "{{ .DockerNetworkSubnet }}"
+- "{{ .Docker.Network.Subnet }}"
 
 ############################
 ##### DATABASE CONFIG ######