docs: update docs with information on azure blob storage

Cornerstone-OnDemand · Dec 9, 2021 · f9e4d61 · f9e4d61
1 parent d45aa20
commit f9e4d61
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 2 deletions.
diff --git a/docs/assets/environment.md b/docs/assets/environment.md
@@ -10,7 +10,7 @@ The parameters necessary to instantiate an `AssetsManager` can all be read from
 
 | Environment variable | Default value | Parameter | Notes |
 | --- | --- | --- | --- |
-| `MODELKIT_STORAGE_PROVIDER` | `gcs` | `storage_provider` | `gcs` (default), `s3` or `local` |
+| `MODELKIT_STORAGE_PROVIDER` | `gcs` | `storage_provider` | `gcs` (default), `s3`, `az` or `local` |
 | `MODELKIT_STORAGE_BUCKET` | None | `bucket` | Bucket in which data is stored |
 | `MODELKIT_STORAGE_PREFIX` | `modelkit-assets` | `prefix` | Objects prefix |
 | `MODELKIT_STORAGE_TIMEOUT_S` | `300` | `timeout_s` | max time when retrying storage downloads |

diff --git a/docs/assets/storage_provider.md b/docs/assets/storage_provider.md
@@ -65,6 +65,18 @@ By default, the GCS client use the credentials setup up on the machine.
 
 If `GOOGLE_APPLICATION_CREDENTIALS` is provided, it should point to a local JSON service account file, which we use to instantiate the client with `google.cloud.storage.Client.from_service_account_json`
 
+### Using Azure blob storage
+
+Use `STORAGE_PROVIDER=az` to connect to Azure blob storage.
+
+We use [azure-storage-blobl](https://docs.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-python) under the hood.
+
+The client is created by passing the authentication information to `BlobServiceClient.from_connection_string`:
+
+| Environment variable    | Note   |
+| ----------------------- | ----------------------- |
+| `AZURE_STORAGE_CONNECTION_STRING`     | azure connection string     |
+
 
 ### `local` mode
 

diff --git a/docs/assets/store_organization.md b/docs/assets/store_organization.md
@@ -12,7 +12,7 @@ Remote assets are stored in object stores, referenced as:
 
 In this "path":
 
-- `provider` is `s3` or `gcs` or `file` depending on the storage driver (value of `MODELKIT_STORAGE_PROVIDER`)
+- `provider` is `s3`, `azfs` or `gcs` or `file` depending on the storage driver (value of `MODELKIT_STORAGE_PROVIDER`)
 - `bucket` is the remote container name (`MODELKIT_STORAGE_BUCKET`)
 
 The rest of the "path" is the remote object's name and consists of

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -31,6 +31,7 @@ These variables are necessary to set a remote storage from which to retrieve ass
       pointing to a service account credentials JSON file (this is not necessary on dev
       machines)
     - for `MODELKIT_STORAGE_PROVIDER=s3`, you need to instantiate `AWS_PROFILE`
+    - for `MODELKIT_STORAGE_PROVIDER=az`, you need to instantiate `AZURE_STORAGE_CONNECTION_STRING` with a connection string
 
 ### Assets versioning related environment variable