docs: Document Azure environment variables #6084
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The Azure environment variables were not documented. This PR adds them to the documentation pages. Signed-off-by: adamrtalbot <12817534+adamrtalbot@users.noreply.github.com>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
adamrtalbot
changed the title
christopher-hakkaart
requested changes
May 16, 2025
Comment on lines
+40
to
+42
| - `AZURE_STORAGE_ACCOUNT_NAME` - The name of your Azure Storage account | ||
| - `AZURE_STORAGE_ACCOUNT_KEY` - The access key for your Azure Storage account | ||
| - `AZURE_STORAGE_SAS_TOKEN` - A shared access signature (SAS) token for Azure Storage access |
There was a problem hiding this comment.
Suggested change
| - `AZURE_STORAGE_ACCOUNT_NAME` - The name of your Azure Storage account | |
| - `AZURE_STORAGE_ACCOUNT_KEY` - The access key for your Azure Storage account | |
| - `AZURE_STORAGE_SAS_TOKEN` - A shared access signature (SAS) token for Azure Storage access | |
| - `AZURE_STORAGE_ACCOUNT_NAME`: The name of your Azure Storage account. | |
| - `AZURE_STORAGE_ACCOUNT_KEY`: The access key for your Azure Storage account. | |
| - `AZURE_STORAGE_SAS_TOKEN`: A shared access signature (SAS) token for Azure Storage access. |
Comment on lines
+169
to
+170
| - `AZURE_BATCH_ACCOUNT_NAME` - The name of your Azure Batch account | ||
| - `AZURE_BATCH_ACCOUNT_KEY` - The access key for your Azure Batch account |
There was a problem hiding this comment.
Suggested change
| - `AZURE_BATCH_ACCOUNT_NAME` - The name of your Azure Batch account | |
| - `AZURE_BATCH_ACCOUNT_KEY` - The access key for your Azure Batch account | |
| - `AZURE_BATCH_ACCOUNT_NAME`: The name of your Azure Batch account. | |
| - `AZURE_BATCH_ACCOUNT_KEY`: The access key for your Azure Batch account. |
| :::{note} | ||
| Nextflow will read the following environment variables if a config item is not provided: | ||
|
|
||
| - `AZURE_MANAGED_IDENTITY_SYSTEM` - When set to "true", enables system-assigned managed identity |
There was a problem hiding this comment.
Suggested change
| - `AZURE_MANAGED_IDENTITY_SYSTEM` - When set to "true", enables system-assigned managed identity | |
| - `AZURE_MANAGED_IDENTITY_SYSTEM`: When set to `true`, enables system-assigned managed identity. |
| :::{note} | ||
| Nextflow will read the following environment variables if a config item is not provided: | ||
|
|
||
| - `AZURE_MANAGED_IDENTITY_USER` - The client ID for a user-assigned managed identity |
There was a problem hiding this comment.
Suggested change
| - `AZURE_MANAGED_IDENTITY_USER` - The client ID for a user-assigned managed identity | |
| - `AZURE_MANAGED_IDENTITY_USER`: The client ID for a user-assigned managed identity. |
Comment on lines
+626
to
+628
| - `AZURE_CLIENT_ID` - The service principal client ID (also known as application ID) | ||
| - `AZURE_CLIENT_SECRET` - The service principal secret key | ||
| - `AZURE_TENANT_ID` - The Azure Active Directory tenant ID |
There was a problem hiding this comment.
Suggested change
| - `AZURE_CLIENT_ID` - The service principal client ID (also known as application ID) | |
| - `AZURE_CLIENT_SECRET` - The service principal secret key | |
| - `AZURE_TENANT_ID` - The Azure Active Directory tenant ID | |
| - `AZURE_CLIENT_ID`: The service principal client ID (also known as application ID). | |
| - `AZURE_CLIENT_SECRET`: The service principal secret key. | |
| - `AZURE_TENANT_ID`: The Azure Active Directory tenant ID. |
| @@ -294,13 +294,13 @@ Read the {ref}`azure-page` page for more information. | |||
| The following settings are available: | |||
|
|
|||
| `azure.activeDirectory.servicePrincipalId` | |||
| : The service principal client ID | |||
| : The service principal client ID (defaults to environment variable `AZURE_CLIENT_ID`) | |||
There was a problem hiding this comment.
Suggested change
| : The service principal client ID (defaults to environment variable `AZURE_CLIENT_ID`) | |
| : The service principal client ID. Defaults to environment variable `AZURE_CLIENT_ID`. |
|
|
||
| `azure.activeDirectory.servicePrincipalSecret` | ||
| : The service principal client secret | ||
| : The service principal client secret (defaults to environment variable `AZURE_CLIENT_SECRET`) |
There was a problem hiding this comment.
Suggested change
| : The service principal client secret (defaults to environment variable `AZURE_CLIENT_SECRET`) | |
| : The service principal client secret. Defaults to environment variable `AZURE_CLIENT_SECRET`. |
|
|
||
| `azure.activeDirectory.tenantId` | ||
| : The Azure tenant ID | ||
| : The Azure tenant ID (defaults to environment variable `AZURE_TENANT_ID`) |
There was a problem hiding this comment.
Suggested change
| : The Azure tenant ID (defaults to environment variable `AZURE_TENANT_ID`) | |
| : The Azure tenant ID. Defaults to environment variable `AZURE_TENANT_ID`. |
| @@ -415,10 +415,10 @@ The following settings are available: | |||
| : Specify the virtual machine type used by the pool identified with `<name>`. | |||
|
|
|||
| `azure.managedIdentity.clientId` | |||
| : Specify the client ID for an Azure [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview). See {ref}`azure-managed-identities` for more details. | |||
| : Specify the client ID for an Azure [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview). See {ref}`azure-managed-identities` for more details. (defaults to environment variable `AZURE_MANAGED_IDENTITY_USER`) | |||
There was a problem hiding this comment.
Suggested change
| : Specify the client ID for an Azure [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview). See {ref}`azure-managed-identities` for more details. (defaults to environment variable `AZURE_MANAGED_IDENTITY_USER`) | |
| : Specify the client ID for an Azure [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview). See {ref}`azure-managed-identities` for more details. Defaults to environment variable `AZURE_MANAGED_IDENTITY_USER`. |
|
|
||
| `azure.managedIdentity.system` | ||
| : When `true`, use the system-assigned [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) to authenticate Azure resources. See {ref}`azure-managed-identities` for more details. | ||
| : When `true`, use the system-assigned [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) to authenticate Azure resources. See {ref}`azure-managed-identities` for more details. (defaults to environment variable `AZURE_MANAGED_IDENTITY_SYSTEM`) |
There was a problem hiding this comment.
Suggested change
| : When `true`, use the system-assigned [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) to authenticate Azure resources. See {ref}`azure-managed-identities` for more details. (defaults to environment variable `AZURE_MANAGED_IDENTITY_SYSTEM`) | |
| : When `true`, uses the system-assigned [managed identity](https://learn.microsoft.com/en-us/entra/identity/managed-identities-azure-resources/overview) to authenticate Azure resources. See {ref}`azure-managed-identities` for more details. Defaults to environment variable `AZURE_MANAGED_IDENTITY_SYSTEM`. |
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Azure environment variables were not documented. This PR adds them to the documentation pages.