Skip to content

Commit 67d8eb4

Browse files
Fix documentation. (databricks#116)
Update setup instructions for AWS, Azure, and GCP
1 parent 72a66a1 commit 67d8eb4

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

docs/setup/aws.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,11 @@ The first step is to create a Service Principal in Databricks. This will allow S
2222
- Go to the [Account Console](https://accounts.cloud.databricks.com)
2323
- On the left side bar menu, click on `User management`
2424
- Select `Service Principal` and then `Add service principal`
25+
- Type a new name for the service principal.
2526
- The Service Principal must be granted the `Account Admin` role. This role provides the ability to manage account-level settings and permissions.
2627
- Assign the Workspace Admin Role: The Service Principal must be assigned the `Workspace Admin` role for each workspace it will manage. This role provides the ability to manage workspace-level settings and permissions.
2728
- Add to the Metastore Admin Group: The Service Principal must be added to the `Metastore Admin` group or role. This role provides the ability to manage metastore-level settings and permissions.
28-
- Type a new name for the service principal and then create a new OAuth Secret.
29+
- Create a new OAuth Secret.
2930
- Save the `Secret` and `Client ID`
3031
- To deploy SAT in a workspace, you must add the Service Principal to the workspace.
3132

@@ -50,6 +51,8 @@ To execute SAT follow this steps:
5051
git clone https://github.com/databricks-industry-solutions/security-analysis-tool.git
5152
```
5253

54+
> Remember that the target workspace should have a [profile](https://docs.gcp.databricks.com/en/dev-tools/cli/profiles.html) in [Databricks CLI](https://docs.gcp.databricks.com/en/dev-tools/cli/tutorial.html)
55+
5356
- Run the `install.sh` script on your terminal.
5457

5558
> To ensure that the install.sh script is executable, you need to modify its permissions using the chmod command.
@@ -61,8 +64,6 @@ To execute SAT follow this steps:
6164

6265
![](../gif/terminal-aws.gif)
6366

64-
> Remember that the target workspace should have a [profile](https://docs.databricks.com/en/dev-tools/cli/profiles.html) in [Databricks CLI](https://docs.databricks.com/en/dev-tools/cli/index.html)
65-
6667
Congratulations! 🎉 You are now ready to start using SAT. Please click [here](../setup.md#usage) for a detailed description on how to run and use it.
6768

6869
## Troubleshooting

docs/setup/azure.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ After creating the App Registration and client secret, you will need to add the
4646
- Go to the [Account Console](https://accounts.azuredatabricks.net/)
4747
- On the left side bar menu, click on `User management`
4848
- Select `Service Principal` and then `Add service principal`
49-
- Paste the App Client ID and App Client Secret in the respective fields.
49+
- Select `Microsoft Entra ID Managed Application` as the service principal type.
50+
- Paste the App Client ID and create a new name for the service principal.
5051
- Click Add.
5152
- The Service Principal must be granted the `Account Admin` role. This role provides the ability to manage account-level settings and permissions.
5253
- Assign the Workspace Admin Role: The Service Principal must be assigned the `Workspace Admin` role for each workspace it will manage. This role provides the ability to manage workspace-level settings and permissions.
@@ -78,6 +79,8 @@ To execute SAT follow this steps:
7879
git clone https://github.com/databricks-industry-solutions/security-analysis-tool.git
7980
```
8081

82+
> Remember that the target workspace should have a [profile](https://docs.gcp.databricks.com/en/dev-tools/cli/profiles.html) in [Databricks CLI](https://docs.gcp.databricks.com/en/dev-tools/cli/tutorial.html)
83+
8184
- Run the `install.sh` script on your terminal.
8285

8386
> To ensure that the install.sh script is executable, you need to modify its permissions using the chmod command.
@@ -88,8 +91,6 @@ To execute SAT follow this steps:
8891

8992
![](../gif/terminal-azure.gif)
9093

91-
> Remember the target workspace should have a [profile](https://learn.microsoft.com/en-us/azure/databricks/dev-tools/cli/profiles) in [Databricks CLI](https://learn.microsoft.com/en-us/azure/databricks/dev-tools/cli/)
92-
9394
Congratulations! 🎉 You are now ready to start using SAT. Please click [here](../setup.md#usage) for a detailed description on how to run and use it.
9495

9596

docs/setup/gcp.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ The first step is to create a Service Principal in GCP. This will allow SAT to a
3131

3232
### Credentials Needed
3333

34-
To setup SAT on Azure, you will need the following credentials:
34+
To setup SAT on GCP, you will need the following credentials:
35+
3536
- Databricks Account ID
3637
- Service Account email
3738
- gsutil URI from GCS Bucket
@@ -52,18 +53,15 @@ To execute SAT follow this steps:
5253
> chmod +x install.sh
5354
>```
5455
56+
> Remember that the target workspace should have a [profile](https://docs.gcp.databricks.com/en/dev-tools/cli/profiles.html) in [Databricks CLI](https://docs.gcp.databricks.com/en/dev-tools/cli/tutorial.html)
5557
5658
- Run the `install.sh` script on your terminal.
5759
58-
59-
6060
![](../gif/terminal-gcp.gif)
6161
62-
> Remember that the target workspace should have a [profile](https://docs.gcp.databricks.com/en/dev-tools/cli/profiles.html) in [Databricks CLI](https://docs.gcp.databricks.com/en/dev-tools/cli/tutorial.html)
63-
6462
Congratulations! 🎉 You are now ready to start using SAT. Please click [here](../setup.md#usage) for a detailed description on how to run and use it.
6563
6664
6765
## Troubleshooting
6866
Please review the FAQs and Troubleshooting resources documented [here](./faqs_and_troubleshooting.md) including a notebook to help diagnose your SAT setup.
69-
If any issues arise during the installation process, please check your credentials and ensure that you have the appropriate permissions in your Azure cloud account. If you are still facing issues, please send your feedback and comments to <[email protected]>.
67+
If any issues arise during the installation process, please check your credentials and ensure that you have the appropriate permissions in your GCP cloud account. If you are still facing issues, please send your feedback and comments to <[email protected]>.

0 commit comments

Comments
 (0)