diff --git a/docs/docs.json b/docs/docs.json index bcf8a66..4650249 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -167,6 +167,7 @@ "geneva/jobs/startup", "geneva/jobs/materialized-views", "geneva/jobs/contexts", + "geneva/jobs/console", "geneva/jobs/performance" ] }, diff --git a/docs/geneva/index.mdx b/docs/geneva/index.mdx index 7ae39b6..57a80c9 100644 --- a/docs/geneva/index.mdx +++ b/docs/geneva/index.mdx @@ -50,6 +50,6 @@ You can build your Python feature generator function in an IDE or a notebook usi Visit the following pages to learn more about featuring engineering in LanceDB Enterprise: - **Overview**: [What is Feature Engineering?](/geneva/overview/) -- **UDFs**: [Using UDFs](/geneva/udfs/) · [Blob helpers](/geneva/udfs/blobs/) -- **Jobs**: [Execution contexts](/geneva/jobs/contexts/) · [Startup optimizations](/geneva/jobs/startup/) · [Materialized views](/geneva/jobs/materialized-views/) · [Backfilling](/geneva/jobs/backfilling/) · [Performance](/geneva/jobs/performance/) -- **Deployment**: [Deployment overview](/geneva/deployment/) · [Troubleshooting](/geneva/deployment/troubleshooting/) \ No newline at end of file +- **UDFs**: [Using UDFs](/geneva/udfs/) · [Blob helpers](/geneva/udfs/blobs/) · [Error handling](/geneva/udfs/error_handling) · [Advanced configuration](/geneva/udfs/advanced-configuration) +- **Jobs**: [Backfilling](/geneva/jobs/backfilling/) · [Startup optimizations](/geneva/jobs/startup/) · [Materialized views](/geneva/jobs/materialized-views/) · [Execution contexts](/geneva/jobs/contexts/) · [Geneva console](/geneva/jobs/console) · [Performance](/geneva/jobs/performance/) +- **Deployment**: [Deployment overview](/geneva/deployment/) · [Helm deployment](/geneva/deployment/helm/) · [Troubleshooting](/geneva/deployment/troubleshooting/) \ No newline at end of file diff --git a/docs/geneva/jobs/console.mdx b/docs/geneva/jobs/console.mdx new file mode 100644 index 0000000..ceb3071 --- /dev/null +++ b/docs/geneva/jobs/console.mdx @@ -0,0 +1,52 @@ +--- +title: Geneva Console +sidebarTitle: Console +description: +icon: computer +--- + +The Geneva Console provides a web-based interface for monitoring and managing Geneva jobs, clusters, and manifests. + +![geneva-console](/static/assets/images/geneva/console_screenshot.png) + +## Why a Geneva Console? + +- Collaboration: The console helps multiple people work together. Individual jobs can be run in a notebook or workflow, but to collaborate on jobs, it helps to be able to see everything that's running on a given database. +- History: See what has run in the past and diagnose any problems with your jobs. +- Shared resources: The console stores definitions of clusters and manifests, so you can easily tell what resources you want to use to run your job. + +## Getting Started + +The Geneva console is installed with the Geneva Helm chart; [contact LanceDB](https://lancedb.com/contact/) for access to the Helm chart). + + +1. Install or upgrade the Geneva Helm chart (see [Helm Deployment](/geneva/deployment/helm/)). +2. Find the pod that's running the console: +```bash +kubectl get pods -l app.kubernetes.io/name=geneva-console -n $NAMESPACE + +NAME READY STATUS RESTARTS AGE +geneva-console-abc123-abcde 2/2 Running 0 4m58s +``` +3. Forward port 3000 to access the console: +```bash +kubectl port-forward -n $NAMESPACE geneva-console-abc123-abcde 3000:3000 +``` +4. Open `http://localhost:3000` in your browser. When prompted, enter your bucket and database, like: +``` +s3://my-bucket/my-db +``` + +## What's in the Console? + +### Jobs Overview +The heart of the console is an overview of all jobs that are running on a given database. See each job's status, progress, timing, and initiator. + +### Job Details +Click on a job's ID to get more details, especially events that have happened in a job's life cycle, and metrics such as number of workers, rows, and fragments written. + +### Clusters +See the Geneva clusters that you have defined to run jobs. Because clusters can be reused by name, this view can help you run a new job with the same resource constraints as a previous job. + +### Manifests +See the Manifests you've defined and what packages/dependencies they contain. As with clusters, manifests are reusable, so it's easy to start a new job with the same dependencies as an old one by just specifying the manifest name. \ No newline at end of file diff --git a/docs/geneva/jobs/index.mdx b/docs/geneva/jobs/index.mdx index f43e560..4ea5907 100644 --- a/docs/geneva/jobs/index.mdx +++ b/docs/geneva/jobs/index.mdx @@ -22,6 +22,9 @@ Optimize job and session startup times for faster interactive development and pr ### [Execution Contexts](/geneva/jobs/contexts/) Understand how Geneva automatically packages and deploys your Python execution environment to worker nodes for distributed execution using Ray. +### [Geneva Console](/geneva/jobs/console/) +Set up and access the Geneva Console for monitoring and managing Geneva jobs, clusters, and execution contexts. + ## Key Features - **Distributed Processing**: Scale feature computation across multiple nodes diff --git a/docs/static/assets/images/geneva/console_screenshot.png b/docs/static/assets/images/geneva/console_screenshot.png new file mode 100644 index 0000000..16d595d Binary files /dev/null and b/docs/static/assets/images/geneva/console_screenshot.png differ