Merge branch 'master' into db_analytics_script

dobooth · web-flow · commit 668f73d173f0 · 2020-08-05T06:38:31.000-05:00
diff --git a/_config.yml b/_config.yml
@@ -52,6 +52,18 @@ defaults:
       github_link: true
       # Enables the 'Give us feedback' appearances on pages
       feedback_link: true
+  
+  - 
+    scope:
+      path: guides/v2.3
+    values:
+      guide_version: '2.3'
+  
+  - 
+    scope:
+      path: guides/v2.4
+    values:
+      guide_version: '2.4'
 
   -
     scope:
diff --git a/_plugins/page-params/page-baseurl-generator.rb b/_plugins/page-params/page-baseurl-generator.rb
@@ -6,29 +6,19 @@
 # This custom plugin dynamically sets and injects the page.baseurl variable
 # based on the page's destination.
 #
-# The hook introduces the page.baseurl and
-# page.guide_version data parameters for each page.
+# The hook introduces the page.baseurl parameter for each page.
 # For pages at guides/v2.x the page.baseurl parameter is set
 # as "{site.baseurl}/guides/v#{version}".
 # The {version} is taken from the 'guide_version' front matter parameter on the page;
-# if it is not set, then the 'guide_version' is set to version from the page path (for example, "2.2" in the "guides/v2.2/**/*.md");
-# if the path doesn't contain "guides/v2.x", then the version is unset and returns the nil object (same as null)
+# if it is not set, then the 'guide_version' is set to version from the _config.yml depending on a scope by path (for example, "2.4" at the "guides/v2.4/");
+# otherwise, the version is unset and returns the nil object (same as null).
 Jekyll::Hooks.register :pages, :post_init do |page|
   # Glossary. Create and assign variables to be used in the script.
-  pattern = %r{\Aguides/v(?<version_from_path>2\.\d)}
   baseurl = page.site.baseurl
-  path = page.path
   data = page.data
   version = data['guide_version']
 
-  # Process 'page.guide_version' pararmeter
-  if version.nil? && path.start_with?('guides')
-    pattern.match(path)
-    version = Regexp.last_match(:version_from_path)
-    data['guide_version'] = version
-  end
-
-  # Process 'page.baseurl' parameter
+  # Create 'page.baseurl' parameter
   data['baseurl'] =
     if version
       "#{baseurl}/guides/v#{version}"
diff --git a/src/_includes/cloud/note-increase-scd-max-execution-time-variable.md b/src/_includes/cloud/note-increase-scd-max-execution-time-variable.md
@@ -0,0 +1,2 @@
+{:.bs-callout-warning}
+If you have issues with static content files in your Magento application after deployment, for example missing custom theme files, increase the maximum expected execution time to 900 seconds or higher.
diff --git a/src/cloud/env/variables-build.md b/src/cloud/env/variables-build.md
@@ -104,6 +104,8 @@ stage:
     SCD_MAX_EXECUTION_TIME: 3600
 ```
 
+{% include cloud/note-increase-scd-max-execution-time-variable.md%}
+
 ### `SCD_STRATEGY`
 
 -  **Default**—`quick`
diff --git a/src/cloud/env/variables-deploy.md b/src/cloud/env/variables-deploy.md
@@ -504,6 +504,8 @@ stage:
     SCD_MAX_EXECUTION_TIME: 3600
 ```
 
+{% include cloud/note-increase-scd-max-execution-time-variable.md%}
+
 ### `SCD_STRATEGY`
 
 -  **Default**—`quick`
diff --git a/src/cloud/env/variables-global.md b/src/cloud/env/variables-global.md
@@ -73,6 +73,8 @@ stage:
     SCD_MAX_EXECUTION_TIME: 3600
 ```
 
+{% include cloud/note-increase-scd-max-execution-time-variable.md%}
+
 ### `SCD_USE_BALER`
 
 -  **Default**—_Not set_
diff --git a/src/cloud/project/project-conf-files_services.md b/src/cloud/project/project-conf-files_services.md
@@ -8,7 +8,7 @@ functional_areas:
 
 The `services.yaml` file defines the services supported and used by {{site.data.var.ece}}, such as MySQL, Redis, and ElasticSearch. You do not need to subscribe to external service providers. This file is in the `.magento` directory of your project.
 
-The deploy script uses the configuration files in the `.magento` directory to provision the environment with the configured services. A service becomes available to your application if it is included in the `relationships` property of the `.magento.app.yaml` file. The `services.yaml` file contains the _type_ and _disk_ values. Service type defines the service _name_ and _version_. Changing a service configuration causes a deployment to provision the environment with the updated services.
+The deploy script uses the configuration files in the `.magento` directory to provision the environment with the configured services. A service becomes available to your application if it is included in the [`relationships`]({{ site.baseurl }}/cloud/project/project-conf-files_magento-app.html#relationships) property of the `.magento.app.yaml` file. The `services.yaml` file contains the _type_ and _disk_ values. Service type defines the service _name_ and _version_. Changing a service configuration causes a deployment to provision the environment with the updated services.
 
 This affects the following environments:
 
@@ -43,19 +43,22 @@ elasticsearch:
 
 ## Service values
 
-You must provide the _type_ values: service _name_ and _version_. If the service uses persistent storage, then you must provide a _disk_ value. Use the following format:
+You must provide the <service-id> and service type configuration `type: <name>:<version>`.
+If the service uses persistent storage, then you must provide a _disk_ value.
+
+Use the following format:
 
 ```yaml
-<name>:
+<service-id>:
     type: <name>:<version>
     disk: <value-MB>
 ```
 
-### `name`
+### `service-id`
 
-The `name` value identifies the service in the project. You can only use lower case alphanumeric characters: `a` to `z` and `0` to `9`, such as `redis`.
+The `service-id` value identifies the service in the project. You can only use lower case alphanumeric characters: `a` to `z` and `0` to `9`, such as `redis`.
 
-This _name_ value is used in the `relationships` property of the `.magento.app.yaml` configuration file:
+This _service-id_ value is used in the [`relationships`]({{ site.baseurl }}/cloud/project/project-conf-files_magento-app.html#relationships) property of the `.magento.app.yaml` configuration file:
 
 ```yaml
 relationships:
@@ -86,6 +89,8 @@ mysql:
     type: mysql:10.2
 ```
 
+Use [`Service versions`](#service-versions) table to see supported services and their versions
+
 ### `disk`
 
 The `disk` value specifies the size of the persistent disk storage (in MB) to allocate to the service. Services that use persistent storage, such as MySQL, must provide a disk value. Services that use memory instead of persistent storage, such as Redis, do not require a disk value.
@@ -146,10 +151,10 @@ To verify relationships in remote environments:
    echo $MAGENTO_CLOUD_RELATIONSHIPS | base64 -d | json_pp
    ```
 
-   or
+   or, use the following {{ site.data.var.ct }} CLI command to view relationships:
 
    ```bash
-   php -r 'print_r(json_decode(base64_decode($_ENV["MAGENTO_CLOUD_RELATIONSHIPS"])));'
+   php ./vendor/bin/ece-tools env:config:show services
    ```
 
 1. Confirm the `service` and `type` from the response. The response provides connection information, such as the IP address and port number and any required username and password credentials.
@@ -182,6 +187,144 @@ During the deployment process, {{site.data.var.ct}} checks installed service ver
 
 To maintain Magento store security, update installed software versions before they reach EOL.
 
+## Change service version
+
+You can upgrade the installed service version for compatibility with the Magento version deployed in your Cloud environment.
+
+You cannot downgrade the service version for an installed service directly. However, you can create a new service with the required version. See [Downgrade service version](#downgrade-version).
+
+Use the [Service versions](#service-versions) table to check service version compatibility by Magento version. Note that some service versions supported by {{ site.data.var.ee }} are not supported on {{ site.data.var.ece }}.
+
+{:.bs-callout-warning}
+You must submit a support ticket to change the service configuration on Pro Production and Staging environments.
+
+{:.bs-callout-info}
+If you change the Elasticsearch service version, check the Elasticsearch composer package for compatibility with the new version. See [Elasticsearch software compatibility]({{ site.baseurl}}/cloud/project/project-conf-files_services-elastic.html#elasticsearch-software-compatibility).
+
+### Upgrade installed service version
+
+You can upgrade the installed service version by updating the service configuration in the `services.yaml` file.
+
+1. Change the [`type`](#type) value for the service in the `.magento/services.yaml` file:
+
+   > Original service definition
+
+   ```yaml
+   mysql:
+       type: mysql:10.2
+       disk: 2048
+   ```
+
+   > Updated service definition
+
+   ```yaml
+   mysql:
+       type: mysql:10.3
+       disk: 2048
+   ```
+
+1. Add, commit, and push your code changes.
+
+   ```bash
+   git add -A
+   ```
+
+   ```bash
+   git commit -m "Upgrade MySQL from MariaDB 10.2 to 10.3."
+   ```
+
+   ```bash
+   git push origin <branch-name>
+   ```
+
+### Downgrade version
+
+You cannot downgrade an installed service directly. You have two options:
+
+-  Rename an existing service with the new version, which removes the existing service and data, and adds a new one.
+
+-  Create a new service and save the data from the existing service.
+
+When you change the service version, you must update the service configuration in the `services.yaml` file, and update the relationships in the `.magento.app.yaml` file.
+
+{:.procedure}
+To downgrade a service version by renaming an existing service:
+
+1. Rename the existing service in the `.magento/services.yaml` file and change the version.
+
+   {:.bs-callout-warning}
+   Renaming an existing service replaces it and deletes all data. If you need to retain the data, create a new service instead of renaming the existing one.
+
+   For example, to downgrade the MariaDB version for the _mysql_ service from version 10.3 to 10.2, change the existing  _service-id_ and _type_ configuration.
+
+   > Original `services.yaml` definition
+
+     ```yaml
+     mysql:
+         type: mysql:10.3
+         disk: 2048
+     ```
+
+   > New `services.yaml` definition
+
+     ```yaml
+     mysql2:
+          type: mysql:10.2
+          disk: 2048
+     ```
+
+1. Update the relationships in the `.magento.app.yaml` file.
+
+   > Original `.magento.app.yaml` configuration
+
+   ```yaml
+   relationships:
+       database: "mysql:mysql"
+   ```
+
+  > Updated `.magento.app.yaml` configuration
+
+  ```yaml
+  relationships:
+      database: "mysql2:mysql"
+  ```
+
+1. Add, commit, and push your code changes.
+
+{:.procedure}
+To downgrade a service by creating an additional service:
+
+1. Add an additional service definition to the `services.yaml` file for your project with the downgraded version specification. See _mysql2_ in the following example:
+
+   > services.yaml
+
+   ```yaml
+   mysql:
+       type: mysql:10.3
+       disk: 2048
+   mysql2:
+       type: mysql:10.2
+       disk: 2048
+   ```
+
+1. Change the relationships configuration in the `.magento.app.yaml` file to use the new service.
+
+   > Original `.magento.app.yaml` configuration
+
+     ```yaml
+     relationships:
+         database: "mysql:mysql"
+     ```
+
+   > New `.magento.app.yaml` configuration
+
+     ```yaml
+     relationships:
+         database: "mysql2:mysql"
+     ```
+
+1. Add, commit, and push your code changes.
+
 <!--Custom column widths for service version table-->
 <style>
 table.error-table td:nth-child(1) {
diff --git a/src/guides/v2.4/release-notes/release-notes-2-4-0-commerce.md b/src/guides/v2.4/release-notes/release-notes-2-4-0-commerce.md
@@ -2220,6 +2220,8 @@ We have fixed hundreds of issues in the Magento 2.4.0 core code.
 
 **Issue**: The **Refresh** buttons on the Last Ordered Items,  Products in Comparison List, and Recently Compared Products sections of the Admin Customer Activities page do not work as expected. Currently, Magento scrolls the page  every time the **Refresh** button is clicked and does not display the product name. See [Refresh on Customer's Activities does not work](https://magento.zendesk.com/hc/en-us/articles/360046091332) Knowledge Base article. <!--- MC-35296-->
 
+**Issue**: If a discount code expires before a Purchase Order (PO) is approved, the PO continues to display the discounted amount, but once the PO is approved, the order is placed at the non-discounted total. **Workaround**: The **B2B-709 Purchase Order Discount patch** hotfix for this issue is now available from the **My Account** > **Downloads** section of `magento.com`.
+
 ## Known issues -- VBE
 
 ### Amazon Pay
@@ -2242,7 +2244,7 @@ We have fixed hundreds of issues in the Magento 2.4.0 core code.
 
 ### dotdigital
 
-*  **Issue**: Integration tests fail with this error: `PHP Fatal error: Declaration of Dotdigitalgroup\Email\Test\Integration\Model\Sync\Importer\ImporterFailedTest::setUp() must be compatible with PHPUnit\Framework\TestCase::setUp(): void in /var/www/vendor/dotmailer/dotmailer-magento2-extension/Test/Integration/Model/Sync/Importer/ImporterFailedTest.php on line 36`.  <!--- BUNDLE-2684-->
+*  **Issue**: Integration tests fail with this error: `PHP Fatal error: Declaration of Dotdigitalgroup\Email\Test\Integration\Model\Sync\Importer\ImporterFailedTest::setUp() must be compatible with PHPUnit\Framework\TestCase::setUp(): void in /var/www/vendor/dotmailer/dotmailer-magento2-extension/Test/Integration/Model/Sync/Importer/ImporterFailedTest.php on line 36`. **Workaround**: The **BUNDLE-2684 Dotdigital Integration Tests patch** hotfix for this issue is now available from [Releases](https://magento.com/tech-resources/download). <!--- BUNDLE-2684-->
 
 ### Klarna
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+{:.bs-callout-warning}`
	`2`	`+If you have issues with static content files in your Magento application after deployment, for example missing custom theme files, increase the maximum expected execution time to 900 seconds or higher.`