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.

Sign up for GitHub

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

Jump to bottom

Improve README documentation #156

Merged
merged 4 commits into from
Apr 16, 2021
Merged

Improve README documentation #156

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e4ba768
Add DefaultAzureIdentity support for blob snapshot
Arkatufus Apr 14, 2021
5d775c4
Add documentation.
Arkatufus Apr 14, 2021
43e15c9
Add documentation on development mode, auto-initialize, and public ac…
Arkatufus Apr 15, 2021
9bf044e
Merge branch 'dev' into Azure.Identity_Add_DefaultAzureIdentity_support
Arkatufus Apr 15, 2021
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
31 changes: 29 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,36 @@ akka.persistence.snapshot-store.azure-blob-store.connection-string = "Your Azure
akka.persistence.snapshot-store.azure-blob-store.container-name = "Your container name"
```

### Configuring snapshots Blob Storage using DefaultAzureCredential
### Local development mode
You can turn local development mode by changing these two settings:
```
akka.persistence.journal.azure-table.development = on
akka.persistence.snapshot-store.azure-blob-store.development = on
```
When set, the plugin will ignore the `connection-string` setting and uses the Azure Storage Emulator default connection string of "UseDevelopmentStorage=true" instead.

### Configuring snapshots Blob Storage

#### Auto-initialize blob container

Blob container auto-initialize behaviour can be changed by changing this flag setting:
```
# Creates the required container if set
akka.persistence.snapshot-store.azure-blob-store.auto-initialize = on
```

#### Container public access type

Auto-initialized blob container public access type can be controlled by changing this setting:
```
# Public access level for the auto-initialized storage container.
# Valid values are "None", "BlobContainer" or "Blob"
akka.persistence.snapshot-store.azure-blob-store.container-public-access-type = "None"
```

#### DefaultAzureCredential

You can use `Azure.Identity` `DefaultAzureCredential` to configure the resource by using `AzureBlobSnapshotSetup`. When using `DefaultAzureCredential`, the HOCON 'connection-string' setting is ignored.
`Azure.Identity` `DefaultAzureCredential` can be used to configure the resource by using `AzureBlobSnapshotSetup`. When using `DefaultAzureCredential`, the HOCON 'connection-string' setting is ignored.

Example:
```
Expand Down