From 05f76c4aec995d884cd990520ee6b94b87ce0686 Mon Sep 17 00:00:00 2001 From: Rakshanda Bhat Date: Thu, 30 Apr 2026 16:27:14 +0530 Subject: [PATCH 1/2] CP-13245 Add azure vault support in developer.delphix.com --- docs/docs/References/Schemas.md | 57 +++++++++++++++++++++++++++++++-- 1 file changed, 54 insertions(+), 3 deletions(-) diff --git a/docs/docs/References/Schemas.md b/docs/docs/References/Schemas.md index 745d867f..acbc1024 100644 --- a/docs/docs/References/Schemas.md +++ b/docs/docs/References/Schemas.md @@ -434,7 +434,7 @@ An example of a JSON schema using this type is: ``` where `credentialsSupplier` is a definition in the external schema `https://delphix.com/platform/api`. -When providing data for a property of this type, the user has the following four options. +When providing data for a property of this type, the user has the following five options. ##### Option 1: Username and password @@ -610,13 +610,64 @@ For example, the user, or the user interface on behalf of the user, can provide: } ``` +##### Option 5: Azure Vault credentials + +For this option, the user must provide data that satisfies this definition: +```json +{ + "type": "object", + "required": ["type", "vault", "azureVaultName", "usernameKey", "secretKey"], + "properties": { + "type": { + "type": "string", + "const": "AzureVaultCredential" + }, + "vault": { + "type": "string", + "format": "reference", + "referenceType": "AzureVault" + }, + "azureVaultName": { + "type": "string" + }, + "usernameKey": { + "type": "string" + }, + "secretKey": { + "type": "string" + }, + "expectedSecretType": { + "type": "string", + "enum": ["any", "password", "keyPair"], + "default": "any" + } + } +} +``` +where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to an Azure Vault configured in the system, and `azureVaultName`, `usernameKey` and `secretKey` are parameters for locating the credentials in the vault. For details on configuring and using Azure vaults, see the [password-vaults documentation for the Delphix engine](https://cd.delphix.com/docs/latest/password-vault-support). + +Optionally, `expectedSecretType` lets the user constrain the secret returned by the vault to passwords or keys (the default is to allow `any` of those two types of secret). An unexpected type of secret returned by the vault will result in a runtime exception. + +For example, the user, or the user interface on behalf of the user, can provide: +```json +"properties": { + "myCredentials": { + "type": "AzureVaultCredential", + "vault": "AZURE_VAULT-1", + "azureVaultName": "my-azure-vault", + "usernameKey": "username", + "secretKey": "password" + } +} +``` + #### `keyCredentialsSupplier` -This object type is identical to `credentialsSupplier` but requires the secrets to be keys. The available options are [keys](#option-2-username-and-keys), [CyberArk vaults](#option-3-cyberark-vault-credentials) and [HashiCorp vaults](#option-4-hashicorp-vault-credentials). The property `expectedSecretType` is required in all cases and must have the value `keyPair`. +This object type is identical to `credentialsSupplier` but requires the secrets to be keys. The available options are [keys](#option-2-username-and-keys), [CyberArk vaults](#option-3-cyberark-vault-credentials), [HashiCorp vaults](#option-4-hashicorp-vault-credentials) and [Azure vaults](#option-5-azure-vault-credentials). The property `expectedSecretType` is required in all cases and must have the value `keyPair`. #### `passwordCredentialsSupplier` -This object type is identical to `credentialsSupplier` but requires the secrets to be passwords. The available options are [passwords](#option-1-username-and-password), [CyberArk vaults](#option-3-cyberark-vault-credentials) and [HashiCorp vaults](#option-4-hashicorp-vault-credentials). The property `expectedSecretType` is required in all cases and must have the value `keyPair`. +This object type is identical to `credentialsSupplier` but requires the secrets to be passwords. The available options are [passwords](#option-1-username-and-password), [CyberArk vaults](#option-3-cyberark-vault-credentials), [HashiCorp vaults](#option-4-hashicorp-vault-credentials) and [Azure vaults](#option-5-azure-vault-credentials). The property `expectedSecretType` is required in all cases and must have the value `keyPair`. ## JSON Schema Limitations From 6907185a4de9696ce2ff2b7cf0fb3258e7a63c77 Mon Sep 17 00:00:00 2001 From: Rakshanda Bhat Date: Thu, 7 May 2026 11:22:13 +0530 Subject: [PATCH 2/2] Updated old links to new ones --- .../Overview.md | 8 ++++---- docs/docs/References/Glossary.md | 2 +- docs/docs/References/Schemas.md | 6 +++--- docs/docs/References/Version_Compatibility.md | 20 +++++++++---------- .../Versioning_And_Upgrade/Replication.md | 6 +++--- 5 files changed, 21 insertions(+), 21 deletions(-) diff --git a/docs/docs/References/Dynamic_UI_Schema_Configuration/Overview.md b/docs/docs/References/Dynamic_UI_Schema_Configuration/Overview.md index 2b3c3cd4..2dad668b 100644 --- a/docs/docs/References/Dynamic_UI_Schema_Configuration/Overview.md +++ b/docs/docs/References/Dynamic_UI_Schema_Configuration/Overview.md @@ -28,8 +28,8 @@ Table below lists all the allowed attributes within [dxFormProperties](../Schema | Dynamic UI Schema Configuration | Earliest Supported vSDK Version | Latest Supported vSDK Version | Earliest Supported DE Version | Latest Supported DE Version | |:---------------------------------------------:|:--------------------------------------------:|:-----------------------------------------------:|:-----------------------------:|:-----------------------------------------------------------------:| -| [Collapsible Section](Collapsible_Section.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [Hidden Fields](Hidden_Fields.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [Text Area](Text_Area.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [Validation Messages](Validation_Messages.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | +| [Collapsible Section](Collapsible_Section.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [Hidden Fields](Hidden_Fields.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [Text Area](Text_Area.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [Validation Messages](Validation_Messages.md) | [4.0.2](https://pypi.org/project/dvp/4.0.2/) | [Latest Release](https://pypi.org/project/dvp/) | 14.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | diff --git a/docs/docs/References/Glossary.md b/docs/docs/References/Glossary.md index a1b949c6..e8af27b5 100644 --- a/docs/docs/References/Glossary.md +++ b/docs/docs/References/Glossary.md @@ -88,7 +88,7 @@ The process of making a virtual copy of a dataset and making it available for us Delphix allows plugins to override the default record size for the linked source and virtual source datafiles. If the “recordSizeInKB” parameter is passed, it will be used to override the default record size and set the new record size for the respective dSources and empty VDBs. VDBs with parent will be inheriting the record size from their parent dSource or VDB. If the parameter is not passed, then default 8K record size will be set for the datafiles. ## Replication -Delphix allows end users to replicate data objects between Delphix Engines by creating a replication profile. Data objects that belong to a plugin can also be part of the replication profile. Refer to the [Delphix Engine Documentation](https://cd.delphix.com/docs/latest/) for more details. +Delphix allows end users to replicate data objects between Delphix Engines by creating a replication profile. Data objects that belong to a plugin can also be part of the replication profile. Refer to the [Delphix Engine Documentation](https://help.delphix.com/cd/current/content/home.htm) for more details. ## Repository Information that represents a set of dependencies that a dataset requires in order to be functional. For example, a particular Postgres database might require an installed Postgres 9.6 DBMS, and so its associated repository would contain all the information required to interact with that DBMS. diff --git a/docs/docs/References/Schemas.md b/docs/docs/References/Schemas.md index acbc1024..5972db2c 100644 --- a/docs/docs/References/Schemas.md +++ b/docs/docs/References/Schemas.md @@ -541,7 +541,7 @@ For this option, the user must provide data that satisfies this definition: } } ``` -where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to a CyberArk vault configured in the system, and `queryString` is a parameter for locating the credentials in the vault. For details on configuring and using CyberArk vaults, see the [password-vaults documentation for the Delphix engine](https://cd.delphix.com/docs/latest/password-vault-support). +where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to a CyberArk vault configured in the system, and `queryString` is a parameter for locating the credentials in the vault. For details on configuring and using CyberArk vaults, see the [password-vaults documentation for the Delphix engine](https://help.delphix.com/cd/current/content/password_vault_support.htm). Optionally, `expectedSecretType` lets the user constrain the secret returned by the vault to passwords or keys (the default is to allow `any` of those two types of secret). An unexpected type of secret returned by the vault will result in a runtime exception. @@ -593,7 +593,7 @@ For this option, the user must provide data that satisfies this definition: } } ``` -where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to a HashiCorp vault configured in the system, and `engine`, `path`, `usernameKey` and `secretKey` are parameters for locating the credentials in the vault. For details on configuring and using HashiCorp vaults, see the [password-vaults documentation for the Delphix engine](https://cd.delphix.com/docs/latest/password-vault-support). +where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to a HashiCorp vault configured in the system, and `engine`, `path`, `usernameKey` and `secretKey` are parameters for locating the credentials in the vault. For details on configuring and using HashiCorp vaults, see the [password-vaults documentation for the Delphix engine](https://help.delphix.com/cd/current/content/password_vault_support.htm). Optionally, `expectedSecretType` lets the user constrain the secret returned by the vault to passwords or keys (the default is to allow `any` of those two types of secret). An unexpected type of secret returned by the vault will result in a runtime exception. @@ -644,7 +644,7 @@ For this option, the user must provide data that satisfies this definition: } } ``` -where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to an Azure Vault configured in the system, and `azureVaultName`, `usernameKey` and `secretKey` are parameters for locating the credentials in the vault. For details on configuring and using Azure vaults, see the [password-vaults documentation for the Delphix engine](https://cd.delphix.com/docs/latest/password-vault-support). +where `type` is a constant that the user interface will submit automatically on behalf of the user, `vault` is a reference to an Azure Vault configured in the system, and `azureVaultName`, `usernameKey` and `secretKey` are parameters for locating the credentials in the vault. For details on configuring and using Azure vaults, see the [password-vaults documentation for the Delphix engine](https://help.delphix.com/cd/current/content/password_vault_support.htm). Optionally, `expectedSecretType` lets the user constrain the secret returned by the vault to passwords or keys (the default is to allow `any` of those two types of secret). An unexpected type of secret returned by the vault will result in a runtime exception. diff --git a/docs/docs/References/Version_Compatibility.md b/docs/docs/References/Version_Compatibility.md index 0af640b6..e5365419 100644 --- a/docs/docs/References/Version_Compatibility.md +++ b/docs/docs/References/Version_Compatibility.md @@ -4,16 +4,16 @@ | vSDK Version | Earliest Supported DE Version | Latest Supported DE Version | |------------------------------------------|:-----------------------------:|:-----------------------------------------------------------------:| -| [5.1.0](../Release_Notes/5.1.0/5.1.0.md) | 2026.4.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [5.0.1](../Release_Notes/5.0.1/5.0.1.md) | 2025.2.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [5.0.0](../Release_Notes/5.0.0/5.0.0.md) | 29.0.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [4.1.0](../Release_Notes/4.1.0/4.1.0.md) | 12.0.0.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [4.0.5](../Release_Notes/4.0.5/4.0.5.md) | 6.0.16.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [4.0.2](../Release_Notes/4.0.2/4.0.2.md) | 6.0.12.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [3.1.0](../Release_Notes/3.1.0/3.1.0.md) | 6.0.7.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [3.0.0](../Release_Notes/3.0.0/3.0.0.md) | 6.0.6.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [2.1.0](../Release_Notes/2.1.0/2.1.0.md) | 6.0.3.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | -| [2.0.0](../Release_Notes/2.0.0/2.0.0.md) | 6.0.2.0 | [Latest Release](https://cd.delphix.com/docs/latest/new-features) | +| [5.1.0](../Release_Notes/5.1.0/5.1.0.md) | 2026.4.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [5.0.1](../Release_Notes/5.0.1/5.0.1.md) | 2025.2.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [5.0.0](../Release_Notes/5.0.0/5.0.0.md) | 29.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [4.1.0](../Release_Notes/4.1.0/4.1.0.md) | 12.0.0.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [4.0.5](../Release_Notes/4.0.5/4.0.5.md) | 6.0.16.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [4.0.2](../Release_Notes/4.0.2/4.0.2.md) | 6.0.12.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [3.1.0](../Release_Notes/3.1.0/3.1.0.md) | 6.0.7.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [3.0.0](../Release_Notes/3.0.0/3.0.0.md) | 6.0.6.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [2.1.0](../Release_Notes/2.1.0/2.1.0.md) | 6.0.3.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | +| [2.0.0](../Release_Notes/2.0.0/2.0.0.md) | 6.0.2.0 | [Latest Release](https://help.delphix.com/cd/current/content/release_notes.htm) | | [1.0.0](../Release_Notes/1.0.0/1.0.0.md) | 6.0.2.0 | 14.0.0.0 | | [0.4.0](../Release_Notes/0.4.0/0.4.0.md) | 5.3.5.0 | 6.0.1.0 | diff --git a/docs/docs/Versioning_And_Upgrade/Replication.md b/docs/docs/Versioning_And_Upgrade/Replication.md index af5f5433..9471f81c 100644 --- a/docs/docs/Versioning_And_Upgrade/Replication.md +++ b/docs/docs/Versioning_And_Upgrade/Replication.md @@ -1,7 +1,7 @@ # Replication A Delphix Engine (source) can be setup to replicate data objects to another Delphix Engine (target). Plugins built using the Virtualization SDK work seamlessly with Delphix Engine replication with no additional development required from plugin developers. -Only a single version of a plugin can be active on a Delphix Engine at a time. We discuss some basic scenarios below. For more detailed information refer to the [Delphix Engine Documentation](https://cd.delphix.com/docs/latest/). +Only a single version of a plugin can be active on a Delphix Engine at a time. We discuss some basic scenarios below. For more detailed information refer to the [Delphix Engine Documentation](https://help.delphix.com/cd/current/content/home.htm). ## Replica Provisioning Replicated dSource or VDB snapshots can be used to provision new VDBs onto a target Delphix Engine, without failing over any of the objects. When provisioning a VDB from a replicated snapshot: @@ -9,7 +9,7 @@ Replicated dSource or VDB snapshots can be used to provision new VDBs onto a tar * A version of the plugin has to be installed on the target Delphix Engine. * The versions of the plugins installed on the source and target Delphix Engines have to be [compatible](Compatibility.md). -Once provisioned, the VDB on the target Delphix Engine will be associated with the version of the plugin installed on the target Delphix Engine, any required data migrations will be run as part of the provisioning process. For more details refer to the [Delphix Engine Documentation](https://cd.delphix.com/docs/latest/). +Once provisioned, the VDB on the target Delphix Engine will be associated with the version of the plugin installed on the target Delphix Engine, any required data migrations will be run as part of the provisioning process. For more details refer to the [Delphix Engine Documentation](https://help.delphix.com/cd/current/content/home.htm). ## Replication Failover On failover, there are three scenarios for each plugin: @@ -18,4 +18,4 @@ On failover, there are three scenarios for each plugin: | -------- | ------- Source plugin **not installed** on target Delphix Engine | The plugin will be failed over and marked as `active` on the target Delphix Engine. Source plugin version **is equal to** the target plugin version | The plugin from the source will be merged with the plugin on the target Delphix Engine. -Source plugin version **is not equal to** the target plugin version | The plugin from the source will be marked `inactive` on the target Delphix Engine. An `inactive` plugin can be subsequently activated, after failover, if it is [compatible](Compatibility.md) with the existing `active` plugin. Activating a plugin will do an upgrade and merge the `inactive` plugin, and all its associated objects, with the `active` plugin. For more details refer to the [Delphix Engine Documentation](https://cd.delphix.com/docs/latest/). \ No newline at end of file +Source plugin version **is not equal to** the target plugin version | The plugin from the source will be marked `inactive` on the target Delphix Engine. An `inactive` plugin can be subsequently activated, after failover, if it is [compatible](Compatibility.md) with the existing `active` plugin. Activating a plugin will do an upgrade and merge the `inactive` plugin, and all its associated objects, with the `active` plugin. For more details refer to the [Delphix Engine Documentation](https://help.delphix.com/cd/current/content/home.htm). \ No newline at end of file