AWS solutions documentation change
Summary
Formatting and punctuation fixes in documentation (replaced en-dashes with hyphens, adjusted markdown syntax for lists and secret references)
Security assessment
Changes are typographical corrections and markdown formatting adjustments. No security vulnerabilities or security feature enhancements are mentioned. References to secrets management remain unchanged in substance.
Diff
diff --git a/solutions/latest/cloud-migration-factory-on-aws/scripts-management.md index f5c667748..a53169483 100644 --- a/solutions/latest/cloud-migration-factory-on-aws/scripts-management.md +++ b/solutions/latest/cloud-migration-factory-on-aws/scripts-management.md @@ -13 +13 @@ A supported script package is a compressed zip archive containing the following - * **Package-Structure.yml** – Used to define the script’s arguments and other metadata, such as description and default name. Refer to Composing a new script package for more details. + * **Package-Structure.yml** \- Used to define the script’s arguments and other metadata, such as description and default name. Refer to Composing a new script package for more details. @@ -15 +15 @@ A supported script package is a compressed zip archive containing the following - * **[custom python script].py** – This is the initial script that will be run when a job is submitted. This script can call other scripts and modules and if so these should be included in the archive. The name of this script must match the value specified in the `MasterFileName` key in the `Package-Structure.yml`. + * **[custom python script].py** \- This is the initial script that will be run when a job is submitted. This script can call other scripts and modules and if so these should be included in the archive. The name of this script must match the value specified in the `MasterFileName` key in the `Package-Structure.yml`. @@ -85 +85 @@ Returns an access token that can be used to call Cloud Migration Factory on AWS - 1. By attempting to access the default secret containing the service account userid and password if it exists and access is allowed. This secret name **MFServiceAccount-[`userpool id`]** will be checked. + 1. By attempting to access the default secret containing the service account userid and password if it exists and access is allowed. This secret name **MFServiceAccount-`userpool id`]** will be checked. @@ -107 +107 @@ Returns the login credentials for a server stored in AWS Cloud Migration Factory -local_username – If passed, then will be returned. +local_username - If passed, then will be returned. @@ -109 +109 @@ local_username – If passed, then will be returned. -local_password – If passed, then will be returned. +local_password - If passed, then will be returned. @@ -111 +111 @@ local_password – If passed, then will be returned. -server – CMF Server dict, as returned by get_factory_servers. in AWS Cloud Migration Factory. +server - CMF Server dict, as returned by get_factory_servers. in AWS Cloud Migration Factory. @@ -113 +113 @@ server – CMF Server dict, as returned by get_factory_servers. in AWS Cloud Mig -Secret_overide – Is passed this will set the secret name to retrieve from Secrets Manager for this server. +Secret_overide - Is passed this will set the secret name to retrieve from Secrets Manager for this server. @@ -115 +115 @@ Secret_overide – Is passed this will set the secret name to retrieve from Secr -No_user_prompts – Tells the function not to prompt a user for a userid and password if not stored, this should be True for any remote automation script. +No_user_prompts - Tells the function not to prompt a user for a userid and password if not stored, this should be True for any remote automation script. @@ -123 +123 @@ Gets the credentials stored using AWS Cloud Migration Factory Credentials Manage -secret_name – name of the secret to retrieve. +secret_name - name of the secret to retrieve. @@ -131 +131 @@ Returns an array of servers from the AWS Cloud Migration Factory datastore based -waveid – Wave record ID of the servers that will be returned. +waveid - Wave record ID of the servers that will be returned. @@ -133 +133 @@ waveid – Wave record ID of the servers that will be returned. -token – Authentication token obtained from the FactoryLogin Lambda function. +token - Authentication token obtained from the FactoryLogin Lambda function. @@ -135 +135 @@ token – Authentication token obtained from the FactoryLogin Lambda function. -app_ids – Optional list of application Ids within the wave to include. +app_ids - Optional list of application Ids within the wave to include. @@ -137 +137 @@ app_ids – Optional list of application Ids within the wave to include. -server_ids – Optional list of server Ids within the wave and applications to include. +server_ids - Optional list of server Ids within the wave and applications to include. @@ -139 +139 @@ server_ids – Optional list of server Ids within the wave and applications to i -os_split – If set to `true`, then two lists will be returned one for Linux and one windows servers, if False, then a single combined list will be returned. +os_split - If set to `true`, then two lists will be returned one for Linux and one windows servers, if False, then a single combined list will be returned. @@ -141 +141 @@ os_split – If set to `true`, then two lists will be returned one for Linux and -rtype – Optional string to filter only for a specific Migration Strategy of servers, i.e. passing the value ‘Rehost’ will return only servers with Rehost. +rtype - Optional string to filter only for a specific Migration Strategy of servers, i.e. passing the value "Rehost" will return only servers with Rehost. @@ -204 +204 @@ Required -**Name** – Default name that the script will use on import. +**Name** \- Default name that the script will use on import. @@ -206 +206 @@ Required -**Description** – Description of the usage of the script. +**Description** \- Description of the usage of the script. @@ -208 +208 @@ Required -**MasterFileName** – This is the starting point for the script to run, it has to be a python file name that is included within the script package archive. +**MasterFileName** \- This is the starting point for the script to run, it has to be a python file name that is included within the script package archive. @@ -210 +210 @@ Required -**Arguments** – A list of arguments that the MasterFileName Python script accepts. Each argument needs specified is in the AWS Cloud Migration Factory Attribute definition format. Required properties for each argument are **Name** and **Type** , all other properties are optional. +**Arguments** \- A list of arguments that the MasterFileName Python script accepts. Each argument needs specified is in the AWS Cloud Migration Factory Attribute definition format. Required properties for each argument are **Name** and **Type** , all other properties are optional. @@ -214 +214 @@ Optional -**UpdateUrl** – Provide a URL where the script package’s source is available for providing updates. Currently this is for reference only. +**UpdateUrl** \- Provide a URL where the script package’s source is available for providing updates. Currently this is for reference only. @@ -216 +216 @@ Optional -**SchemaExtensions** – A list of attributes that the Python script requires to be in the schema to store output or retrieve additional data. Each attribute must be specified in the AWS CMF Attribute definition format. Required properties for each attribute are **Schema** , **Name, Description** and **Type**. All other properties are optional. Any new attributes will be automatically added to the schema when the script is initially loaded, and changes to SchemaExtensions will not be processed for new versions of the script. If this is required for a new script to be added, manual updates to the schema must be made. +**SchemaExtensions** \- A list of attributes that the Python script requires to be in the schema to store output or retrieve additional data. Each attribute must be specified in the AWS CMF Attribute definition format. Required properties for each attribute are **Schema** , **Name, Description** and **Type**. All other properties are optional. Any new attributes will be automatically added to the schema when the script is initially loaded, and changes to SchemaExtensions will not be processed for new versions of the script. If this is required for a new script to be added, manual updates to the schema must be made.