docs: add Genie Code deployment guide - #12
Open
deepbasu123 wants to merge 4 commits into
Open
Conversation
Add docs/deploy-with-genie-code.md, a runbook for deploying the WAF assessment app from inside a workspace via Genie Code and %sh notebook cells: authenticate the CLI from the notebook session, install Node 22 and the CLI, clone, provision the Lakebase database and SQL warehouse binding, write variable-overrides.json, run npm run lifecycle, verify. States plainly that this is not the documented supported install path (that stays the laptop / web-terminal route in install.md) and links to it, with troubleshooting for the shell-path failure modes. Co-authored-by: Isaac <no-reply@databricks.com>
Add a short callout under Get started pointing to the Deploy with Genie Code guide as an in-workspace alternative to the supported Asset Bundle path. Co-authored-by: Isaac <no-reply@databricks.com>
Rework docs/deploy-with-genie-code.md so it states the deployment objective and the app-specific facts Genie Code cannot infer (the four bindings, the lifecycle command, the auth/scope constraints) and lets Genie Code work out the mechanics, instead of prescribing a fixed %sh script. Replace the terminal-only verify step with a Python SDK self-check that authenticates as the notebook user (no profile needed), tests app state, deployment status, on-behalf-of scopes and resource bindings, prints a PASS/FAIL per check and an overall verdict, and adds a rubric for reading it. Honest "not the supported path" framing preserved. Co-authored-by: Isaac <no-reply@databricks.com>
Remove the "what you can and cannot do" section and the cannot-infer / cannot-guess / %sh-availability phrasing. Keep the app-specific facts, prerequisites, deploy command, and the self-check; move the one "not the supported path" note to the intro. Co-authored-by: Isaac <no-reply@databricks.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/deploy-with-genie-code.md, a deployment guide aimed at Genie Code (the in-workspace assistant). People routinely point Genie Code at this public repo and ask it to deploy the WAF assessment app into their own workspace. Because the app deploys through a Node + Databricks CLI bundle (npm run lifecycle) that cannot run in an ordinary notebook cell, those attempts fail. This guide gives a working in-workspace path, driven from a single notebook via%shcells:~/.databrickscfgprofile, because the lifecycle wrapper removes the standard Databricks auth env vars)npm ciapp/.databricks/bundle/customer/variable-overrides.jsonnpm run lifecycle -- validate→ preview →--applyWhy
It sets correct expectations for a common real-world flow and gives it a path that actually completes, while being explicit that this is not the documented supported install path (that remains the laptop / web-terminal route in
docs/install.md), with troubleshooting for the shell-path failure modes (egress, cluster access mode, token lifetime, the post-deploy idempotency check).Verification
Docs-only change; no source or build touched. Commands, the
variable-overrides.jsonpath and fields, thenpm run lifecyclecommand lines, the Node/CLI prerequisites, and the app name were checked againstdocs/install.md,docs/deployment-lifecycle.md,app/databricks.yml, andapp/app.yaml. Front-matter and internal links follow the Jekyll house style (title/description/permalink/eyebrow,relative_url).Deployment impact
None. Adds one published docs page.
This pull request and its description were written by Isaac.