Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The Dremio MCP server can be deployed in two ways:

For production deployments in Kubernetes environments, use the Helm chart:

📦 **[Helm Chart Documentation](helm/dremio-mcp/README.md)**
📦 **[Helm Chart Documentation](helm/dremio-mcp/QUICKSTART.md)**

### Quick Start with Helm

Expand Down Expand Up @@ -144,13 +144,17 @@ The quickest way to do this setup is -
$ uv run dremio-mcp-server config create dremioai \
--uri <dremio uri> \
# the endpoint portion of the URL for your environment
--pat <dremio pat>
--pat <dremio pat> \
# https://docs.dremio.com/current/security/authentication/personal-access-tokens/#using-a-pat
# required for cloud: add your project ID if setting up for dremio cloud
# --project-id <dremio project id>
```

Note: the uri is the API endpoint for your Dremio Software instance:
Note: the uri is api endpoint associated with your environment:

- For Dremio Software deployments use `https://<coordinator-host>:<9047 or custom port>`
- For Dremio cloud based in the US region (https://app.dremio.cloud) use `https://api.dremio.cloud` or use the short hand `prod`
- For Dremio cloud based in the EMEA region (https://app.eu.dremio.cloud) use `https://api.eu.dremio.cloud` or use the short hand `prodemea`
- For SW/K8S deployments use https://<coordinator‑host>:<9047 or custom port>

Note: For security purposes, if you don't want the PAT to leak into your shell history file, create a file with your PAT in it and give it as an argument to the dremio config.

Expand Down Expand Up @@ -222,10 +226,13 @@ This file is located by default at `$HOME/.config/dremioai/config.yaml` but can
#### Format

```yaml
# The dremio section contains the URI to connect and PAT to use
# The dremio section contains 3 main things - the URI to connect, PAT to use
# and optionally the project_id if using with Dremio Cloud
dremio:
uri: https://.... # the Dremio Software URI
uri: https://.... # the Dremio URI
pat: "@~/ws/tokens/idl.token" # PAT can be put in a file and used here with @ prefix
project_id: <string> Project ID required for Dremio Cloud
enable_search: <bool> # Optional: Enable semantic search
allow_dml: <bool> # Optional: Allow MCP Server to create views in Dremio
tools:
server_mode: FOR_DATA_PATTERNS # the serverm
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/examples/values-production.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

# Production deployment with OAuth + External Token Provider authentication
# This is the RECOMMENDED configuration for production deployments
#
Expand Down
5 changes: 4 additions & 1 deletion helm/dremio-mcp/examples/values-with-existing-secret.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

# Example values using an existing Kubernetes secret for PAT
#
# This approach is useful when:
# - You manage secrets separately (e.g., with external-secrets, sealed-secrets, Vault)
# - You want to avoid storing PAT in values files
# - You're using GitOps and want to keep secrets out of Git
#
# Prerequisites:
# 1. Create a secret with your PAT:
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/examples/values-with-pat.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

# Example values for development/testing with Personal Access Token (PAT)
#
# WARNING: PAT authentication is NOT recommended for production use
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/configmap.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

apiVersion: v1
kind: ConfigMap
metadata:
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/deployment.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

apiVersion: apps/v1
kind: Deployment
metadata:
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/hpa.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

{{- if .Values.autoscaling.enabled }}
apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/ingress.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

{{- if .Values.ingress.enabled -}}
{{- $fullName := include "dremio-mcp.fullname" . -}}
{{- $svcPort := .Values.service.port -}}
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/secret.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

{{- if and .Values.dremio.pat (not .Values.dremio.existingSecret) }}
apiVersion: v1
kind: Secret
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/service.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

apiVersion: v1
kind: Service
metadata:
Expand Down
4 changes: 4 additions & 0 deletions helm/dremio-mcp/templates/serviceaccount.yaml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#

{{- if .Values.serviceAccount.create -}}
apiVersion: v1
kind: ServiceAccount
Expand Down
12 changes: 5 additions & 7 deletions helm/dremio-mcp/values.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
#
# Copyright (C) 2017-2019 Dremio Corporation. This file is confidential and private property.
#


# Default values for dremio-mcp.
# This is a YAML-formatted file.
# Declare variables to be passed into your templates.

replicaCount: 1

Expand All @@ -25,11 +28,6 @@ dremio:
# See AUTHENTICATION.md for production setup
pat: ""

# Optional: Use an existing secret for PAT
# The secret should have a key named 'pat'
# If set, this takes precedence over dremio.pat
existingSecret: ""

# Optional: Allow DML operations (create views, etc.)
allowDml: false

Expand Down