@localctl/cli 0.2.0 → 0.4.0

package/src/lib/addons/postgres/addon.yaml

@@ -1,39 +1,39 @@
-# Postgres addon - deploys the real Bitnami PostgreSQL chart, configured for local dev.
-# See docs/adding-tools.md for the full addon.yaml reference.
-
-chart:
-  repo: https://charts.bitnami.com/bitnami
-  name: postgresql
-  version: "18.12.2"
-
-# Generates a random value once per key, stored as a real k8s Secret named "<release>-secret" -
-# never written to disk, never in this file. {{secretName}} below refers to that Secret's name.
-secrets:
-  password:
-    length: 20
-
-# Plain env vars injected into the app's own container automatically.
-env:
-  POSTGRES_HOST: "{{serviceHost}}"
-  POSTGRES_PORT: "5432"
-  POSTGRES_DB: "{{database}}"
-  POSTGRES_USER: "localdev"
-
-# Unlike `env`, these become a real secretKeyRef - the password itself never passes through a
-# plaintext value anywhere in this pipeline.
-envFromSecret:
-  POSTGRES_PASSWORD:
-    secret: "{{secretName}}"
-    key: password
-
-# Passed to `helm template` as -f values.yaml. {{...}} is substituted first: {{database}}/
-# {{storage}}/{{version}} come from the app's own .local/config.json dependency entry (with
-# fallback defaults), {{secretName}} from the generated Secret above.
-values: |
-  auth:
-    username: localdev
-    database: "{{database}}"
-    existingSecret: "{{secretName}}"
-  primary:
-    persistence:
-      size: "{{storage}}"
+# Postgres addon - deploys the real Bitnami PostgreSQL chart, configured for local dev.
+# See docs/adding-tools.md for the full addon.yaml reference.
+
+chart:
+  repo: https://charts.bitnami.com/bitnami
+  name: postgresql
+  version: "18.12.2"
+
+# Generates a random value once per key, stored as a real k8s Secret named "<release>-secret" -
+# never written to disk, never in this file. {{secretName}} below refers to that Secret's name.
+secrets:
+  password:
+    length: 20
+
+# Plain env vars injected into the app's own container automatically.
+env:
+  POSTGRES_HOST: "{{serviceHost}}"
+  POSTGRES_PORT: "5432"
+  POSTGRES_DB: "{{database}}"
+  POSTGRES_USER: "localdev"
+
+# Unlike `env`, these become a real secretKeyRef - the password itself never passes through a
+# plaintext value anywhere in this pipeline.
+envFromSecret:
+  POSTGRES_PASSWORD:
+    secret: "{{secretName}}"
+    key: password
+
+# Passed to `helm template` as -f values.yaml. {{...}} is substituted first: {{database}}/
+# {{storage}}/{{version}} come from the app's own .local/config.json dependency entry (with
+# fallback defaults), {{secretName}} from the generated Secret above.
+values: |
+  auth:
+    username: localdev
+    database: "{{database}}"
+    existingSecret: "{{secretName}}"
+  primary:
+    persistence:
+      size: "{{storage}}"

package/src/lib/addons/redis/addon.yaml

@@ -1,29 +1,29 @@
-# Redis addon - deploys the real Bitnami Redis chart, configured for local dev (standalone, no
-# replicas). See docs/adding-tools.md for the full addon.yaml reference.
-
-chart:
-  repo: https://charts.bitnami.com/bitnami
-  name: redis
-  version: "28.2.4"
-
-secrets:
-  password:
-    length: 20
-
-env:
-  REDIS_HOST: "{{serviceHost}}"
-  REDIS_PORT: "6379"
-
-envFromSecret:
-  REDIS_PASSWORD:
-    secret: "{{secretName}}"
-    key: password
-
-values: |
-  architecture: standalone
-  auth:
-    existingSecret: "{{secretName}}"
-    existingSecretPasswordKey: password
-  master:
-    persistence:
-      size: "{{storage}}"
+# Redis addon - deploys the real Bitnami Redis chart, configured for local dev (standalone, no
+# replicas). See docs/adding-tools.md for the full addon.yaml reference.
+
+chart:
+  repo: https://charts.bitnami.com/bitnami
+  name: redis
+  version: "28.2.4"
+
+secrets:
+  password:
+    length: 20
+
+env:
+  REDIS_HOST: "{{serviceHost}}"
+  REDIS_PORT: "6379"
+
+envFromSecret:
+  REDIS_PASSWORD:
+    secret: "{{secretName}}"
+    key: password
+
+values: |
+  architecture: standalone
+  auth:
+    existingSecret: "{{secretName}}"
+    existingSecretPasswordKey: password
+  master:
+    persistence:
+      size: "{{storage}}"

package/src/lib/appSecrets.js

@@ -1,60 +1,60 @@
-const { run, capture } = require('./exec');
-
-// One Secret per app, holding whatever keys `.local/config.json`'s "secrets" array declares.
-// Unlike addon-generated secrets (random values, never seen by you), these are values *you*
-// supply - an API key, a third-party token - so there's no "generate once" step: you set them
-// with `localctl app secrets set`, and manifestGen.js just references them via secretKeyRef.
-function secretNameFor(cfg) {
-  return `${cfg.name}-secrets`;
-}
-
-function ensureNamespace(namespace) {
-  if (capture('kubectl', ['get', 'namespace', namespace]).status !== 0) {
-    run('kubectl', ['create', 'namespace', namespace], { stdio: 'ignore', allowFail: true });
-  }
-}
-
-function readAll(cfg) {
-  const res = capture('kubectl', ['get', 'secret', secretNameFor(cfg), '-n', cfg.namespace, '-o', 'json']);
-  if (res.status !== 0) return {};
-  const data = JSON.parse(res.stdout).data || {};
-  return Object.fromEntries(Object.entries(data).map(([k, v]) => [k, Buffer.from(v, 'base64').toString('utf8')]));
-}
-
-// Rewrites the whole Secret from a plain key->value map. `apply` (not `create`) makes this
-// idempotent - a re-run with the same data is a no-op, a changed one updates in place.
-function writeAll(cfg, data) {
-  ensureNamespace(cfg.namespace);
-  const doc = {
-    apiVersion: 'v1',
-    kind: 'Secret',
-    metadata: { name: secretNameFor(cfg), namespace: cfg.namespace },
-    type: 'Opaque',
-    stringData: data,
-  };
-  run('kubectl', ['apply', '-f', '-'], { stdio: ['pipe', 'inherit', 'inherit'], input: JSON.stringify(doc) });
-}
-
-function setSecret(cfg, key, value) {
-  const data = readAll(cfg);
-  data[key] = value;
-  writeAll(cfg, data);
-}
-
-function unsetSecret(cfg, key) {
-  const data = readAll(cfg);
-  if (!(key in data)) return false;
-  delete data[key];
-  if (Object.keys(data).length === 0) {
-    run('kubectl', ['delete', 'secret', secretNameFor(cfg), '-n', cfg.namespace, '--ignore-not-found=true'], { stdio: 'ignore' });
-  } else {
-    writeAll(cfg, data);
-  }
-  return true;
-}
-
-function listKeys(cfg) {
-  return Object.keys(readAll(cfg));
-}
-
-module.exports = { secretNameFor, setSecret, unsetSecret, listKeys, readAll };
+const { run, capture } = require('./exec');
+
+// One Secret per app, holding whatever keys `.local/config.json`'s "secrets" array declares.
+// Unlike addon-generated secrets (random values, never seen by you), these are values *you*
+// supply - an API key, a third-party token - so there's no "generate once" step: you set them
+// with `localctl app secrets set`, and manifestGen.js just references them via secretKeyRef.
+function secretNameFor(cfg) {
+  return `${cfg.name}-secrets`;
+}
+
+function ensureNamespace(namespace) {
+  if (capture('kubectl', ['get', 'namespace', namespace]).status !== 0) {
+    run('kubectl', ['create', 'namespace', namespace], { stdio: 'ignore', allowFail: true });
+  }
+}
+
+function readAll(cfg) {
+  const res = capture('kubectl', ['get', 'secret', secretNameFor(cfg), '-n', cfg.namespace, '-o', 'json']);
+  if (res.status !== 0) return {};
+  const data = JSON.parse(res.stdout).data || {};
+  return Object.fromEntries(Object.entries(data).map(([k, v]) => [k, Buffer.from(v, 'base64').toString('utf8')]));
+}
+
+// Rewrites the whole Secret from a plain key->value map. `apply` (not `create`) makes this
+// idempotent - a re-run with the same data is a no-op, a changed one updates in place.
+function writeAll(cfg, data) {
+  ensureNamespace(cfg.namespace);
+  const doc = {
+    apiVersion: 'v1',
+    kind: 'Secret',
+    metadata: { name: secretNameFor(cfg), namespace: cfg.namespace },
+    type: 'Opaque',
+    stringData: data,
+  };
+  run('kubectl', ['apply', '-f', '-'], { stdio: ['pipe', 'inherit', 'inherit'], input: JSON.stringify(doc) });
+}
+
+function setSecret(cfg, key, value) {
+  const data = readAll(cfg);
+  data[key] = value;
+  writeAll(cfg, data);
+}
+
+function unsetSecret(cfg, key) {
+  const data = readAll(cfg);
+  if (!(key in data)) return false;
+  delete data[key];
+  if (Object.keys(data).length === 0) {
+    run('kubectl', ['delete', 'secret', secretNameFor(cfg), '-n', cfg.namespace, '--ignore-not-found=true'], { stdio: 'ignore' });
+  } else {
+    writeAll(cfg, data);
+  }
+  return true;
+}
+
+function listKeys(cfg) {
+  return Object.keys(readAll(cfg));
+}
+
+module.exports = { secretNameFor, setSecret, unsetSecret, listKeys, readAll };

package/src/lib/clusterAddons.js

@@ -1,59 +1,59 @@
-const { run } = require('./exec');
-const { loadAddon } = require('./addonLoader');
-const { findAddonDir, listAddonNames } = require('./addonDirs');
-const { getList, workloadsWithPrefix } = require('./workloadReadiness');
-const { DOMAIN, OBSERVABILITY_NAMESPACE } = require('./constants');
-const ui = require('./ui');
-
-// Cluster-wide addons live at <addons-dir>/cluster/<name>/addon.yaml - your own addons dir
-// (~/.localctl/addons, or $LOCALCTL_ADDONS_DIR) is searched before the ones bundled with this
-// CLI, and a name there overrides a built-in one of the same name. See docs/adding-tools.md.
-// Shared by `localctl addons` and `localctl profiles new`'s "carry over which addons?" wizard.
-function addonDirFor(name) {
-  const dir = findAddonDir(name, 'cluster');
-  if (!dir) {
-    throw new Error(`Unknown addon "${name}". Known: ${listAddonNames('cluster').join(', ')}.`);
-  }
-  return dir;
-}
-
-function renderClusterAddon(name) {
-  const { manifestYaml } = loadAddon(addonDirFor(name), {
-    release: name,
-    namespace: OBSERVABILITY_NAMESPACE,
-    addonName: name,
-    extraVars: { domain: DOMAIN },
-  });
-  return manifestYaml;
-}
-
-function enableClusterAddon(name) {
-  run('kubectl', ['apply', '-f', '-'], { stdio: ['pipe', 'inherit', 'inherit'], input: renderClusterAddon(name) });
-}
-
-function disableClusterAddon(name) {
-  run('kubectl', ['delete', '-f', '-', '--ignore-not-found=true'], { stdio: ['pipe', 'inherit', 'inherit'], input: renderClusterAddon(name) });
-}
-
-function readyLabel(workloads) {
-  if (workloads.length === 0) return ui.dim('-');
-  const ready = workloads.reduce((sum, w) => sum + w.ready, 0);
-  const desired = workloads.reduce((sum, w) => sum + w.desired, 0);
-  return ui.readyLabel(ready, desired);
-}
-
-function clusterAddonInstances() {
-  const records = getList(['get', 'configmap', '-A', '-l', 'localctl.dev/addon=true']);
-  return records.map((r) => {
-    const release = r.metadata.name.replace(/-localctl-addon$/, '');
-    return {
-      release,
-      owner: r.data.owner || null,
-      namespace: r.metadata.namespace,
-      chart: `${r.data.chart}@${r.data.version}`,
-      ready: readyLabel(workloadsWithPrefix(r.metadata.namespace, release)),
-    };
-  });
-}
-
-module.exports = { renderClusterAddon, enableClusterAddon, disableClusterAddon, clusterAddonInstances };
+const { run } = require('./exec');
+const { loadAddon } = require('./addonLoader');
+const { findAddonDir, listAddonNames } = require('./addonDirs');
+const { getList, workloadsWithPrefix } = require('./workloadReadiness');
+const { DOMAIN, OBSERVABILITY_NAMESPACE } = require('./constants');
+const ui = require('./ui');
+
+// Cluster-wide addons live at <addons-dir>/cluster/<name>/addon.yaml - your own addons dir
+// (~/.localctl/addons, or $LOCALCTL_ADDONS_DIR) is searched before the ones bundled with this
+// CLI, and a name there overrides a built-in one of the same name. See docs/adding-tools.md.
+// Shared by `localctl addons` and `localctl profiles new`'s "carry over which addons?" wizard.
+function addonDirFor(name) {
+  const dir = findAddonDir(name, 'cluster');
+  if (!dir) {
+    throw new Error(`Unknown addon "${name}". Known: ${listAddonNames('cluster').join(', ')}.`);
+  }
+  return dir;
+}
+
+function renderClusterAddon(name) {
+  const { manifestYaml } = loadAddon(addonDirFor(name), {
+    release: name,
+    namespace: OBSERVABILITY_NAMESPACE,
+    addonName: name,
+    extraVars: { domain: DOMAIN },
+  });
+  return manifestYaml;
+}
+
+function enableClusterAddon(name) {
+  run('kubectl', ['apply', '-f', '-'], { stdio: ['pipe', 'inherit', 'inherit'], input: renderClusterAddon(name) });
+}
+
+function disableClusterAddon(name) {
+  run('kubectl', ['delete', '-f', '-', '--ignore-not-found=true'], { stdio: ['pipe', 'inherit', 'inherit'], input: renderClusterAddon(name) });
+}
+
+function readyLabel(workloads) {
+  if (workloads.length === 0) return ui.dim('-');
+  const ready = workloads.reduce((sum, w) => sum + w.ready, 0);
+  const desired = workloads.reduce((sum, w) => sum + w.desired, 0);
+  return ui.readyLabel(ready, desired);
+}
+
+function clusterAddonInstances() {
+  const records = getList(['get', 'configmap', '-A', '-l', 'localctl.dev/addon=true']);
+  return records.map((r) => {
+    const release = r.metadata.name.replace(/-localctl-addon$/, '');
+    return {
+      release,
+      owner: r.data.owner || null,
+      namespace: r.metadata.namespace,
+      chart: `${r.data.chart}@${r.data.version}`,
+      ready: readyLabel(workloadsWithPrefix(r.metadata.namespace, release)),
+    };
+  });
+}
+
+module.exports = { renderClusterAddon, enableClusterAddon, disableClusterAddon, clusterAddonInstances };