Skip to content
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

CLI doc update for auth_options #76

Merged
merged 1 commit into from
Oct 25, 2024
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
17 changes: 14 additions & 3 deletions self-testing-partner-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The CLI uses Maven to create an executable Jar file.
3. Run the jar with your specified subcommand and args. (e.g. `java -jar target/self-testing-partner-cli.jar create -f ./sampleConfig.json`)

### Config Specifications
All fields but `delete_url` and `supported_features` are required.
All fields but `delete_url`, `supported_features` and `auth_options` are required.

#### Example
```
Expand All @@ -75,9 +75,10 @@ All fields but `delete_url` and `supported_features` are required.
"delete_url": "https://databricks.com/delete"
"terms_of_service_url": "https://databricks.com/tos",
"privacy_policy_url": "https://databricks.com/privacy",
"hostname": "databricks.com",
"hostnames": "databricks1.com,databricks2.com",
"supported_features": ["UNITY_CATALOG"],
"integration_type": "WAREHOUSE_READ"
"integration_type": "WAREHOUSE_READ",
"auth_options": ["AUTH_OAUTH_M2M"]
}
}
```
Expand All @@ -88,6 +89,9 @@ All fields but `delete_url` and `supported_features` are required.

The category controls where the tile appears on the Partner Connect page.

### Hostnames
`hostnames` is a comma separated string, represent the list of hostnames that will used in the redirected urls.

### Supported Features
`supported_features` is an array containing any of `[UNITY_CATALOG, NON_ADMIN, EXTERNAL_LOCATION]` and can be empty.
`EXTERNAL_LOCATION` only applies to partners who are writing data to Databricks.
Expand All @@ -109,6 +113,13 @@ Use the below table to determine the integration type for the self-testing partn
| WAREHOUSE_WRITE | Used by partners that only need to write (ingest) data into the Lakehouse.<br/>In Partner Connect, the user selects which catalog to grant write access to your product.<br/>Databricks provides the partner a SQL Warehouse and PAT with permissions to create schemas and tables in that catalog.<br/>This is often used by **Ingestion partners**. |
| WORKSPACE_MANAGEMENT | Used by partners that need to create clusters and jobs.<br/>Databricks provides the partner with a PAT which can be used to call Databricks REST APIs on clusters in the workspace.<br/>This does not give the partner access to Databricks SQL warehouses. |

### Auth Options
`auth_options` is an array containing one of `[AUTH_OAUTH_M2M, AUTH_PAT]` or can be empty. When absent or empty, `AUTH_PAT` will be used.

More auth options are planned to be added in the future.

`AUTH_OAUTH_M2M` and `AUTH_PAT` are mutually exclusive. They cannot be both present at the same time.

## Usage
`java -jar target/self-testing-partner-cli.jar [subcommand] [flags]`

Expand Down
3 changes: 2 additions & 1 deletion self-testing-partner-cli/sampleConfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
"privacy_policy_url": "http://localhost/privacy",
"hostname": "localhost",
"supported_features": ["UNITY_CATALOG"],
"integration_type": "WAREHOUSE_READ"
"integration_type": "WAREHOUSE_READ",
"auth_options": ["AUTH_OAUTH_M2M"]
}
}
Loading