Skip to content

docs(installation): clarify download/staging copy + collapse init script render #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mjohns-databricks merged 1 commit into from
May 20, 2026
Merged

docs(installation): clarify download/staging copy + collapse init script render #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 16 additions & 3 deletions docs/docs/installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ from that release's assets over the version shown below.
### 1. Download Release Artifacts

Each GeoBrix [release](https://github.com/databrickslabs/geobrix/releases)
attaches three files for the GDAL install path:
attaches three files for the GDAL install path (among others):

- `geobrix-gdal-artifacts-v<version>-noble.tar.gz` — the bundle (JAR,
`libgdalalljni.so`, GDAL `.deb`s, Python wheels — everything pre-built and
Expand Down Expand Up @@ -71,11 +71,11 @@ release/operator process.

### 3. Stage the Init Script

The init script is **not** uploaded to the bundle Volume; it's the cluster's
The init script is **not** included in the bundle (from above); it's the cluster's
init-script attachment.

1. Upload the release's `geobrix-gdal-init.sh` to a workspace file path or
a separate Volume the cluster can read.
a separate Volume the cluster can read, e.g. the same `VOL_DIR` you set (below) or elsewhere.
2. Edit `VOL_DIR` (one line near the top of the script) to point at the
Volume from step 2.
3. No other edits are required — the script reads the expected tarball
Expand Down Expand Up @@ -108,8 +108,21 @@ are installed by this script. This lets the GeoBrix Python wheel be
bumped independently of the GDAL platform layer.
:::

Preview of the first 10 lines — expand below for the full script (~400 lines).

<CodeFromTest
code={initScript.split('\n').slice(0, 10).join('\n') + '\n# ... (expand the disclosure below for the full script)'}
language="bash"
title="GeoBrix Init Script — preview (scripts/geobrix-gdal-init.sh)"
/>

<details>
<summary>Show the full init script</summary>

<CodeFromTest code={initScript} language="bash" title="GeoBrix Init Script (scripts/geobrix-gdal-init.sh)" />

</details>

### 4. Configure Cluster

#### Add Init Script
Expand Down
Loading