feat: add k8s preset

Author: jnsgruk

README.md

@@ -113,11 +113,12 @@ sudo concierge prepare -p dev
 | Preset Name | Included                                                         |
 | :---------: | :--------------------------------------------------------------- |
 |    `dev`    | `juju`, `microk8s`, `lxd` `snapcraft`, `charmcraft`, `rockcraft` |
+|    `k8s`    | `juju`, `k8s`, `lxd`, `rockcraft`, `charmcraft`                  |
 | `microk8s`  | `juju`, `microk8s`, `lxd`, `rockcraft`, `charmcraft`             |
 |  `machine`  | `juju`, `lxd`, `snapcraft`, `charmcraft`                         |
 
-Note that in the `microk8s` preset, while `lxd` is installed, it is not bootstrapped. It is installed
-and initialised with enough config such that `charmcraft` can use it as a build backend.
+Note that in the `microk8s`/`k8s` presets, while `lxd` is installed, it is not bootstrapped. It is
+installed and initialised with enough config such that `charmcraft` can use it as a build backend.
 
 ### Config File
 

internal/config/config.go

@@ -106,6 +106,7 @@ func parseConfig(configFile string) (*Config, error) {
 func getOverrides(flags *pflag.FlagSet) ConfigOverrides {
 	return ConfigOverrides{
 		JujuChannel:       envOrFlagString(flags, "juju-channel"),
+		K8sChannel:        envOrFlagString(flags, "k8s-channel"),
 		MicroK8sChannel:   envOrFlagString(flags, "microk8s-channel"),
 		LXDChannel:        envOrFlagString(flags, "lxd-channel"),
 		CharmcraftChannel: envOrFlagString(flags, "charmcraft-channel"),

internal/config/config_format.go

@@ -22,7 +22,7 @@ type jujuConfig struct {
 
 // providerConfig represents the set of providers to be configured and bootstrapped.
 type providerConfig struct {
-	K8s      K8sConfig      `mapstructure:"k8s"`
+	K8s      k8sConfig      `mapstructure:"k8s"`
 	LXD      lxdConfig      `mapstructure:"lxd"`
 	Google   googleConfig   `mapstructure:"google"`
 	MicroK8s microk8sConfig `mapstructure:"microk8s"`
@@ -50,8 +50,8 @@ type microk8sConfig struct {
 	Addons    []string `mapstructure:"addons"`
 }
 
-// K8sConfig represents how MicroK8s should be configured on the host.
-type K8sConfig struct {
+// k8sConfig represents how MicroK8s should be configured on the host.
+type k8sConfig struct {
 	Enable    bool                         `mapstructure:"enable"`
 	Bootstrap bool                         `mapstructure:"bootstrap"`
 	Channel   string                       `mapstructure:"channel"`

internal/config/presets.go

@@ -5,6 +5,8 @@ import "fmt"
 // Preset returns a configuration preset by name.
 func Preset(preset string) (*Config, error) {
 	switch preset {
+	case "k8s":
+		return k8sPreset, nil
 	case "microk8s":
 		return microk8sPreset, nil
 	case "machine":
@@ -55,6 +57,19 @@ var defaultMicroK8sConfig microk8sConfig = microk8sConfig{
 	},
 }
 
+// defaultK8sConfig is the standard K8s config used throughout presets.
+var defaultK8sConfig k8sConfig = k8sConfig{
+	Enable:    true,
+	Bootstrap: true,
+	Features: map[string]map[string]string{
+		"load-balancer": {
+			"l2-mode": "true",
+			"cidrs":   "10.43.45.0/28",
+		},
+		"local-storage": {},
+	},
+}
+
 // machinePreset is a configuration preset designed to be used when testing
 // machine charms.
 var machinePreset *Config = &Config{
@@ -68,6 +83,21 @@ var machinePreset *Config = &Config{
 	},
 }
 
+// k8sPreset is a configuration preset designed to be used when testing
+// k8s charms.
+var k8sPreset *Config = &Config{
+	Juju: defaultJujuConfig,
+	Providers: providerConfig{
+		// Enable LXD so charms can be built, but don't bootstrap onto it.
+		LXD: lxdConfig{Enable: true},
+		K8s: defaultK8sConfig,
+	},
+	Host: hostConfig{
+		Packages: defaultPackages,
+		Snaps:    append(defaultSnaps, "rockcraft/latest/stable"),
+	},
+}
+
 // microk8sPreset is a configuration preset designed to be used when testing
 // k8s charms.
 var microk8sPreset *Config = &Config{

internal/providers/k8s.go

@@ -11,14 +11,19 @@ import (
 	"github.com/jnsgruk/concierge/internal/runner"
 )
 
+// Default channel from which K8s is installed.
+const defaultK8sChannel = "1.31/candidate"
+
 // NewK8s constructs a new K8s provider instance.
 func NewK8s(runner runner.CommandRunner, config *config.Config) *K8s {
 	var channel string
 
 	if config.Overrides.K8sChannel != "" {
 		channel = config.Overrides.K8sChannel
-	} else {
+	} else if config.Providers.K8s.Channel != "" {
 		channel = config.Providers.K8s.Channel
+	} else {
+		channel = defaultK8sChannel
 	}
 
 	return &K8s{

internal/providers/k8s_test.go

@@ -28,7 +28,7 @@ func TestNewK8s(t *testing.T) {
 	noOverrides := &config.Config{}
 
 	channelInConfig := &config.Config{}
-	channelInConfig.Providers.K8s.Channel = "1.31/candidate"
+	channelInConfig.Providers.K8s.Channel = "1.32/candidate"
 
 	overrides := &config.Config{}
 	overrides.Overrides.K8sChannel = "1.32/edge"
@@ -39,11 +39,11 @@ func TestNewK8s(t *testing.T) {
 	tests := []test{
 		{
 			config:   noOverrides,
-			expected: &K8s{Channel: "", runner: runner},
+			expected: &K8s{Channel: "1.31/candidate", runner: runner},
 		},
 		{
 			config:   channelInConfig,
-			expected: &K8s{Channel: "1.31/candidate", runner: runner},
+			expected: &K8s{Channel: "1.32/candidate", runner: runner},
 		},
 		{
 			config:   overrides,

internal/providers/microk8s.go

@@ -18,7 +18,7 @@ import (
 
 // Default channel from which MicroK8s is installed when the latest strict
 // version cannot be determined.
-const defaultChannel = "1.31-strict/stable"
+const defaultMicroK8sChannel = "1.31-strict/stable"
 
 // NewMicroK8s constructs a new MicroK8s provider instance.
 func NewMicroK8s(runner runner.CommandRunner, config *config.Config) *MicroK8s {
@@ -201,12 +201,12 @@ func (m *MicroK8s) setupKubectl() error {
 func computeDefaultChannel() string {
 	// If the snapd socket doesn't exist on the system, return a default value
 	if _, err := os.Stat("/run/snapd.socket"); errors.Is(err, os.ErrNotExist) {
-		return defaultChannel
+		return defaultMicroK8sChannel
 	}
 
 	snap, _, err := snapdClient.New(nil).FindOne("microk8s")
 	if err != nil {
-		return defaultChannel
+		return defaultMicroK8sChannel
 	}
 
 	keys := []string{}

tests/preset-k8s/task.yaml

@@ -0,0 +1,40 @@
+summary: Run concierge with the k8s preset
+systems:
+  - ubuntu-24.04
+
+execute: |
+  pushd "${SPREAD_PATH}/${SPREAD_TASK}"
+
+  "$SPREAD_PATH"/concierge --trace prepare -p k8s
+
+  # Check that relevant snaps are installed
+  for s in juju k8s kubectl jq yq charmcraft rockcraft; do
+    snap list "$s" | MATCH $s
+  done
+
+  # Check the relevant debs are installed
+  command -v pip | MATCH /usr/bin/pip
+  python3 -m venv -h | head -n1 | grep -q -e "usage: venv"
+
+  sudo k8s status --output-format yaml | yq '.dns.enabled' | MATCH true
+  sudo k8s status --output-format yaml | yq '.load-balancer.enabled' | MATCH true
+  sudo k8s status --output-format yaml | yq '.load-balancer.message' | MATCH "enabled, L2 mode"
+  sudo k8s get | yq '.load-balancer.cidrs' | MATCH "10.43.45.0/28"
+
+  kubectl config current-context | MATCH "k8s"
+
+  juju controllers | tail -n1 | MATCH concierge-k8s
+  juju models | tail -n1 | MATCH testing
+
+  # Ensure the juju controller is bootstrapped and has models
+  juju switch concierge-k8s:admin/testing
+  juju model-defaults | grep test-mode | tr -s " " | MATCH "test-mode false true"
+  juju model-defaults | grep automatically-retry-hooks | tr -s " " | MATCH "automatically-retry-hooks true false"
+
+  # Check that even though we installed/initialised LXD, we didn't bootstrap it
+  juju controllers | NOMATCH lxd-concierge
+
+restore: |
+  if [[ -z "${CI:-}" ]]; then
+    "$SPREAD_PATH"/concierge --trace restore
+  fi