feat: codeflare logs command

update tests/kind/run to use plain log streamer

Author: starpit

deploy/self-test/Dockerfile

@@ -4,7 +4,7 @@ LABEL org.opencontainers.image.source https://github.com/project-codeflare/codef
 
 ENV DEBIAN_FRONTEND=noninteractive
 
-RUN apt update && apt -y install sudo curl python3 python3-pip python3-venv git \
+RUN apt update && apt -y install sudo curl python3 python3-pip python3-venv git uuid-runtime \
         && pip3 install --no-cache-dir  -U pip && pip3 install --no-cache-dir -U setuptools \
         && apt -y clean && rm -rf /var/lib/apt/lists/*
 

package-lock.json

@@ -30,13 +30,13 @@
     "@types/split2": "^3.2.1"
   },
   "dependencies": {
-    "@guidebooks/store": "^3.3.9",
+    "@guidebooks/store": "^3.3.12",
     "@logdna/tail-file": "^3.0.1",
     "@patternfly/react-charts": "^6.94.18",
     "@patternfly/react-core": "^4.276.6",
     "asciinema-player": "^3.0.1",
     "chokidar": "^3.5.3",
-    "madwizard": "^6.1.2",
+    "madwizard": "^6.2.0",
     "needle": "^3.2.0",
     "open": "^8.4.0",
     "pretty-bytes": "^6.0.0",

plugins/plugin-codeflare/package.json

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2022 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { productName } from "@kui-shell/client/config.d/name.json"
+
+const appName = productName.toLowerCase()
+export default appName

plugins/plugin-codeflare/src/controller/appName.ts

@@ -19,6 +19,7 @@ import Debug from "debug"
 import { MadWizardOptions } from "madwizard"
 import { Arguments, Capabilities, ParsedOptions } from "@kui-shell/core"
 
+import appName from "./appName"
 import { DashboardOptions } from "./dashboard"
 
 export type Options = ParsedOptions &
@@ -57,7 +58,6 @@ export async function attach(
     process.env.JOB_ID = jobId
   }
 
-  const appName = "codeflare"
   const options: MadWizardOptions = Object.assign(
     {
       appName,

plugins/plugin-codeflare/src/controller/attach.ts

@@ -25,6 +25,7 @@ import events from "./events"
 import dashboard from "./dashboard"
 import description from "./description"
 import { Options as AttachOptions } from "./attach"
+import { ProfileOptions, profileFlags } from "./options"
 
 function help() {
   return `Usage:
@@ -42,6 +43,12 @@ export default function registerCodeflareCommands(registrar: Registrar) {
   description(registrar)
   registrar.listen("/help", help)
 
+  registrar.listen<KResponse, ProfileOptions>(
+    "/codeflare/logs",
+    (args) => import("./logs").then((_) => _.default(args)),
+    { flags: profileFlags }
+  )
+
   registrar.listen<KResponse, AttachOptions>(
     "/codeflare/attach",
     (args) => import("./attach").then((_) => _.default(args)),

plugins/plugin-codeflare/src/controller/index.ts

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2023 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { Arguments } from "@kui-shell/core"
+import { MadWizardOptions } from "madwizard"
+
+import appName from "./appName"
+import { ProfileOptions } from "./options"
+
+export default async function logs(args: Arguments<ProfileOptions>) {
+  // Display logs for this jobID; if not provided, the user will be
+  // prompted (via the guidebook) to choose one
+  const jobId = args.argvNoOptions[args.argvNoOptions.indexOf("logs") + 1]
+  if (jobId) {
+    process.env.JOB_ID = jobId
+  }
+
+  // play this guidebook
+  const guidebook = jobId === undefined ? "ml/ray/aggregator" : "ml/ray/aggregator/with-jobid"
+
+  // but only interactive starting here
+  const ifor =
+    jobId === undefined
+      ? ["ml/ray/cluster/choose", "ml/ray/cluster/choose/kubernetes", "ml/ray/run/choose/list-jobs"]
+      : undefined
+
+  const options: MadWizardOptions = Object.assign({
+    appName,
+    store: args.parsedOptions.s || process.env.GUIDEBOOK_STORE,
+    verbose: args.parsedOptions.V,
+    profile: args.parsedOptions.profile || (await import("madwizard").then((_) => _.Profiles.lastUsed())),
+    interactive: false,
+    ifor,
+  })
+
+  const { guide } = await import("madwizard/dist/fe/cli")
+
+  await guide([appName, "guide", guidebook], undefined, options)
+  return true
+}

plugins/plugin-codeflare/src/controller/logs.ts

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2023 The Kubernetes Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { CommandOptions, ParsedOptions } from "@kui-shell/core"
+
+export type ProfileOptions = ParsedOptions & {
+  p: string
+  profile: string
+  s: string
+  store: string
+  V: string
+  verbose: string
+}
+
+export const profileFlags: CommandOptions["flags"] = {
+  boolean: ["V", "verbose"],
+  alias: {
+    verbose: ["V"],
+    profile: ["p"],
+    store: ["s"],
+  },
+}

plugins/plugin-codeflare/src/controller/options.ts

@@ -19,6 +19,7 @@
     "kubernetes/choose/ns": "default",
     "ml/ray/storage/s3/maybe": "My code does not use Ray Workflows",
     "ml/ray/cluster/choose": "codeflare-test-ray-cluster",
+    "ml/ray/cluster/choose/kubernetes": "codeflare-test-ray-cluster",
     "ml/ray/cluster/kubernetes/choose-pod-scheduler": "Keep It Simple"
   }
 }

tests/kind/profiles/gpu1/keep-it-simple

@@ -1,8 +1,8 @@
 {
   "name": "keep-it-simple",
   "creationTime": 1664149787016,
-  "lastModifiedTime": 1664149821230,
-  "lastUsedTime": 1675364320141,
+  "lastModifiedTime": 1676828268772,
+  "lastUsedTime": 1676836671254,
   "choices": {
     "madwizard/apriori/use-gpu": "don't use gpus",
     "madwizard/apriori/arch": "x64",
@@ -19,6 +19,7 @@
     "kubernetes/choose/ns": "default",
     "ml/ray/storage/s3/maybe": "My code does not use Ray Workflows",
     "ml/ray/cluster/choose": "codeflare-test-ray-cluster",
+    "ml/ray/cluster/choose/kubernetes": "codeflare-test-ray-cluster",
     "ml/ray/cluster/kubernetes/choose-pod-scheduler": "Keep It Simple"
   }
 }