bootstrap_gcp.go

// Copyright (c) Codesphere Inc.
// SPDX-License-Identifier: Apache-2.0

package cmd

import (
	"encoding/json"
	"fmt"
	"log"
	"os"

	"github.com/spf13/cobra"

	"github.com/codesphere-cloud/cs-go/pkg/io"
	"github.com/codesphere-cloud/oms/internal/bootstrap"
	"github.com/codesphere-cloud/oms/internal/bootstrap/gcp"
	"github.com/codesphere-cloud/oms/internal/env"
	"github.com/codesphere-cloud/oms/internal/installer"
	"github.com/codesphere-cloud/oms/internal/installer/node"
	"github.com/codesphere-cloud/oms/internal/portal"
	"github.com/codesphere-cloud/oms/internal/util"
)

type BootstrapGcpCmd struct {
	cmd               *cobra.Command
	Opts              *GlobalOptions
	Env               env.Env
	CodesphereEnv     *gcp.CodesphereEnvironment
	InputRegistryType string
	SSHQuiet          bool
}

func (c *BootstrapGcpCmd) RunE(_ *cobra.Command, args []string) error {
	err := c.BootstrapGcp()
	if err != nil {
		return fmt.Errorf("failed to bootstrap: %w", err)
	}

	return nil
}

func AddBootstrapGcpCmd(parent *cobra.Command, opts *GlobalOptions) {
	bootstrapGcpCmd := BootstrapGcpCmd{
		cmd: &cobra.Command{
			Use:   "bootstrap-gcp",
			Short: "Bootstrap GCP infrastructure for Codesphere",
			Long: io.Long(`Bootstraps GCP infrastructure required to run Codesphere clusters on GCP.
				This includes setting up projects, service accounts, and necessary IAM roles.
				Depending on your setup, additional configuration may be required after bootstrapping.
				Ensure you have the necessary permissions to create and manage GCP resources before proceeding.
				Not for production use.`),
		},
		Opts:          opts,
		Env:           env.NewEnv(),
		CodesphereEnv: &gcp.CodesphereEnvironment{},
	}
	bootstrapGcpCmd.cmd.RunE = bootstrapGcpCmd.RunE

	flags := bootstrapGcpCmd.cmd.Flags()
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.ProjectName, "project-name", "", "Unique GCP Project Name (required)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.BillingAccount, "billing-account", "", "GCP Billing Account ID (required)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.BaseDomain, "base-domain", "", "Base domain for Codesphere (required)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.GithubAppClientID, "github-app-client-id", "", "Github App Client ID (required)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.GithubAppClientSecret, "github-app-client-secret", "", "Github App Client Secret (required)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.SecretsDir, "secrets-dir", "/etc/codesphere/secrets", "Directory for secrets (default: /etc/codesphere/secrets)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.FolderID, "folder-id", "", "GCP Folder ID (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.SSHPublicKeyPath, "ssh-public-key-path", "~/.ssh/id_rsa.pub", "SSH Public Key Path (default: ~/.ssh/id_rsa.pub)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.SSHPrivateKeyPath, "ssh-private-key-path", "~/.ssh/id_rsa", "SSH Private Key Path (default: ~/.ssh/id_rsa)")
	flags.BoolVar(&bootstrapGcpCmd.CodesphereEnv.Preemptible, "preemptible", false, "Use preemptible VMs for Codesphere infrastructure (default: false)")
	flags.IntVar(&bootstrapGcpCmd.CodesphereEnv.DatacenterID, "datacenter-id", 1, "Datacenter ID (default: 1)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.CustomPgIP, "custom-pg-ip", "", "Custom PostgreSQL IP (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.InstallConfigPath, "install-config", "config.yaml", "Path to install config file (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.SecretsFilePath, "secrets-file", "prod.vault.yaml", "Path to secrets files (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.Region, "region", "europe-west4", "GCP Region (default: europe-west4)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.Zone, "zone", "europe-west4-a", "GCP Zone (default: europe-west4-a)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.DNSProjectID, "dns-project-id", "", "GCP Project ID for Cloud DNS (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.DNSProjectServiceAccount, "dns-project-sa", "", "GCP Project Service Account for Cloud DNS (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.DNSZoneName, "dns-zone-name", "oms-testing", "Cloud DNS Zone Name (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.InstallVersion, "install-version", "", "Codesphere version to install (default: none)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.InstallHash, "install-hash", "", "Codesphere package hash to install (default: none)")
	flags.StringArrayVarP(&bootstrapGcpCmd.CodesphereEnv.InstallSkipSteps, "install-skip-steps", "s", []string{}, "Installation steps to skip during Codesphere installation (optional)")

	flags.StringVar(&bootstrapGcpCmd.InputRegistryType, "registry-type", "local-container", "Container registry type to use (options: local-container, artifact-registry) (default: artifact-registry)")
	flags.BoolVar(&bootstrapGcpCmd.CodesphereEnv.WriteConfig, "write-config", true, "Write generated install config to file (default: true)")
	flags.BoolVar(&bootstrapGcpCmd.SSHQuiet, "ssh-quiet", true, "Suppress SSH command output (default: true)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.GitHubPAT, "github-pat", "", "GitHub Personal Access Token to use for direct image access. Scope required: package read (optional)")
	flags.StringVar(&bootstrapGcpCmd.CodesphereEnv.RegistryUser, "registry-user", "", "Custom Registry username (only for GitHub registry type) (optional)")
	flags.StringArrayVar(&bootstrapGcpCmd.CodesphereEnv.Experiments, "experiments", gcp.DefaultExperiments, "Experiments to enable in Codesphere installation (optional)")
	flags.StringArrayVar(&bootstrapGcpCmd.CodesphereEnv.FeatureFlags, "feature-flags", []string{}, "Feature flags to enable in Codesphere installation (optional)")

	util.MarkFlagRequired(bootstrapGcpCmd.cmd, "project-name")
	util.MarkFlagRequired(bootstrapGcpCmd.cmd, "billing-account")
	util.MarkFlagRequired(bootstrapGcpCmd.cmd, "base-domain")

	parent.AddCommand(bootstrapGcpCmd.cmd)
	AddBootstrapGcpPostconfigCmd(bootstrapGcpCmd.cmd, opts)
	AddBootstrapGcpCleanupCmd(bootstrapGcpCmd.cmd, opts)
}

func (c *BootstrapGcpCmd) BootstrapGcp() error {
	ctx := c.cmd.Context()
	stlog := bootstrap.NewStepLogger(false)
	icg := installer.NewInstallConfigManager()
	gcpClient := gcp.NewGCPClient(ctx, stlog, os.Getenv("GOOGLE_APPLICATION_CREDENTIALS"))
	fw := util.NewFilesystemWriter()
	portalClient := portal.NewPortalClient()

	bs, err := gcp.NewGCPBootstrapper(ctx, c.Env, stlog, c.CodesphereEnv, icg, gcpClient, fw, node.NewSSHNodeClient(c.SSHQuiet), portalClient)
	if err != nil {
		return err
	}

	c.CodesphereEnv.RegistryType = gcp.RegistryType(c.InputRegistryType)
	if c.CodesphereEnv.GitHubPAT != "" {
		c.CodesphereEnv.RegistryType = gcp.RegistryTypeGitHub
		if c.CodesphereEnv.RegistryUser == "" {
			return fmt.Errorf("registry-user must be set when using GitHub registry type")
		}
	}

	err = bs.Bootstrap()
	envBytes, err2 := json.MarshalIndent(bs.Env, "", "  ")

	envString := string(envBytes)
	if err2 != nil {
		envString = ""
	}

	if err != nil {
		if bs.Env.Jumpbox != nil && bs.Env.Jumpbox.GetExternalIP() != "" {
			log.Printf("To debug on the jumpbox host:\nssh-add $SSH_KEY_PATH; ssh -o StrictHostKeyChecking=no -o ForwardAgent=yes -o SendEnv=OMS_PORTAL_API_KEY root@%s", bs.Env.Jumpbox.GetExternalIP())
		}
		return fmt.Errorf("failed to bootstrap GCP: %w, env: %s", err, envString)
	}

	workdir := env.NewEnv().GetOmsWorkdir()
	err = fw.MkdirAll(workdir, 0755)
	if err != nil {
		return fmt.Errorf("failed to create workdir: %w", err)
	}
	infraFilePath := gcp.GetInfraFilePath()
	err = fw.WriteFile(infraFilePath, envBytes, 0644)
	if err != nil {
		return fmt.Errorf("failed to write gcp bootstrap env file: %w", err)
	}

	log.Println("\n🎉🎉🎉 GCP infrastructure bootstrapped successfully!")
	log.Println(envString)
	log.Printf("Infrastructure details written to %s", infraFilePath)
	log.Printf("Access the jumpbox using:\nssh-add $SSH_KEY_PATH; ssh -o StrictHostKeyChecking=no -o ForwardAgent=yes -o SendEnv=OMS_PORTAL_API_KEY root@%s", bs.Env.Jumpbox.GetExternalIP())
	if bs.Env.InstallVersion != "" {
		log.Printf("Access Codesphere in your web browser at https://cs.%s", bs.Env.BaseDomain)
		return nil
	}
	packageName := "<package-name>-installer"
	installCmd := "oms-cli install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt"
	if gcp.RegistryType(bs.Env.RegistryType) == gcp.RegistryTypeGitHub {
		log.Printf("You set a GitHub PAT for direct image access. Make sure to use a lite package, as VM root disk sizes are reduced.")
		installCmd += " -s load-container-images"
		packageName += "-lite"
	}
	log.Printf("example install command (run from jumpbox):\n%s -p %s.tar.gz", installCmd, packageName)

	return nil
}