kubernetes-fluent-client 2.3.1 → 2.4.0

package/README.md

@@ -51,6 +51,10 @@ async function demo() {
   runningPods.items.forEach(pod => {
     console.log(`${pod.metadata?.namespace}/${pod.metadata?.name} is running`);
   });
+
+  // Get logs from a Deployment named "nginx" in the namespace
+  const logs = await K8s(kind.Deployment).InNamespace(namespace).Logs("nginx");
+  console.log(logs);
 }
 
 // Create a few resources to work with: Namespace, ConfigMap, and Pod

package/dist/fluent/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fluent/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAwB,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAOjF,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAA0B,OAAO,EAAE,OAAO,EAAsB,MAAM,SAAS,CAAC;AAIvF;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,EACtF,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,OAAY,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CA8Kf"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fluent/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAwB,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAOjF,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAA0B,OAAO,EAAE,OAAO,EAAsB,MAAM,SAAS,CAAC;AAKvF;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,EACtF,KAAK,EAAE,CAAC,EACR,OAAO,GAAE,OAAY,GACpB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CA0Pf"}

package/dist/fluent/index.js

@@ -8,6 +8,8 @@ const fetch_1 = require("../fetch");
 const kinds_1 = require("../kinds");
 const utils_1 = require("./utils");
 const watch_1 = require("./watch");
+const helpers_1 = require("../helpers");
+const upstream_1 = require("../upstream");
 /**
  * Kubernetes fluent API inspired by Kubectl. Pass in a model, then call filters and actions on it.
  *
@@ -16,7 +18,7 @@ const watch_1 = require("./watch");
  * @returns a fluent API for the model
  */
 function K8s(model, filters = {}) {
-    const withFilters = { WithField, WithLabel, Get, Delete, Watch };
+    const withFilters = { WithField, WithLabel, Get, Delete, Watch, Logs };
     const matchedKind = filters.kindOverride || (0, kinds_1.modelToGroupVersionKind)(model.name);
     /**
      * @inheritdoc
@@ -70,6 +72,67 @@ function K8s(model, filters = {}) {
             payload.kind = matchedKind.kind;
         }
     }
+    /**
+     * @inheritdoc
+     * @see {@link K8sInit.Logs}
+     */
+    async function Logs(name) {
+        let labels = {};
+        const { kind } = matchedKind;
+        const { namespace } = filters;
+        const podList = [];
+        if (name) {
+            if (filters.name) {
+                throw new Error(`Name already specified: ${filters.name}`);
+            }
+            filters.name = name;
+        }
+        if (!namespace) {
+            throw new Error("Namespace must be defined");
+        }
+        if (!(0, helpers_1.hasLogs)(kind)) {
+            throw new Error("Kind must be Pod or have a selector");
+        }
+        try {
+            const object = await (0, utils_1.k8sExec)(model, filters, "GET");
+            if (kind !== "Pod") {
+                if (kind === "Service") {
+                    const svc = object;
+                    labels = svc.spec.selector ?? {};
+                }
+                else if (kind === "ReplicaSet" ||
+                    kind === "Deployment" ||
+                    kind === "StatefulSet" ||
+                    kind === "DaemonSet") {
+                    const rs = object;
+                    labels = rs.spec.selector.matchLabels ?? {};
+                }
+                const list = await K8s(upstream_1.Pod, { namespace: filters.namespace, labels }).Get();
+                list.items.forEach(item => {
+                    return podList.push(item);
+                });
+            }
+            else {
+                podList.push(object);
+            }
+        }
+        catch (e) {
+            throw new Error(e);
+        }
+        const podModel = { ...model, name: "V1Pod" };
+        const logPromises = podList.map(po => (0, utils_1.k8sExec)(podModel, { ...filters, name: po.metadata.name }, "LOG"));
+        const responses = await Promise.all(logPromises);
+        const combinedString = responses.reduce((accumulator, currentString, i) => {
+            const prefixedLines = currentString
+                .split("\n")
+                .map(line => {
+                return line !== "" ? `[pod/${podList[i].metadata.name}] ${line}` : "";
+            })
+                .filter(str => str !== "");
+            return [...accumulator, ...prefixedLines];
+        }, []);
+        return combinedString;
+    }
     /**
      * @inheritdoc
      * @see {@link K8sInit.Get}

package/dist/fluent/types.d.ts

@@ -13,7 +13,7 @@ export declare enum WatchPhase {
     Bookmark = "BOOKMARK",
     Error = "ERROR"
 }
-export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH" | "PATCH_STATUS";
+export type FetchMethods = "GET" | "APPLY" | "POST" | "PUT" | "DELETE" | "PATCH" | "WATCH" | "PATCH_STATUS" | "LOG";
 export interface Filters {
     kindOverride?: GroupVersionKind;
     fields?: Record<string, string>;

package/dist/fluent/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fluent/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,YAAY,GACpB,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,QAAQ,GACR,OAAO,GACP,OAAO,GACP,cAAc,CAAC;AAEnB,MAAM,WAAW,OAAO;IACtB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI;IACpD,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI;IACnF;;;;OAIG;IACH,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEpB;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC7D;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACH,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtD;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,kBAAkB,CACjG,CAAC,EACD,CAAC,CACF,GAAG;IACF;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/E;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5F,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACxB;;;;;OAKG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1D,CAAC;AAEJ,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAC9F,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,UAAU,KACd,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAG1B,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,GACvC,CAAC,SAAS,MAAM,GAAG,MAAM,GACvB,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,EAAE,GACpC,KAAK,GACP,KAAK,CAAC;AAEV,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC7D,KAAK,GACL,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACpF,CAAC,MAAM,CAAC,CAAC,GACV,EAAE,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/fluent/types.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AACjF,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAE7C,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC1D,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5C;;GAEG;AACH,oBAAY,UAAU;IACpB,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,YAAY,GACpB,KAAK,GACL,OAAO,GACP,MAAM,GACN,KAAK,GACL,QAAQ,GACR,OAAO,GACP,OAAO,GACP,cAAc,GACd,KAAK,CAAC;AAEV,MAAM,WAAW,OAAO;IACtB,YAAY,CAAC,EAAE,gBAAgB,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,gBAAgB,IAAI;IACpD,IAAI,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACrC,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI;IACnF;;;;OAIG;IACH,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC;IAEpB;;;;OAIG;IACH,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC7D;;;;;;OAMG;IACH,KAAK,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,CAAC,EAAE,QAAQ,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAErE;;;;;OAKG;IACH,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEpC;;;;;;;OAOG;IACH,KAAK,EAAE,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAE5C;;;;;;;;;;;OAWG;IACH,WAAW,EAAE,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;IAEtD;;;;;;;;;;;;;;;;OAgBG;IACH,GAAG,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY,KAAK,OAAO,CAAC,CAAC,CAAC,CAAC;CACzD,CAAC;AAEF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,kBAAkB,CACjG,CAAC,EACD,CAAC,CACF,GAAG;IACF;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAS,EAAE,CAAC,CAAC,SAAS,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAE/E;;;;;;;;;;;;;;;;;OAiBG;IACH,SAAS,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAClE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,IAAI,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,GAC5F,oBAAoB,CAAC,CAAC,CAAC,GAAG;IACxB;;;;;OAKG;IACH,WAAW,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;CAC1D,CAAC;AAEJ,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,SAAS,gBAAgB,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAC9F,MAAM,EAAE,CAAC,EACT,KAAK,EAAE,UAAU,KACd,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;AAG1B,KAAK,IAAI,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,MAAM,GAAG,MAAM,GACvC,CAAC,SAAS,MAAM,GAAG,MAAM,GACvB,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,CAAC,EAAE,GACpC,KAAK,GACP,KAAK,CAAC;AAEV,MAAM,MAAM,KAAK,CAAC,CAAC,EAAE,CAAC,SAAS,MAAM,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAC7D,KAAK,GACL,CAAC,SAAS,MAAM,GACd;KACG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,MAAM,GAAG,MAAM,GAAG,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK;CACpF,CAAC,MAAM,CAAC,CAAC,GACV,EAAE,CAAC"}

package/dist/fluent/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fluent/utils.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAI1B,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI1D;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAChD,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,WAAW,UAAQ,OAwDpB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY;;;GAwBhD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,EACrD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,EACrB,QAAQ,GAAE,QAA2B,cA2CtC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/fluent/utils.ts"],"names":[],"mappings":";AAKA,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAC;AAI1B,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI1D;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,SAAS,YAAY,EAChD,SAAS,EAAE,MAAM,EACjB,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,WAAW,UAAQ,OAwDpB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,MAAM,CAAC,MAAM,EAAE,YAAY;;;GAwBhD;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,OAAO,CAAC,CAAC,SAAS,YAAY,EAAE,CAAC,EACrD,KAAK,EAAE,CAAC,EACR,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,EACrB,QAAQ,GAAE,QAA2B,cAwDtC"}

package/dist/fluent/utils.js

@@ -105,8 +105,20 @@ exports.k8sCfg = k8sCfg;
  * @returns the parsed JSON response
  */
 async function k8sExec(model, filters, method, payload, applyCfg = { force: false }) {
-    const { opts, serverUrl } = await k8sCfg(method);
-    const url = pathBuilder(serverUrl, model, filters, method === "POST");
+    const reconstruct = async (method) => {
+        const configMethod = method === "LOG" ? "GET" : method;
+        const { opts, serverUrl } = await k8sCfg(configMethod);
+        const isPost = method === "POST";
+        const baseUrl = pathBuilder(serverUrl, model, filters, isPost);
+        if (method === "LOG") {
+            baseUrl.pathname = `${baseUrl.pathname}/log`;
+        }
+        return {
+            url: baseUrl,
+            opts,
+        };
+    };
+    const { opts, url } = await reconstruct(method);
     switch (opts.method) {
         // PATCH_STATUS is a special case that uses the PATCH method on status subresources
         case "PATCH_STATUS":

package/dist/fluent/watch.d.ts

@@ -31,6 +31,8 @@ export declare enum WatchEvent {
 }
 /** Configuration for the watch function. */
 export type WatchCfg = {
+    /** Whether to allow watch bookmarks. */
+    allowWatchBookmarks?: boolean;
     /** The resource version to start the watch at, this will be updated on each event. */
     resourceVersion?: string;
     /** The maximum number of times to retry the watch, the retry count is reset on success. Unlimited retries if not specified. */

package/dist/fluent/watch.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,uBAAuB;IACvB,MAAM,WAAW;IACjB,mCAAmC;IACnC,IAAI,SAAS;IACb,2BAA2B;IAC3B,QAAQ,aAAa;IACrB,iCAAiC;IACjC,gBAAgB,qBAAqB;IACrC,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;CACxC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAyBzC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAiBzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAMZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;OAIG;IACH,IAAW,eAAe,IASkB,MAAM,GAAG,SAAS,CAP7D;IAED;;;;OAIG;IACH,IAAW,eAAe,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,EAE7D;IAED;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAoOF"}
+{"version":3,"file":"watch.d.ts","sourceRoot":"","sources":["../../src/fluent/watch.ts"],"names":[],"mappings":";;AAKA,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,EAAE,YAAY,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,WAAW,EAAc,MAAM,SAAS,CAAC;AAG3D,oBAAY,UAAU;IACpB,sCAAsC;IACtC,OAAO,YAAY;IACnB,2BAA2B;IAC3B,aAAa,kBAAkB;IAC/B,kDAAkD;IAClD,UAAU,eAAe;IACzB,0BAA0B;IAC1B,SAAS,cAAc;IACvB,8BAA8B;IAC9B,OAAO,YAAY;IACnB,sBAAsB;IACtB,KAAK,UAAU;IACf,uBAAuB;IACvB,MAAM,WAAW;IACjB,mCAAmC;IACnC,IAAI,SAAS;IACb,2BAA2B;IAC3B,QAAQ,aAAa;IACrB,iCAAiC;IACjC,gBAAgB,qBAAqB;IACrC,wCAAwC;IACxC,oBAAoB,yBAAyB;IAC7C,qCAAqC;IACrC,iBAAiB,sBAAsB;CACxC;AAED,4CAA4C;AAC5C,MAAM,MAAM,QAAQ,GAAG;IACrB,wCAAwC;IACxC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,sFAAsF;IACtF,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,+HAA+H;IAC/H,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,oEAAoE;IACpE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,0GAA0G;IAC1G,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,iDAAiD;AACjD,qBAAa,OAAO,CAAC,CAAC,SAAS,YAAY;;IAyBzC;;;;;;;;;;;OAWG;gBACS,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC,EAAE,QAAQ,GAAE,QAAa;IAiBzF;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,eAAe,CAAC;IAK9C,gGAAgG;IACzF,KAAK;IAMZ;;;;;OAKG;IACI,UAAU;IAWjB;;;;OAIG;IACH,IAAW,eAAe,IASkB,MAAM,GAAG,SAAS,CAP7D;IAED;;;;OAIG;IACH,IAAW,eAAe,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,EAE7D;IAED;;;;;;OAMG;IACH,IAAW,MAAM,IAAI,YAAY,CAEhC;CAyOF"}

package/dist/fluent/watch.js

@@ -159,7 +159,7 @@ class Watcher {
             url.searchParams.set("resourceVersion", this.#watchCfg.resourceVersion);
         }
         // Enable watch bookmarks
-        url.searchParams.set("allowWatchBookmarks", "true");
+        url.searchParams.set("allowWatchBookmarks", this.#watchCfg.allowWatchBookmarks ? `${this.#watchCfg.allowWatchBookmarks}` : "true");
         // Add the abort signal to the request options
         opts.signal = this.#abortController.signal;
         return { opts, url };
@@ -281,6 +281,7 @@ class Watcher {
             this.#retryCount++;
             this.#events.emit(WatchEvent.RECONNECT, err, this.#retryCount);
             if (this.#pendingReconnect) {
+                // wait for the connection to be re-established
                 this.#events.emit(WatchEvent.RECONNECT_PENDING);
             }
             else {

package/dist/helpers.d.ts

@@ -23,4 +23,11 @@ export declare function fromEnv(name: string): string;
  * @returns The current cluster.
  */
 export declare function waitForCluster(seconds?: number): Promise<Cluster>;
+/**
+ * Determines if object has logs.
+ *
+ * @param kind The kind of Kubernetes object.
+ * @returns boolean.
+ */
+export declare function hasLogs(kind: string): boolean;
 //# sourceMappingURL=helpers.d.ts.map

package/dist/helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAc,MAAM,yBAAyB,CAAC;AAkB9D;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAqB5C;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,OAAO,SAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAenE"}
+{"version":3,"file":"helpers.d.ts","sourceRoot":"","sources":["../src/helpers.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,OAAO,EAAc,MAAM,yBAAyB,CAAC;AAkB9D;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAqB5C;AAED;;;;;GAKG;AACH,wBAAsB,cAAc,CAAC,OAAO,SAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAenE;AAED;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAuB7C"}

package/dist/helpers.js

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 // SPDX-FileCopyrightText: 2023-Present The Kubernetes Fluent Client Authors
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitForCluster = exports.fromEnv = void 0;
+exports.hasLogs = exports.waitForCluster = exports.fromEnv = void 0;
 const client_node_1 = require("@kubernetes/client-node");
 /**
  *  Sleep for a number of seconds.
@@ -71,3 +71,34 @@ async function waitForCluster(seconds = 30) {
     return cluster;
 }
 exports.waitForCluster = waitForCluster;
+/**
+ * Determines if object has logs.
+ *
+ * @param kind The kind of Kubernetes object.
+ * @returns boolean.
+ */
+function hasLogs(kind) {
+    let hasSelector = false;
+    switch (kind) {
+        case "Pod":
+            hasSelector = true;
+            break;
+        case "DaemonSet":
+            hasSelector = true;
+            break;
+        case "ReplicaSet":
+            hasSelector = true;
+            break;
+        case "Service":
+            hasSelector = true;
+            break;
+        case "StatefulSet":
+            hasSelector = true;
+            break;
+        case "Deployment":
+            hasSelector = true;
+            break;
+    }
+    return hasSelector;
+}
+exports.hasLogs = hasLogs;

package/dist/helpers.test.js

@@ -20,3 +20,18 @@ const helpers_1 = require("./helpers");
         (0, globals_1.expect)(cluster).toEqual({ server: "http://jest-test:8080" });
     });
 });
+(0, globals_1.describe)("hasLogs function", () => {
+    (0, globals_1.it)("should return true for known kinds", () => {
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("Pod")).toBe(true);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("DaemonSet")).toBe(true);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("ReplicaSet")).toBe(true);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("Service")).toBe(true);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("StatefulSet")).toBe(true);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("Deployment")).toBe(true);
+    });
+    (0, globals_1.it)("should return false for unknown kinds", () => {
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("Unknown")).toBe(false);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("")).toBe(false);
+        (0, globals_1.expect)((0, helpers_1.hasLogs)("RandomKind")).toBe(false);
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kubernetes-fluent-client",
-  "version": "2.3.1",
+  "version": "2.4.0",
   "description": "A @kubernetes/client-node fluent API wrapper that leverages K8s Server Side Apply.",
   "bin": "./dist/cli.js",
   "main": "dist/index.js",
@@ -40,26 +40,26 @@
     "fast-json-patch": "3.1.1",
     "http-status-codes": "2.3.0",
     "node-fetch": "2.7.0",
-    "quicktype-core": "23.0.115",
-    "type-fest": "4.15.0",
+    "quicktype-core": "23.0.158",
+    "type-fest": "4.18.1",
     "yargs": "17.7.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "19.2.1",
-    "@commitlint/config-conventional": "19.1.0",
+    "@commitlint/cli": "19.3.0",
+    "@commitlint/config-conventional": "19.2.2",
     "@jest/globals": "29.7.0",
     "@types/byline": "4.2.36",
-    "@types/readable-stream": "4.0.11",
+    "@types/readable-stream": "4.0.12",
     "@types/yargs": "17.0.32",
-    "@typescript-eslint/eslint-plugin": "7.5.0",
-    "@typescript-eslint/parser": "7.5.0",
+    "@typescript-eslint/eslint-plugin": "7.8.0",
+    "@typescript-eslint/parser": "7.8.0",
     "eslint-plugin-jsdoc": "48.2.3",
     "jest": "29.7.0",
     "nock": "13.5.4",
     "prettier": "3.2.5",
-    "semantic-release": "23.0.7",
+    "semantic-release": "23.0.8",
     "ts-jest": "29.1.2",
-    "typescript": "5.4.4"
+    "typescript": "5.4.5"
   },
   "release": {
     "branches": [

package/src/fluent/index.ts

@@ -12,7 +12,8 @@ import { GenericClass } from "../types";
 import { ApplyCfg, FetchMethods, Filters, K8sInit, Paths, WatchAction } from "./types";
 import { k8sCfg, k8sExec } from "./utils";
 import { WatchCfg, Watcher } from "./watch";
-
+import { hasLogs } from "../helpers";
+import { Pod, Service, ReplicaSet } from "../upstream";
 /**
  * Kubernetes fluent API inspired by Kubectl. Pass in a model, then call filters and actions on it.
  *
@@ -24,7 +25,7 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
   model: T,
   filters: Filters = {},
 ): K8sInit<T, K> {
-  const withFilters = { WithField, WithLabel, Get, Delete, Watch };
+  const withFilters = { WithField, WithLabel, Get, Delete, Watch, Logs };
   const matchedKind = filters.kindOverride || modelToGroupVersionKind(model.name);
 
   /**
@@ -87,7 +88,83 @@ export function K8s<T extends GenericClass, K extends KubernetesObject = Instanc
       payload.kind = matchedKind.kind;
     }
   }
+  async function Logs(name?: string): Promise<string[]>;
+  /**
+   * @inheritdoc
+   * @see {@link K8sInit.Logs}
+   */
+  async function Logs(name?: string): Promise<string[]> {
+    let labels: Record<string, string> = {};
+    const { kind } = matchedKind;
+    const { namespace } = filters;
+    const podList: K[] = [];
+
+    if (name) {
+      if (filters.name) {
+        throw new Error(`Name already specified: ${filters.name}`);
+      }
+      filters.name = name;
+    }
+
+    if (!namespace) {
+      throw new Error("Namespace must be defined");
+    }
+    if (!hasLogs(kind)) {
+      throw new Error("Kind must be Pod or have a selector");
+    }
 
+    try {
+      const object = await k8sExec<T, K>(model, filters, "GET");
+
+      if (kind !== "Pod") {
+        if (kind === "Service") {
+          const svc: InstanceType<typeof Service> = object;
+          labels = svc.spec!.selector ?? {};
+        } else if (
+          kind === "ReplicaSet" ||
+          kind === "Deployment" ||
+          kind === "StatefulSet" ||
+          kind === "DaemonSet"
+        ) {
+          const rs: InstanceType<typeof ReplicaSet> = object;
+          labels = rs.spec!.selector.matchLabels ?? {};
+        }
+
+        const list = await K8s(Pod, { namespace: filters.namespace, labels }).Get();
+
+        list.items.forEach(item => {
+          return podList.push(item as unknown as K);
+        });
+      } else {
+        podList.push(object);
+      }
+    } catch (e) {
+      throw new Error(e);
+    }
+
+    const podModel = { ...model, name: "V1Pod" };
+    const logPromises = podList.map(po =>
+      k8sExec<T, string>(podModel, { ...filters, name: po.metadata!.name! }, "LOG"),
+    );
+
+    const responses = await Promise.all(logPromises);
+
+    const combinedString = responses.reduce(
+      (accumulator: string[], currentString: string, i: number) => {
+        const prefixedLines = currentString
+          .split("\n")
+          .map(line => {
+            return line !== "" ? `[pod/${podList[i].metadata!.name!}] ${line}` : "";
+          })
+          .filter(str => str !== "");
+
+        return [...accumulator, ...prefixedLines];
+      },
+      [],
+    );
+
+    return combinedString;
+  }
   async function Get(): Promise<KubernetesListObject<K>>;
   async function Get(name: string): Promise<K>;
   /**

package/src/fluent/types.ts

@@ -27,7 +27,8 @@ export type FetchMethods =
   | "DELETE"
   | "PATCH"
   | "WATCH"
-  | "PATCH_STATUS";
+  | "PATCH_STATUS"
+  | "LOG";
 
 export interface Filters {
   kindOverride?: GroupVersionKind;

package/src/fluent/utils.ts

@@ -138,8 +138,21 @@ export async function k8sExec<T extends GenericClass, K>(
   payload?: K | unknown,
   applyCfg: ApplyCfg = { force: false },
 ) {
-  const { opts, serverUrl } = await k8sCfg(method);
-  const url = pathBuilder(serverUrl, model, filters, method === "POST");
+  const reconstruct = async (method: FetchMethods) => {
+    const configMethod = method === "LOG" ? "GET" : method;
+    const { opts, serverUrl } = await k8sCfg(configMethod);
+    const isPost = method === "POST";
+    const baseUrl = pathBuilder(serverUrl, model, filters, isPost);
+    if (method === "LOG") {
+      baseUrl.pathname = `${baseUrl.pathname}/log`;
+    }
+    return {
+      url: baseUrl,
+      opts,
+    };
+  };
+
+  const { opts, url } = await reconstruct(method);
 
   switch (opts.method) {
     // PATCH_STATUS is a special case that uses the PATCH method on status subresources

package/src/fluent/watch.ts

@@ -39,6 +39,8 @@ export enum WatchEvent {
 
 /** Configuration for the watch function. */
 export type WatchCfg = {
+  /** Whether to allow watch bookmarks. */
+  allowWatchBookmarks?: boolean;
   /** The resource version to start the watch at, this will be updated on each event. */
   resourceVersion?: string;
   /** The maximum number of times to retry the watch, the retry count is reset on success. Unlimited retries if not specified. */
@@ -175,6 +177,7 @@ export class Watcher<T extends GenericClass> {
   #buildURL = async () => {
     // Build the path and query params for the resource, excluding the name
     const { opts, serverUrl } = await k8sCfg("GET");
+
     const url = pathBuilder(serverUrl, this.#model, this.#filters, true);
 
     // Enable the watch query param
@@ -191,7 +194,10 @@ export class Watcher<T extends GenericClass> {
     }
 
     // Enable watch bookmarks
-    url.searchParams.set("allowWatchBookmarks", "true");
+    url.searchParams.set(
+      "allowWatchBookmarks",
+      this.#watchCfg.allowWatchBookmarks ? `${this.#watchCfg.allowWatchBookmarks}` : "true",
+    );
 
     // Add the abort signal to the request options
     opts.signal = this.#abortController.signal;
@@ -340,6 +346,7 @@ export class Watcher<T extends GenericClass> {
       this.#events.emit(WatchEvent.RECONNECT, err, this.#retryCount);
 
       if (this.#pendingReconnect) {
+        // wait for the connection to be re-established
         this.#events.emit(WatchEvent.RECONNECT_PENDING);
       } else {
         this.#pendingReconnect = true;

package/src/helpers.test.ts

@@ -3,7 +3,7 @@
 
 import { describe, expect, it, test } from "@jest/globals";
 
-import { fromEnv, waitForCluster } from "./helpers";
+import { fromEnv, hasLogs, waitForCluster } from "./helpers";
 
 describe("helpers", () => {
   test("fromEnv for NodeJS", () => {
@@ -23,3 +23,20 @@ describe("Cluster Wait Function", () => {
     expect(cluster).toEqual({ server: "http://jest-test:8080" });
   });
 });
+
+describe("hasLogs function", () => {
+  it("should return true for known kinds", () => {
+    expect(hasLogs("Pod")).toBe(true);
+    expect(hasLogs("DaemonSet")).toBe(true);
+    expect(hasLogs("ReplicaSet")).toBe(true);
+    expect(hasLogs("Service")).toBe(true);
+    expect(hasLogs("StatefulSet")).toBe(true);
+    expect(hasLogs("Deployment")).toBe(true);
+  });
+
+  it("should return false for unknown kinds", () => {
+    expect(hasLogs("Unknown")).toBe(false);
+    expect(hasLogs("")).toBe(false);
+    expect(hasLogs("RandomKind")).toBe(false);
+  });
+});

package/src/helpers.ts

@@ -80,3 +80,34 @@ export async function waitForCluster(seconds = 30): Promise<Cluster> {
 
   return cluster;
 }
+
+/**
+ * Determines if object has logs.
+ *
+ * @param kind The kind of Kubernetes object.
+ * @returns boolean.
+ */
+export function hasLogs(kind: string): boolean {
+  let hasSelector: boolean = false;
+  switch (kind) {
+    case "Pod":
+      hasSelector = true;
+      break;
+    case "DaemonSet":
+      hasSelector = true;
+      break;
+    case "ReplicaSet":
+      hasSelector = true;
+      break;
+    case "Service":
+      hasSelector = true;
+      break;
+    case "StatefulSet":
+      hasSelector = true;
+      break;
+    case "Deployment":
+      hasSelector = true;
+      break;
+  }
+  return hasSelector;
+}