-
Notifications
You must be signed in to change notification settings - Fork 11
feat: Geneva enterprise API V2 doc updates #274
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.
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
Merged
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b121fad
feat: Enterprise API V2 doc updates
rpgreen 409723f
wip
rpgreen 91b59ac
wip
rpgreen fccd59f
wip
rpgreen 47c4a7a
add getting started section
rpgreen 1c2cf28
add getting started section
rpgreen 4f4d247
Rename env vars
rpgreen 8a3276b
Update helm docs
rpgreen aa3e62e
wip
rpgreen 7f4613b
wip
rpgreen 3aadc1e
Restore link
rpgreen 46803f5
Cleanup
rpgreen 73d0d0a
cleanup
rpgreen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -64,14 +64,14 @@ geneva: | |||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| azure: | ||||||||||||||||||||||||||||||||
| # Azure managed identity client ID for the Geneva client. | ||||||||||||||||||||||||||||||||
| # This identity should have a federated credential for the Geneva namespace | ||||||||||||||||||||||||||||||||
| # This identity should have a federated credential for the LanceDB namespace | ||||||||||||||||||||||||||||||||
| # and Storage Blob Data Contributor role on the storage account. | ||||||||||||||||||||||||||||||||
| clientPrincipalId: "" | ||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| 3. Install kuberay operator | ||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||
| export NAMESPACE=geneva | ||||||||||||||||||||||||||||||||
| export NAMESPACE=lancedb | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| helm repo add kuberay https://ray-project.github.io/kuberay-helm/ | ||||||||||||||||||||||||||||||||
| helm repo update | ||||||||||||||||||||||||||||||||
|
|
@@ -89,4 +89,96 @@ kubectl apply -f nvidia-device-plugin.yml | |||||||||||||||||||||||||||||||
| 5. Install Geneva Helm chart | ||||||||||||||||||||||||||||||||
| ```bash | ||||||||||||||||||||||||||||||||
| helm install geneva ./geneva -n $NAMESPACE --create-namespace | ||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ## Default cluster and manifest | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| In LanceDB Enterprise, backfill and refresh jobs run on a **default cluster** (the compute | ||||||||||||||||||||||||||||||||
| pool jobs run on) and a **default manifest** (the Python dependency environment — image and | ||||||||||||||||||||||||||||||||
| packages). Configuring these in the LanceDB Enterprise chart lets jobs run out of the box | ||||||||||||||||||||||||||||||||
| without per-job configuration. They are set under `geneva.defaults` in the chart's | ||||||||||||||||||||||||||||||||
| `values.yaml`: | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ```yaml | ||||||||||||||||||||||||||||||||
| geneva: | ||||||||||||||||||||||||||||||||
| defaults: | ||||||||||||||||||||||||||||||||
| cluster: | ||||||||||||||||||||||||||||||||
| cluster_type: external_ray | ||||||||||||||||||||||||||||||||
| name: deployment-default | ||||||||||||||||||||||||||||||||
| ray_address: "ray://raycluster-kuberay-head-svc.lancedb.svc.cluster.local:10001" | ||||||||||||||||||||||||||||||||
| manifest: | ||||||||||||||||||||||||||||||||
| name: deployment-default | ||||||||||||||||||||||||||||||||
| pip: [geneva, pyarrow, lancedb, pylance] | ||||||||||||||||||||||||||||||||
| head_image: rayproject/ray:2.54.0-py312 | ||||||||||||||||||||||||||||||||
| worker_image: rayproject/ray:2.54.0-py312 | ||||||||||||||||||||||||||||||||
| skip_site_packages: true | ||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| If no default is configured, jobs must specify a manifest explicitly. Individual transforms can override the default manifest by pinning one | ||||||||||||||||||||||||||||||||
| with `@udf` / `@chunker` / `@udtf` (see | ||||||||||||||||||||||||||||||||
| [Advanced Job Configuration](/geneva/jobs/advanced-job-configuration)); to override the cluster | ||||||||||||||||||||||||||||||||
| at runtime, use an [Advanced Execution Context](/geneva/jobs/contexts). | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ## Providing a Ray cluster | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| The LanceDB Helm chart can be configured to deploy a static KubeRay cluster, provision KubeRay clusters on demand per job, or | ||||||||||||||||||||||||||||||||
| use an existing Ray cluster. | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ### Use default LanceDB Enterprise Ray cluster (default) | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| By default, LanceDB Enterprise will use a shared, statically provisioned Ray cluster for job execution. | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| This can be enabled in the Helm chart by setting the following values. | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ```yaml | ||||||||||||||||||||||||||||||||
| raycluster: | ||||||||||||||||||||||||||||||||
| enabled: true | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| global: | ||||||||||||||||||||||||||||||||
| rayclusterUri: "ray://raycluster-kuberay-head-svc.lancedb.svc.cluster.local:10001" | ||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| Configuration for the Ray cluster can be specified by modifying raycluster.yaml Helm values. | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ### Provision KubeRay clusters on demand | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| Set `global.rayclusterUri` to an empty value to provision ephemeral KubeRay clusters on-demand for each execution job. The default KubeRay cluster configuration | ||||||||||||||||||||||||||||||||
| is specified in `geneva.defaults.cluster`, i.e. | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ```yaml | ||||||||||||||||||||||||||||||||
| geneva: | ||||||||||||||||||||||||||||||||
| defaults: | ||||||||||||||||||||||||||||||||
|
Comment on lines
+145
to
+150
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm not good at helm but I'd love it if this were super explicit (do you mean ""? or some other empty value?) so like this:
Suggested change
|
||||||||||||||||||||||||||||||||
| cluster: | ||||||||||||||||||||||||||||||||
| cluster_type: kuberay | ||||||||||||||||||||||||||||||||
| name: deployment-default | ||||||||||||||||||||||||||||||||
| kuberay: | ||||||||||||||||||||||||||||||||
| namespace: lancedb | ||||||||||||||||||||||||||||||||
| config_method: IN_CLUSTER | ||||||||||||||||||||||||||||||||
| head_group: | ||||||||||||||||||||||||||||||||
| service_account: geneva-service-account | ||||||||||||||||||||||||||||||||
| num_cpus: 2 | ||||||||||||||||||||||||||||||||
| memory: 8Gi | ||||||||||||||||||||||||||||||||
| image: rayproject/ray:2.54.0-py312 | ||||||||||||||||||||||||||||||||
| worker_groups: | ||||||||||||||||||||||||||||||||
| - name: cpu | ||||||||||||||||||||||||||||||||
| service_account: geneva-service-account | ||||||||||||||||||||||||||||||||
| num_cpus: 4 | ||||||||||||||||||||||||||||||||
| memory: 8Gi | ||||||||||||||||||||||||||||||||
| replicas: 2 | ||||||||||||||||||||||||||||||||
| min_replicas: 0 | ||||||||||||||||||||||||||||||||
| max_replicas: 4 | ||||||||||||||||||||||||||||||||
| idle_timeout_seconds: 60 | ||||||||||||||||||||||||||||||||
| node_selector: | ||||||||||||||||||||||||||||||||
| geneva.lancedb.com/ray-worker-cpu: "true" | ||||||||||||||||||||||||||||||||
| image: rayproject/ray:2.54.0-py312 | ||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ### Use an external Ray cluster | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| Self-managed enterprise customers can bring an existing Ray cluster to run Geneva jobs. Simply set the rayclusterUri property in the Helm chart | ||||||||||||||||||||||||||||||||
| to a Ray address that can be accessed from the LanceDB Enterprise deployment. | ||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||
| ```yaml | ||||||||||||||||||||||||||||||||
| global: | ||||||||||||||||||||||||||||||||
| rayclusterUri: "ray://my-ray-cluster.my-ns.svc.cluster.local:10001" | ||||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm kind of confused how this interacts with the previous section. Like, "I just said what the default cluster was in the deployment-default bit above - now why do I have to set up raycluster: and global:?"
(I mean, I know this as an experienced user, but it still made me double take, which makes me think that it might be confusing to a new user.)
I guess the point to make is something like "
geneva.defaultstells your jobs what cluster to use. But we assume you don't already have a Ray cluster, so you have to deploy one there; here's how you do that."