Skip to content

Commit

Permalink
Add sp credentials to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
steinitzu committed May 16, 2024
1 parent b62f101 commit 69ba366
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/website/docs/dlt-ecosystem/destinations/filesystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,13 @@ Use **Cloud Storage** admin to create a new bucket. Then assign the **Storage Ob
#### Azure Blob Storage
Run `pip install dlt[az]` which will install the `adlfs` package to interface with Azure Blob Storage.

Edit the credentials in `.dlt/secrets.toml`, you'll see AWS credentials by default replace them with your Azure credentials:
Edit the credentials in `.dlt/secrets.toml`, you'll see AWS credentials by default replace them with your Azure credentials.

Two forms of Azure credentials are supported:

##### SAS token credentials

Supply storage account name and either sas token or storage account key

```toml
[destination.filesystem]
Expand All @@ -168,6 +174,20 @@ If you have the correct Azure credentials set up on your machine (e.g. via azure
you can omit both `azure_storage_account_key` and `azure_storage_sas_token` and `dlt` will fall back to the available default.
Note that `azure_storage_account_name` is still required as it can't be inferred from the environment.

##### Service principal credentials

Supply a client ID, client secret and a tenant ID for a service principal authorized to access your container

```toml
[destination.filesystem]
bucket_url = "az://[your_container name]" # replace with your container name

[destination.filesystem.credentials]
azure_client_id = "client_id" # please set me up!
azure_client_secret = "client_secret
azure_tenant_id = "tenant_id" # please set me up!
```

#### Local file system
If for any reason you want to have those files in a local folder, set up the `bucket_url` as follows (you are free to use `config.toml` for that as there are no secrets required)

Expand Down Expand Up @@ -458,4 +478,4 @@ managed in the regular way by the final destination you have configured.
You will also notice `init` files being present in the root folder and the special `dlt` folders. In the absence of the concepts of schemas and tables
in blob storages and directories, `dlt` uses these special files to harmonize the behavior of the `filesystem` destination with the other implemented destinations.

<!--@@@DLT_TUBA filesystem-->
<!--@@@DLT_TUBA filesystem-->

0 comments on commit 69ba366

Please sign in to comment.