Skip to content

Commit f4f85bc

Browse files
authored
CLI doc update for auth_options (#76)
1 parent c409095 commit f4f85bc

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

self-testing-partner-cli/README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ The CLI uses Maven to create an executable Jar file.
6262
3. Run the jar with your specified subcommand and args. (e.g. `java -jar target/self-testing-partner-cli.jar create -f ./sampleConfig.json`)
6363

6464
### Config Specifications
65-
All fields but `delete_url` and `supported_features` are required.
65+
All fields but `delete_url`, `supported_features` and `auth_options` are required.
6666

6767
#### Example
6868
```
@@ -75,9 +75,10 @@ All fields but `delete_url` and `supported_features` are required.
7575
"delete_url": "https://databricks.com/delete"
7676
"terms_of_service_url": "https://databricks.com/tos",
7777
"privacy_policy_url": "https://databricks.com/privacy",
78-
"hostname": "databricks.com",
78+
"hostnames": "databricks1.com,databricks2.com",
7979
"supported_features": ["UNITY_CATALOG"],
80-
"integration_type": "WAREHOUSE_READ"
80+
"integration_type": "WAREHOUSE_READ",
81+
"auth_options": ["AUTH_OAUTH_M2M"]
8182
}
8283
}
8384
```
@@ -88,6 +89,9 @@ All fields but `delete_url` and `supported_features` are required.
8889

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

92+
### Hostnames
93+
`hostnames` is a comma separated string, represent the list of hostnames that will used in the redirected urls.
94+
9195
### Supported Features
9296
`supported_features` is an array containing any of `[UNITY_CATALOG, NON_ADMIN, EXTERNAL_LOCATION]` and can be empty.
9397
`EXTERNAL_LOCATION` only applies to partners who are writing data to Databricks.
@@ -109,6 +113,13 @@ Use the below table to determine the integration type for the self-testing partn
109113
| 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**. |
110114
| 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. |
111115

116+
### Auth Options
117+
`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.
118+
119+
More auth options are planned to be added in the future.
120+
121+
`AUTH_OAUTH_M2M` and `AUTH_PAT` are mutually exclusive. They cannot be both present at the same time.
122+
112123
## Usage
113124
`java -jar target/self-testing-partner-cli.jar [subcommand] [flags]`
114125

self-testing-partner-cli/sampleConfig.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
"privacy_policy_url": "http://localhost/privacy",
99
"hostname": "localhost",
1010
"supported_features": ["UNITY_CATALOG"],
11-
"integration_type": "WAREHOUSE_READ"
11+
"integration_type": "WAREHOUSE_READ",
12+
"auth_options": ["AUTH_OAUTH_M2M"]
1213
}
1314
}

0 commit comments

Comments
 (0)