feat(local) : adding a command to generate sample config file targetting cloud-provider=local

Signed-off-by: Archisman <archisman@obmondo.com>

Author: Archisman-Mridha

cmd/config/generate/generate.go

@@ -29,4 +29,5 @@ func init() {
 	// Subcommands.
 	GenerateCmd.AddCommand(AWSCmd)
 	GenerateCmd.AddCommand(HetznerCmd)
+	GenerateCmd.AddCommand(LocalCmd)
 }

cmd/config/generate/hetzner.go

@@ -11,7 +11,7 @@ import (
 var HetznerCmd = &cobra.Command{
 	Use: "hetzner",
 
-	Short: "Generate a sample KubeAid Bootstrap Script config file, for deploying an Hetzner based cluster",
+	Short: "Generate a sample KubeAid Bootstrap Script config file, for deploying a Hetzner based cluster",
 
 	Run: func(cmd *cobra.Command, args []string) {
 		config.GenerateSampleConfig(context.Background(), constants.CloudProviderHetzner)

cmd/config/generate/local.go

@@ -0,0 +1,19 @@
+package generate
+
+import (
+	"context"
+
+	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/config"
+	"github.com/Obmondo/kubeaid-bootstrap-script/pkg/constants"
+	"github.com/spf13/cobra"
+)
+
+var LocalCmd = &cobra.Command{
+	Use: "local",
+
+	Short: "Generate a sample KubeAid Bootstrap Script config file, for deploying a local K3D based cluster (for testing purposes)",
+
+	Run: func(cmd *cobra.Command, args []string) {
+		config.GenerateSampleConfig(context.Background(), constants.CloudProviderLocal)
+	},
+}

pkg/config/files/templates/local.sample.config.yaml.tmpl

@@ -0,0 +1,37 @@
+# Git credentials used to authenticate against the Git platform you're using (Github / Gitlab etc.).
+# KubeAid Bootstrap Script will use these credentials to :
+#
+#   (1) Clone the KubeAid and KubeAid config repositories.
+#   (2) Create and push commits to a branch in the KubeAid config repository.
+#
+# So, make sure the Git password (token) you're using has necessary permissions associated to do
+# the above.
+#
+# NOTE : Currently, we only support HTTPS authentication.
+git:
+  username: xxxxxxxxxx
+  password: xxxxxxxxxx
+
+forks:
+  # KubeAid repository URL (in HTTPs syntax).
+  # Defaults to Obmondo's KubeAid repository.
+  # kubeaid: https://github.com/Obmondo/KubeAid
+
+  # Your KubeAid config repository URL (in HTTPs syntax).
+  kubeaidConfig: https://github.com/xxxxxxxxxx/kubeaid-config
+
+# Kubernetes cluster and control-plane specific configurations.
+cluster:
+
+  # Kubernetes cluster name.
+  name: kubeaid-demo-local
+
+  # Kubernetes version to use.
+  # NOTE : Make sure that the AMI you're using, is targetted towards this Kubernetes version.
+  k8sVersion: v1.31.0
+
+  # Kubeaid version to use.
+  kubeaidVersion: 10.0.0
+
+cloud:
+  local: {}

pkg/config/generate_sample_config.go

@@ -26,16 +26,25 @@ func GenerateSampleConfig(ctx context.Context, cloudProvider string) {
 	case constants.CloudProviderHetzner:
 		templateName = constants.TemplateNameHetznerSampleConfig
 
+	case constants.CloudProviderLocal:
+		templateName = constants.TemplateNameLocalSampleConfig
+
 	default:
 		panic("unreachable")
 	}
 
 	content := templates.ParseAndExecuteTemplate(ctx, &SampleConfigs, templateName, nil)
 
 	destinationFile, err := os.OpenFile(constants.OutputPathGeneratedConfig, os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0644)
-	assert.AssertErrNil(ctx, err, "Failed opening file", slog.String("path", constants.OutputPathGeneratedConfig))
+	assert.AssertErrNil(ctx, err,
+		"Failed opening file",
+		slog.String("path", constants.OutputPathGeneratedConfig),
+	)
 	defer destinationFile.Close()
 
 	_, err = destinationFile.Write(content)
-	assert.AssertErrNil(ctx, err, "Failed writing sample config to file", slog.String("path", constants.OutputPathGeneratedConfig))
+	assert.AssertErrNil(ctx, err,
+		"Failed writing sample config to file",
+		slog.String("path", constants.OutputPathGeneratedConfig),
+	)
 }

pkg/constants/constants.go

@@ -91,6 +91,7 @@ const (
 var (
 	TemplateNameAWSSampleConfig     = "files/templates/aws.sample.config.yaml.tmpl"
 	TemplateNameHetznerSampleConfig = "files/templates/hetzner.sample.config.yaml.tmpl"
+	TemplateNameLocalSampleConfig   = "files/templates/local.sample.config.yaml.tmpl"
 
 	CommonNonSecretTemplateNames = []string{
 		// For ArgoCD.