-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Start azure docs for flex #67618
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.
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
base: master
Are you sure you want to change the base?
Start azure docs for flex #67618
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||
---|---|---|---|---|---|---|---|---|
|
@@ -58,6 +58,15 @@ For a production-ready deployment of self-managed data planes, you require the f | |||||||
| External Secrets Manager | [Amazon Secrets Manager](/platform/operator-guides/configuring-airbyte#secrets) for storing connector secrets, using a dedicated Airbyte role using a [policy with all required permissions](/platform/enterprise-setup/implementation-guide#aws-secret-manager-policy). | | ||||||||
| Object Storage (Optional)| Amazon S3 bucket with a directory for log storage. | | ||||||||
|
||||||||
</TabItem> | ||||||||
<TabItem value="Azure" label="Azure" default> | ||||||||
|
||||||||
| Component | Recommendation | | ||||||||
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||||||||
| Kubernetes Cluster | Azure Kubernetes Service cluster running in [2 or more availability zones](https://learn.microsoft.com/en-us/azure/aks/reliability-zone-resiliency-recommendations). | | ||||||||
| External Secrets Manager | [Azure Key Vault](/platform/operator-guides/configuring-airbyte#secrets) for storing connector secrets, using a dedicated Airbyte role using a [policy with all required permissions](/platform/enterprise-setup/implementation-guide#azure-key-vault-policy). | | ||||||||
| Object Storage (Optional)| Azure Blob Storage with a directory for log storage. | | ||||||||
|
||||||||
</TabItem> | ||||||||
</Tabs> | ||||||||
|
||||||||
|
@@ -253,6 +262,38 @@ kubectl create secret generic airbyte-config-secrets \ | |||||||
``` | ||||||||
|
||||||||
</TabItem> | ||||||||
|
||||||||
<TabItem value="Azure" label="Azure" default> | ||||||||
|
||||||||
```yaml title="values.yaml" | ||||||||
airbyteUrl: https://cloud.airbyte.com # Base URL for the control plane so Airbyte knows where to authenticate | ||||||||
|
||||||||
dataPlane: | ||||||||
# Used to render the data plane creds secret into the Helm chart. | ||||||||
secretName: airbyte-config-secrets | ||||||||
id: "preview-data-plane" | ||||||||
|
||||||||
# Describe secret name and key where each of the client ID and secret are stored | ||||||||
clientIdSecretName: airbyte-config-secrets | ||||||||
clientIdSecretKey: DATA_PLANE_CLIENT_ID | ||||||||
clientSecretSecretName: airbyte-config-secrets | ||||||||
clientSecretSecretKey: DATA_PLANE_CLIENT_SECRET | ||||||||
|
||||||||
# Secret manager secrets/config | ||||||||
# Must be set to the same secrets manager as the control plane | ||||||||
secretsManager: | ||||||||
secretName: airbyte-config-secrets | ||||||||
type: AZURE_KEY_VAULT | ||||||||
azureKeyVault: | ||||||||
vaultUrl: ## https://my-vault.vault.azure.net/ | ||||||||
tenantId: ## 3fc863e9-4740-4871-bdd4-456903a04d4e | ||||||||
clientId: "" | ||||||||
clientIdSecretKey: "" | ||||||||
clientSecret: "" | ||||||||
clientSecretSecretKey: "" | ||||||||
``` | ||||||||
</TabItem> | ||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint-fix] reported by reviewdog πΆ
Suggested change
|
||||||||
|
||||||||
</Tabs> | ||||||||
</details> | ||||||||
|
||||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -1245,3 +1245,43 @@ The [following policies](https://docs.aws.amazon.com/AmazonS3/latest/userguide/e | |||||
] | ||||||
} | ||||||
``` | ||||||
|
||||||
## Azure Policies Appendix | ||||||
|
||||||
### Azure Key Vault Policy | ||||||
|
||||||
Airbyte requires the ability to write and read secrets in an Azure Key Vault. The built-in role that supports this is the Key Vault Secrets Officer role, whose JSON configuration can be viewed below to understand the specific permissions needed. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint] reported by reviewdog πΆ There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. [markdownlint-fix] reported by reviewdog πΆ
Suggested change
|
||||||
|
||||||
```yaml | ||||||
{ | ||||||
"id": "/providers/Microsoft.Authorization/roleDefinitions/b86a8fe4-44ce-4948-aee5-eccb2c155cd7", | ||||||
"properties": { | ||||||
"roleName": "Key Vault Secrets Officer", | ||||||
"description": "Perform any action on the secrets of a key vault, except manage permissions. Only works for key vaults that use the 'Azure role-based access control' permission model.", | ||||||
"assignableScopes": [ | ||||||
"/" | ||||||
], | ||||||
"permissions": [ | ||||||
{ | ||||||
"actions": [ | ||||||
"Microsoft.Authorization/*/read", | ||||||
"Microsoft.Insights/alertRules/*", | ||||||
"Microsoft.Resources/deployments/*", | ||||||
"Microsoft.Resources/subscriptions/resourceGroups/read", | ||||||
"Microsoft.Support/*", | ||||||
"Microsoft.KeyVault/checkNameAvailability/read", | ||||||
"Microsoft.KeyVault/deletedVaults/read", | ||||||
"Microsoft.KeyVault/locations/*/read", | ||||||
"Microsoft.KeyVault/vaults/*/read", | ||||||
"Microsoft.KeyVault/operations/read" | ||||||
], | ||||||
"notActions": [], | ||||||
"dataActions": [ | ||||||
"Microsoft.KeyVault/vaults/secrets/*" | ||||||
], | ||||||
"notDataActions": [] | ||||||
} | ||||||
] | ||||||
} | ||||||
} | ||||||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[markdownlint] reported by reviewdog πΆ
MD031/blanks-around-fences Fenced code blocks should be surrounded by blank lines [Context: "```"]