Skip to content

Add "About compute" (BYOC) operator doc [STORM-3018]#851

Draft
kris-preza wants to merge 9 commits into
mainfrom
kp/storm-3018-byoc-compute-docs
Draft

Add "About compute" (BYOC) operator doc [STORM-3018]#851
kris-preza wants to merge 9 commits into
mainfrom
kp/storm-3018-byoc-compute-docs

Conversation

@kris-preza

@kris-preza kris-preza commented Jun 15, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a new Operators Guide page, About compute (amperity_operator/source/compute.rst), documenting Bring Your Own Compute (BYOC) for Databricks. It mirrors the structure and level of detail of the existing About storage (BYOS) page and is wired into the "Build your tenant" grid as "Choose compute".

This is the source draft for STORM-3018 (public documentation), intended to be handed to docs for shaping into docs.amperity.com.

The page covers:

  • What BYOC is and what runs on your compute vs. what stays on Amperity-managed compute
  • Account prerequisites (storage, Unity Catalog, account admin, region, network/subnet capacity)
  • ANSI mode configuration
  • The provisioning wizard and re-sync flows
  • Debugging
  • A shared-responsibility security model
  • A manual setup appendix (Unity Catalog objects, SQL, grants)

STORM-3018

Notes for reviewers

  • Scope is Databricks only for now; Snowflake BYOC content was removed and can be re-added when the private preview resumes.
  • BYOC and BYOS are presented as independent (either can be enabled on its own).
  • Manual-setup resource names and grants were verified against the compute-gateway provisioning code so a hand-built setup matches what the service expects.
  • Internal IAM role ARNs, account IDs, and bucket/container names are intentionally parametrized as placeholders rather than hardcoded, matching BYOS-doc style.
  • The security section reflects the Security Guild review's recommendation to document the shared responsibility model and BYOC boundaries.
  • No screenshots are included yet — the page reuses the generic step-number icons. UI screenshots (Add workspace modal, provisioning progress, Stitch "Run on Databricks" selector) still need to be supplied.

kris-preza and others added 9 commits June 15, 2026 16:25
Add a new operator-guide page documenting Bring Your Own Compute (BYOC)
for Databricks and Snowflake, mirroring the structure and level of detail
of the existing storage (BYOS) page. Covers what BYOC is and what runs
where, account prerequisites, ANSI mode, the provisioning wizard and
re-sync flows, debugging, a shared-responsibility security model, and a
manual setup appendix listing the underlying Unity Catalog / Snowflake
objects, SQL, and grants. Wires the page into the "Build your tenant" grid.

[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Align workload scope, prerequisites, and shared-responsibility model with
the Lakehouse Native BYOC FAQ: add subnet/IP capacity prerequisite and
debugging note, strengthen region-alignment guidance, clarify the
controlled connection model, refine what runs on customer compute vs.
Amperity compute (activation, Bridge/ingest, real-time stay on Amperity),
note one primary lakehouse per tenant and all-or-nothing enablement.

[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…ly naming

Verified manual-setup resource names against compute-gateway provisioning
code (databricks_provision_common.clj, workspace.clj). Catalog is
amperity_<tenant-family> (no stack suffix); all credential, location,
catalog, schema, volume names and grants match. Note that the names must
be used exactly, and that <tenant> is the tenant family identifier.

[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Scope the doc to Databricks; Snowflake can be re-added when the private
preview resumes.

[STORM-3018]

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant