From 478d02753bb6b67958ea88168f4400c3b67b23a1 Mon Sep 17 00:00:00 2001 From: jeff ngo Date: Fri, 26 Jun 2020 13:38:40 -0700 Subject: [PATCH 1/5] fixes #211 SDK 2.1.0 Release Notes --- docs/docs/Release_Notes/.pages | 1 + docs/docs/Release_Notes/2.0.0/2.0.0.md | 2 +- docs/docs/Release_Notes/2.1.0/2.1.0.md | 13 +++++++++++++ docs/docs/Versioning_And_Upgrade/Upgrade.md | 3 +-- 4 files changed, 16 insertions(+), 3 deletions(-) create mode 100644 docs/docs/Release_Notes/2.1.0/2.1.0.md diff --git a/docs/docs/Release_Notes/.pages b/docs/docs/Release_Notes/.pages index 8396df7a..d160c92f 100644 --- a/docs/docs/Release_Notes/.pages +++ b/docs/docs/Release_Notes/.pages @@ -1,4 +1,5 @@ arrange: + - 2.1.0 - 2.0.0 - 1.0.0 - 0.4.0 diff --git a/docs/docs/Release_Notes/2.0.0/2.0.0.md b/docs/docs/Release_Notes/2.0.0/2.0.0.md index 68e80920..a3a97839 100644 --- a/docs/docs/Release_Notes/2.0.0/2.0.0.md +++ b/docs/docs/Release_Notes/2.0.0/2.0.0.md @@ -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. diff --git a/docs/docs/Release_Notes/2.1.0/2.1.0.md b/docs/docs/Release_Notes/2.1.0/2.1.0.md new file mode 100644 index 00000000..d1b2941b --- /dev/null +++ b/docs/docs/Release_Notes/2.1.0/2.1.0.md @@ -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 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. diff --git a/docs/docs/Versioning_And_Upgrade/Upgrade.md b/docs/docs/Versioning_And_Upgrade/Upgrade.md index 18cdc9c2..88b58e7c 100644 --- a/docs/docs/Versioning_And_Upgrade/Upgrade.md +++ b/docs/docs/Versioning_And_Upgrade/Upgrade.md @@ -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. From 66d08db37e9c2b5e09e77e506847bc2494d3c4e9 Mon Sep 17 00:00:00 2001 From: jeff ngo Date: Mon, 29 Jun 2020 10:33:19 -0700 Subject: [PATCH 2/5] Added note in sensitive data --- docs/docs/Best_Practices/Sensitive_Data.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/docs/Best_Practices/Sensitive_Data.md b/docs/docs/Best_Practices/Sensitive_Data.md index 8665649f..93d0b9d8 100644 --- a/docs/docs/Best_Practices/Sensitive_Data.md +++ b/docs/docs/Best_Practices/Sensitive_Data.md @@ -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. From ce8e844f590631ed0dcdc193e777592f99a2ed15 Mon Sep 17 00:00:00 2001 From: jeff ngo Date: Mon, 29 Jun 2020 10:42:22 -0700 Subject: [PATCH 3/5] grammar --- docs/docs/Release_Notes/2.1.0/2.1.0.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/Release_Notes/2.1.0/2.1.0.md b/docs/docs/Release_Notes/2.1.0/2.1.0.md index d1b2941b..138726cf 100644 --- a/docs/docs/Release_Notes/2.1.0/2.1.0.md +++ b/docs/docs/Release_Notes/2.1.0/2.1.0.md @@ -9,5 +9,5 @@ To install or upgrade the SDK, refer to instructions [here](/Getting_Started.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 define the name of the LUA toolkit that the plugin can upgrade. +* 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. From 2513255b0b3f93d6906d20469fc8c88354afd567 Mon Sep 17 00:00:00 2001 From: jeff ngo Date: Tue, 30 Jun 2020 14:32:48 -0700 Subject: [PATCH 4/5] Tom and Ravi's comments --- docs/docs/Best_Practices/Sensitive_Data.md | 2 +- docs/docs/Release_Notes/2.1.0/2.1.0.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/docs/Best_Practices/Sensitive_Data.md b/docs/docs/Best_Practices/Sensitive_Data.md index 93d0b9d8..b2183b48 100644 --- a/docs/docs/Best_Practices/Sensitive_Data.md +++ b/docs/docs/Best_Practices/Sensitive_Data.md @@ -35,7 +35,7 @@ This tells the Delphix Engine to take special precautions with this password pro 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. + Removing a previously added password property from a field and running a [Data Migration](Glossary.md#data-migration) will expose the password in plaintext. If this is intentional, write a migration to ensure that the new property conforms to the new schema. # Using Environment Variables For Remote Data Passing diff --git a/docs/docs/Release_Notes/2.1.0/2.1.0.md b/docs/docs/Release_Notes/2.1.0/2.1.0.md index 138726cf..fd757e43 100644 --- a/docs/docs/Release_Notes/2.1.0/2.1.0.md +++ b/docs/docs/Release_Notes/2.1.0/2.1.0.md @@ -9,5 +9,4 @@ To install or upgrade the SDK, refer to instructions [here](/Getting_Started.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. +* Added new fields `luaName` and `minimumLuaVersion` to the [Plugin Config](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Plugin_Config.md). These properties allow a plugin to specify which Lua toolkit(s) the plugin can upgrade. From e416f4ee6a126b1de2d58dc92a7f7b9b0d654bb6 Mon Sep 17 00:00:00 2001 From: jeff ngo Date: Tue, 30 Jun 2020 15:15:09 -0700 Subject: [PATCH 5/5] lindsey's comments --- docs/docs/Release_Notes/1.0.0/1.0.0.md | 2 +- docs/docs/Release_Notes/2.0.0/2.0.0.md | 2 +- docs/docs/Release_Notes/2.1.0/2.1.0.md | 7 +++---- 3 files changed, 5 insertions(+), 6 deletions(-) diff --git a/docs/docs/Release_Notes/1.0.0/1.0.0.md b/docs/docs/Release_Notes/1.0.0/1.0.0.md index 73769b82..522342f6 100644 --- a/docs/docs/Release_Notes/1.0.0/1.0.0.md +++ b/docs/docs/Release_Notes/1.0.0/1.0.0.md @@ -1,4 +1,4 @@ -# Release - GA (v1.0.0) +# Release - v1.0.0 To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md#installation). diff --git a/docs/docs/Release_Notes/2.0.0/2.0.0.md b/docs/docs/Release_Notes/2.0.0/2.0.0.md index a3a97839..4269462c 100644 --- a/docs/docs/Release_Notes/2.0.0/2.0.0.md +++ b/docs/docs/Release_Notes/2.0.0/2.0.0.md @@ -1,4 +1,4 @@ -# Release - GA (v2.0.0) +# Release - v2.0.0 To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md#installation). diff --git a/docs/docs/Release_Notes/2.1.0/2.1.0.md b/docs/docs/Release_Notes/2.1.0/2.1.0.md index fd757e43..f254d51e 100644 --- a/docs/docs/Release_Notes/2.1.0/2.1.0.md +++ b/docs/docs/Release_Notes/2.1.0/2.1.0.md @@ -1,4 +1,4 @@ -# Release - GA (v2.1.0) +# Release - v2.1.0 To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md#installation). @@ -6,7 +6,6 @@ To install or upgrade the SDK, refer to instructions [here](/Getting_Started.md# * 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). + * Added new fields `luaName` and `minimumLuaVersion` to the [Plugin Config](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Plugin_Config.md). These properties allow a plugin to specify which Lua toolkit(s) the plugin can upgrade. - More details about Lua Upgrade can be found [here](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Overview.md). - -* Added new fields `luaName` and `minimumLuaVersion` to the [Plugin Config](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Plugin_Config.md). These properties allow a plugin to specify which Lua toolkit(s) the plugin can upgrade. + More details about Lua Upgrade can be found [here](/Versioning_And_Upgrade/Lua_Toolkit_To_SDK_Plugin_Migration/Overview.md). \ No newline at end of file