Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
docs-action committed Nov 20, 2024
1 parent 4ebda01 commit fc6f3a6
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 1 deletion.
2 changes: 1 addition & 1 deletion assets/js/search-data.json
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
},"19": {
"doc": "CLI Reference",
"title": "CLI Configuration",
"content": "lakefs-databricks can be configured using either a YAML file or environment variables. Configuration file . By default, lakefs-databricks will look for a file named .lakefs-databricks.yaml in your home directory, but the configuration file can be specified by passing the -c (or --config) argument to lakefs-databricks (see below). | AWS | Azure | . unity: url: <unity_url> # Your Databricks workspace URL. e.g. https://dbc-<workspace-id>.cloud.databricks.com token: <unity_token> # The Personal access token you created during the Databricks Workspace preparation lakefs: secret_access_key: <lakefs_secret_access_key> # The secret_access_key you created during lakeFS Cloud setup access_key_id: <lakefs_access_key_id> # The access_key_id you created during lakeFS Cloud setup url: <lakefs_endpoint_url>/api/v1 # The Url of your lakeFS Cloud instance e.g. https://example-org.us-east-1.lakefscloud.io databricks_storage: type: s3 s3: access_key_id: <aws_access_key_id> # the access_key you created on the previous step secret_access_key: <aws_secret_access_key> # the secret_access_key you created on the previous step region: <aws_region> . unity: url: <unity_url> # Your Databricks workspace URL. e.g. https://dbc-<workspace-id>.cloud.databricks.com token: <unity_token> # The Personal access token you created during the Databricks Workspace preparation lakefs: secret_access_key: <lakefs_secret_access_key> # The secret_access_key you created during lakeFS Cloud setup access_key_id: <lakefs_access_key_id> # The access_key_id you created during lakeFS Cloud setup url: <lakefs_endpoint_url>/api/v1 # The Url of your lakeFS Cloud instance e.g. https://example-org.us-east-1.lakefscloud.io databricks_storage: type: azure azure: client_id: <client_id> # The client_id from the lakeFS Cloud Terraform output client_secret: <client_secret> # The client_secret from the lakeFS Cloud Terraform output tenant_id: <tenant_id> # The tenant_id from the lakeFS Cloud Terraform output . Environment variables . | AWS | Azure | . LAKEFS_DATABRICKS_UNITY_URL=<unity_url> LAKEFS_DATABRICKS_UNITY_TOKEN=<unity_token> LAKEFS_DATABRICKS_LAKEFS_URL=<lakefs_installation_url>/api/v1 LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=<lakefs_access_key_id> LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=<lakefs_secret_access_key> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=s3 LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_ACCESS_KEY_ID=<aws_access_key_id> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_SECRET_ACCESS_KEY=<aws_secret_access_key> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_REGION=<aws_region> . LAKEFS_DATABRICKS_UNITY_URL=<unity_url> LAKEFS_DATABRICKS_UNITY_TOKEN=<unity_token> LAKEFS_DATABRICKS_LAKEFS_URL=<lakefs_installation_url>/api/v1 LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=<lakefs_access_key_id> LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=<lakefs_secret_access_key> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=azure LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_ID=<client_id> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_SECRET=<client_secret> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_TENANT_ID=<tenant_id> . ",
"content": "lakefs-databricks can be configured using either a YAML file or environment variables. Configuration file . By default, lakefs-databricks will look for a file named .lakefs-databricks.yaml in your home directory, but the configuration file can be specified by passing the -c (or --config) argument to lakefs-databricks (see below). | AWS | Azure | . unity: url: <unity_url> # Your Databricks workspace URL. e.g. https://dbc-<workspace-id>.cloud.databricks.com token: <unity_token> # The Personal access token you created during the Databricks Workspace preparation lakefs: secret_access_key: <lakefs_secret_access_key> # The secret_access_key you created during lakeFS Cloud setup access_key_id: <lakefs_access_key_id> # The access_key_id you created during lakeFS Cloud setup url: <lakefs_endpoint_url>/api/v1 # The Url of your lakeFS Cloud instance e.g. https://example-org.us-east-1.lakefscloud.io databricks_storage: type: s3 s3: access_key_id: <aws_access_key_id> # the access_key you created on the previous step secret_access_key: <aws_secret_access_key> # the secret_access_key you created on the previous step region: <aws_region> . unity: url: <unity_url> # Your Databricks workspace URL. e.g. https://dbc-<workspace-id>.cloud.databricks.com token: <unity_token> # The Personal access token you created during the Databricks Workspace preparation lakefs: secret_access_key: <lakefs_secret_access_key> # The secret_access_key you created during lakeFS Cloud setup access_key_id: <lakefs_access_key_id> # The access_key_id you created during lakeFS Cloud setup url: <lakefs_endpoint_url>/api/v1 # The Url of your lakeFS Cloud instance e.g. https://example-org.us-east-1.lakefscloud.io databricks_storage: type: azure azure: client_id: <client_id> # The client_id from the lakeFS Cloud Terraform output client_secret: <client_secret> # The client_secret from the lakeFS Cloud Terraform output tenant_id: <tenant_id> # The tenant_id from the lakeFS Cloud Terraform output . Environment variables . | AWS | Azure | . LAKEFS_DATABRICKS_UNITY_URL=<unity_url> LAKEFS_DATABRICKS_UNITY_TOKEN=<unity_token> LAKEFS_DATABRICKS_LAKEFS_URL=<lakefs_installation_url>/api/v1 LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=<lakefs_access_key_id> LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=<lakefs_secret_access_key> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=s3 LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_ACCESS_KEY_ID=<aws_access_key_id> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_SECRET_ACCESS_KEY=<aws_secret_access_key> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_S3_REGION=<aws_region> . LAKEFS_DATABRICKS_UNITY_URL=<unity_url> LAKEFS_DATABRICKS_UNITY_TOKEN=<unity_token> LAKEFS_DATABRICKS_LAKEFS_URL=<lakefs_installation_url>/api/v1 LAKEFS_DATABRICKS_LAKEFS_ACCESS_KEY_ID=<lakefs_access_key_id> LAKEFS_DATABRICKS_LAKEFS_SECRET_ACCESS_KEY=<lakefs_secret_access_key> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_TYPE=azure LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_ID=<client_id> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_CLIENT_SECRET=<client_secret> LAKEFS_DATABRICKS_DATABRICKS_STORAGE_AZURE_TENANT_ID=<tenant_id> . Databricks Environment variables . lakefs-databricks supports standard Databricks environment variables to simplify setup by reusing existing configurations. If these variables are already set for Databricks, lakefs-databricks will automatically use them, reducing redundant configuration. Supported Variables . | DATABRICKS_HOST: Your Databricks workspace URL (e.g., https://dbc-.cloud.databricks.com). Can be overridden by: LAKEFS_DATABRICKS_UNITY_URL or unity.url in the config file. | DATABRICKS_TOKEN: Your Databricks Personal Access Token (PAT). Can be overridden by: LAKEFS_DATABRICKS_UNITY_TOKEN or unity.token in the config file. | . ",
"url": "/cli-reference.html#cli-configuration",

"relUrl": "/cli-reference.html#cli-configuration"
Expand Down
22 changes: 22 additions & 0 deletions cli-reference.html
Original file line number Diff line number Diff line change
Expand Up @@ -547,6 +547,28 @@ <h4 id="environment-variables">
</code></pre></div> </div>
</div>
</div>
<h4 id="databricks-environment-variables">


<a href="#databricks-environment-variables" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Databricks Environment variables


</h4>


<p>lakefs-databricks supports standard Databricks environment variables to simplify setup by reusing existing configurations. If these variables are already set for Databricks, lakefs-databricks will automatically use them, reducing redundant configuration.</p>
<h5 id="supported-variables">


<a href="#supported-variables" class="anchor-heading"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Supported Variables


</h5>

<ul>
<li>DATABRICKS_HOST: Your Databricks workspace URL (e.g., https://dbc-<workspace-id>.cloud.databricks.com). Can be overridden by: LAKEFS_DATABRICKS_UNITY_URL or unity.url in the config file.</workspace-id></li>
<li>DATABRICKS_TOKEN: Your Databricks Personal Access Token (PAT). Can be overridden by: LAKEFS_DATABRICKS_UNITY_TOKEN or unity.token in the config file.</li>
</ul>
<h2 id="command-reference">


Expand Down

0 comments on commit fc6f3a6

Please sign in to comment.