feat: Support caching provisioner assets

kylecarbs · kylecarbs · commit 87cd77cf5b0a · 2022-03-26T05:07:07.000Z
This caches the Terraform binary, and Terraform plugins.
Eventually, it could cache other temporary files.
diff --git a/cli/start.go b/cli/start.go
@@ -13,6 +13,7 @@ import (
 	"net/url"
 	"os"
 	"os/signal"
+	"path/filepath"
 	"strconv"
 	"time"
 
@@ -42,6 +43,7 @@ func start() *cobra.Command {
 	var (
 		accessURL              string
 		address                string
+		cacheDir               string
 		dev                    bool
 		postgresURL            string
 		provisionerDaemonCount uint8
@@ -164,7 +166,7 @@ func start() *cobra.Command {
 
 			provisionerDaemons := make([]*provisionerd.Server, 0)
 			for i := uint8(0); i < provisionerDaemonCount; i++ {
-				daemonClose, err := newProvisionerDaemon(cmd.Context(), client, logger)
+				daemonClose, err := newProvisionerDaemon(cmd.Context(), client, logger, cacheDir)
 				if err != nil {
 					return xerrors.Errorf("create provisioner daemon: %w", err)
 				}
@@ -312,6 +314,12 @@ func start() *cobra.Command {
 	}
 	root.Flags().StringVarP(&accessURL, "access-url", "", os.Getenv("CODER_ACCESS_URL"), "Specifies the external URL to access Coder (uses $CODER_ACCESS_URL).")
 	root.Flags().StringVarP(&address, "address", "a", defaultAddress, "The address to serve the API and dashboard (uses $CODER_ADDRESS).")
+	// systemd uses the CACHE_DIRECTORY environment variable!
+	defaultCacheDir := os.Getenv("CACHE_DIRECTORY")
+	if defaultCacheDir == "" {
+		defaultCacheDir = filepath.Join(os.TempDir(), ".coder-cache")
+	}
+	root.Flags().StringVarP(&cacheDir, "cache-dir", "", defaultCacheDir, "Specify a directory to cache binaries for provision operations.")
 	defaultDev, _ := strconv.ParseBool(os.Getenv("CODER_DEV_MODE"))
 	root.Flags().BoolVarP(&dev, "dev", "", defaultDev, "Serve Coder in dev mode for tinkering (uses $CODER_DEV_MODE).")
 	root.Flags().StringVarP(&postgresURL, "postgres-url", "", "",
@@ -381,14 +389,15 @@ func createFirstUser(cmd *cobra.Command, client *codersdk.Client, cfg config.Roo
 	return nil
 }
 
-func newProvisionerDaemon(ctx context.Context, client *codersdk.Client, logger slog.Logger) (*provisionerd.Server, error) {
+func newProvisionerDaemon(ctx context.Context, client *codersdk.Client, logger slog.Logger, cacheDir string) (*provisionerd.Server, error) {
 	terraformClient, terraformServer := provisionersdk.TransportPipe()
 	go func() {
 		err := terraform.Serve(ctx, &terraform.ServeOptions{
 			ServeOptions: &provisionersdk.ServeOptions{
 				Listener: terraformServer,
 			},
-			Logger: logger,
+			CachePath: cacheDir,
+			Logger:    logger,
 		})
 		if err != nil {
 			panic(err)
diff --git a/coder.service b/coder.service
@@ -16,6 +16,7 @@ PrivateTmp=yes
 PrivateDevices=yes
 SecureBits=keep-caps
 AmbientCapabilities=CAP_IPC_LOCK
+CacheDirectory=coder
 CapabilityBoundingSet=CAP_SYSLOG CAP_IPC_LOCK CAP_NET_BIND_SERVICE
 NoNewPrivileges=yes
 ExecStart=/usr/bin/coder start
diff --git a/provisioner/terraform/provision.go b/provisioner/terraform/provision.go
@@ -87,6 +87,14 @@ func (t *terraform) Provision(stream proto.DRPCProvisioner_ProvisionStream) erro
 			})
 		}
 	}()
+	if t.cachePath != "" {
+		err = terraform.SetEnv(map[string]string{
+			"TF_PLUGIN_CACHE_DIR": t.cachePath,
+		})
+		if err != nil {
+			return xerrors.Errorf("set terraform plugin cache dir: %w", err)
+		}
+	}
 	terraform.SetStdout(writer)
 	t.logger.Debug(shutdown, "running initialization")
 	err = terraform.Init(shutdown)
diff --git a/provisioner/terraform/serve.go b/provisioner/terraform/serve.go
@@ -34,6 +34,7 @@ type ServeOptions struct {
 	// BinaryPath specifies the "terraform" binary to use.
 	// If omitted, the $PATH will attempt to find it.
 	BinaryPath string
+	CachePath  string
 	Logger     slog.Logger
 }
 
@@ -43,8 +44,9 @@ func Serve(ctx context.Context, options *ServeOptions) error {
 		binaryPath, err := exec.LookPath("terraform")
 		if err != nil {
 			installer := &releases.ExactVersion{
-				Product: product.Terraform,
-				Version: version.Must(version.NewVersion("1.1.7")),
+				InstallDir: options.CachePath,
+				Product:    product.Terraform,
+				Version:    version.Must(version.NewVersion("1.1.7")),
 			}
 
 			execPath, err := installer.Install(ctx)
@@ -58,11 +60,13 @@ func Serve(ctx context.Context, options *ServeOptions) error {
 	}
 	return provisionersdk.Serve(ctx, &terraform{
 		binaryPath: options.BinaryPath,
+		cachePath:  options.CachePath,
 		logger:     options.Logger,
 	}, options.ServeOptions)
 }
 
 type terraform struct {
 	binaryPath string
+	cachePath  string
 	logger     slog.Logger
 }

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,7 @@ type ServeOptions struct {`
`34`	`34`	`// BinaryPath specifies the "terraform" binary to use.`
`35`	`35`	`// If omitted, the $PATH will attempt to find it.`
`36`	`36`	`BinaryPath string`
	`37`	`+ CachePath string`
`37`	`38`	`Logger slog.Logger`
`38`	`39`	`}`
`39`	`40`
`@@ -43,8 +44,9 @@ func Serve(ctx context.Context, options *ServeOptions) error {`
`43`	`44`	`binaryPath, err := exec.LookPath("terraform")`
`44`	`45`	`if err != nil {`
`45`	`46`	`installer := &releases.ExactVersion{`
`46`		`- Product: product.Terraform,`
`47`		`- Version: version.Must(version.NewVersion("1.1.7")),`
	`47`	`+ InstallDir: options.CachePath,`
	`48`	`+ Product: product.Terraform,`
	`49`	`+ Version: version.Must(version.NewVersion("1.1.7")),`
`48`	`50`	`}`
`49`	`51`
`50`	`52`	`execPath, err := installer.Install(ctx)`
`@@ -58,11 +60,13 @@ func Serve(ctx context.Context, options *ServeOptions) error {`
`58`	`60`	`}`
`59`	`61`	`return provisionersdk.Serve(ctx, &terraform{`
`60`	`62`	`binaryPath: options.BinaryPath,`
	`63`	`+ cachePath: options.CachePath,`
`61`	`64`	`logger: options.Logger,`
`62`	`65`	`}, options.ServeOptions)`
`63`	`66`	`}`
`64`	`67`
`65`	`68`	`type terraform struct {`
`66`	`69`	`binaryPath string`
	`70`	`+ cachePath string`
`67`	`71`	`logger slog.Logger`
`68`	`72`	`}`