- Getting started
- Host administration
- Organizations
- Authentication and security
- Licensing
- Tenants and services
- Accounts and roles
- External applications
- Testing in your organization
- Notifications
- Logging
- Troubleshooting

Automation Suite admin guide
Setting up encryption key per tenant
linkIt is possible to use Microsoft Azure Key Vault to encrypt each tenant in your Orchestrator instance with its own unique key. Orchestrator uses the Key Vault to store and manage the keys in a safe manner, ensuring better segregation of your data between tenants.
Orchestrator installed in Automation Suite can take advantage of this feature, but you must connect the Orchestrator app to the internet and Azure Key Vault.
Overview
linkOrchestrator authentication is needed to use Azure Key Vault via App Registrations. App Registrations can grant a series of privileges to applications. In our case, Orchestrator is the application, and Azure Key Vault is the targeted privilege.
orchestrator-customconfig
configmap used in the Automation Suite cluster, and modify the relevant ArgoCD parameters for the Orchestrator app form the
ArgoCD UI. Once these criteria are met, Orchestrator can use Azure Key Vault to encrypt each tenant.
Prerequisites
link- Your own Microsoft Azure Key Vault
- A clean Orchestrator installation in Automation Suite
-
A valid SSL certificate:
- Private Key Certificate — It needs to be uploaded in App Services > SSL Settings > Private Key Certificates
- Public Key Certificate — It needs to be uploaded in App registrations > Settings > Keys > Public Keys
- (Optional) A self-signed certificate
To convert the .pfx certificate file to base64, run the following command:
-
PowerShell:
[convert]::ToBase64String((Get-Content -path "path_to_certificate" -Encoding byte))
-
Shell:
base64 [_path_to_certificate_]
App registrations steps
linkIn Azure Portal's App Registrations pane, follow these steps:
- Create a new app registration.
- Copy the Application (Client) ID for later use.
- Go to Manage > Certificates & Secrets and upload the public SSL certificate key mentioned in the prerequisite.
Azure Key Vault steps
linkIn the Azure Key Vault, do the following:
- Access the Key Vaults Overview page and copy the DNS name for later use.
- Go to the Key Vaults page and select Settings > Access policies.
- Select Add access policy.
- From the Configure from template (optional) drop-down menu, select Key, Secret, & Certificate Management.
- Select None selected in the Authorized application section to enable the Select principal field.
- Enter the app registration name, confirm that the Application ID is correct, and select this principal.
- Select Add.
Orchestrator custom configuration steps
linkMake the following configuration changes to Orchestrator:
- Configure Azure Key Vault for Orchestrator Instance from ArgoCD UI Parameters:
- Copy the base64 form of the certificate and provide it as a value for the
encryptionKeyPerTenant.certificateBase64
parameter. - Copy the certificate password, if any, and provide it as a value for the
encryptionKeyPerTenant.certificatePassword
parameter. - Copy the Input Application (Client) ID from the App Registrations page and provide it as a value for the
encryptionKeyPerTenant.clientId
parameter. - Copy the Directory (tenant) ID of your organization from the App Registrations page and provide it as a value for the
encryptionKeyPerTenant.directoryId
parameter. - Copy the DNS Name from the Key Vaults Overview page and provide it as a value for the
encryptionKeyPerTenant.vaultAddress
parameter.
- Copy the base64 form of the certificate and provide it as a value for the
- Update the
orchestrator-customconfig
configmap'sAppSettings
section as follows to enable the encryption key per tenant feature:- Set
EncryptionKeyPerTenant.Enabled
totrue
. - Set
EncryptionKeyPerTenant.KeyProvider
toAzureKeyVault
.This can be done via the orchestrator-configurator.sh or by updating the configmap using Lens.
- Set
- Restart the Orchestrator Automation Suite deployment from the cluster for the changes to take effect.