Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
3 changes: 3 additions & 0 deletions docs/docs/Best_Practices/Sensitive_Data.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ This tells the Delphix Engine to take special precautions with this password pro
3. The Delphix Engine's UI and CLI will not display the password.
4. Clients of the Delphix Engine's public API will not be able to access the password.

!!! note
Removing a previously added password property from a field and running a [Data Migration](Glossary.md#data-migration) will expose the password in plaintext.

# Using Environment Variables For Remote Data Passing

Sometimes, a plugin will need to pass sensitive data to a remote environment. For example, perhaps a database command needs to be run on a [staging environment](/References/Glossary.md#staging-environment), and that database command will need to use a password.
Expand Down
1 change: 1 addition & 0 deletions docs/docs/Release_Notes/.pages
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
arrange:
- 2.1.0
- 2.0.0
- 1.0.0
- 0.4.0
2 changes: 1 addition & 1 deletion docs/docs/Release_Notes/2.0.0/2.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md#

## New & Improved

* Added the ability for plugins to upgrade across plugin versions with schema changes. Some hightlights:
* Added the ability for plugins to upgrade across plugin versions with schema changes. Some highlights:
* Schema updates using data migrations.
* Flexiblity for plugins to pick any release strategy.
* Plugin upgrades supported across multiple plugin versions.
Expand Down
13 changes: 13 additions & 0 deletions docs/docs/Release_Notes/2.1.0/2.1.0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Release - GA (v2.1.0)

To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md#installation).

## New & Improved

* Added the ability to migrate existing Lua toolkits to plugins.
* [Convert](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Converting_Migration_Scripts.md) any existing Lua upgrade scripts to Python migrations by using our new Lua upgrade [decorators](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Decorators.md).

More details about Lua Upgrade can be found [here](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Overview.md).

* Added a new field `luaName` to the [Plugin Config](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Plugin_Config.md) which allows plugins to define the name of the LUA toolkit that the plugin can upgrade.
* Added a new field `minimumLuaVersion` to the [Plugin Config](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Plugin_Config.md) which allows plugins to define the lowest LUA toolkit version that the plugin can upgrade.
3 changes: 1 addition & 2 deletions docs/docs/Versioning_And_Upgrade/Upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,7 @@ During the process of upgrading to a new version, the Delphix Engine will run al
#### Security Concerns Prevent Detailed Error Messages
One problem here is that the Delphix Engine is limited in the information that it can provide in the error message. Ideally, the engine would say exactly what was wrong with the object (e.g.: "The field `port` has the value `15`, but the schema says it has to have a value between `256` and `1024`").

But, the Delphix Engine cannot do this for security reasons. Ordinarily, the Delphix Engine knows which fields contain sensitive information, and can redact such fields from error messages. But, the only reason the Delphix Engine has that knowledge is because the schema provides that information. If an object does
**not** conform to the schema, then the Delphix Engine can't know what is sensitive and what isn't.
But, the Delphix Engine cannot do this for security reasons. Ordinarily, the Delphix Engine knows which fields contain sensitive information, and can redact such fields from error messages. But, the only reason the Delphix Engine has that knowledge is because the schema provides that information. If an object does **not** conform to the schema, then the Delphix Engine can't know what is sensitive and what isn't.

Therefore, the error message here might lack the detail necessary to debug the problem.

Expand Down