Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit d8d9910

Browse files
author
Lori Krell
authored
Merge pull request #1178 from magento/lk_1016_cloud-config-mgmt2-2
Update content for config mgmt - pipeline deploy for cloud 2.2
2 parents 317643f + 1d6fa18 commit d8d9910

File tree

5 files changed

+103
-14
lines changed

5 files changed

+103
-14
lines changed

guides/v2.0/cloud/project/new-relic.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ github_link: cloud/project/new-relic.md
1515
You can mix the higher level data captured by New Relic APM with the deeper method and call dive data from [Blackfire Profiler]({{page.baseurl}}cloud/project/project-integrate-blackfire.html). Using these two tools together in Staging and Production environments, you gain a better view into your store performance.
1616

1717
<div class="bs-callout bs-callout-info" id="info" markdown="1">
18-
You receiv New Relic APM with your {{site.data.var.ece}} subscription. You do not need to purchase or install install the New Relic extension (different than the APM service).
18+
You receive New Relic APM with your {{site.data.var.ece}} subscription. You do not need to purchase or install install the New Relic extension (different than the APM service).
1919
</div>
2020

2121
## Key features {#features}
@@ -55,7 +55,7 @@ Add New Relic to `.magento.app.yaml`:
5555

5656
runtime:
5757
extensions:
58-
- newrelic
58+
- newrelic
5959
3. Save and push the changes to deploy across Staging and Production.
6060

6161
You may also need to install the New Relic APM agent into Production and Staging environments. For instructions on installing the agent, see New Relic's [Agent installation guide](https://docs.newrelic.com/docs/agents/manage-apm-agents/installation/install-agent){:target="_blank"}. Access both environments via SSH and install the agent.

guides/v2.1/cloud/live/paypal-onboarding.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,3 @@ With the account configured and authenticated, you can enable and disable PayPal
7171

7272
## PayPal variables {#deploy}
7373
When using the PayPal on-boarding tool with {{site.data.var.ece}} 2.1.8 and later 2.1.x versions, we automatically include a variable in `.magento.app.yaml` to correctly connect your PayPal module with PayPal services.
74-
75-
If you are upgrading to {{site.data.var.ece}} 2.2, you need to add this variable to `magento.app.yaml` in the environment variables section.
76-
77-
# Environment variables
78-
variables:
79-
env:
80-
CONFIG__DEFAULT__PAYPAL_ONBOARDING__MIDDLEMAN_DOMAIN: 'payment-broker.magento.com'

guides/v2.1/cloud/live/sens-data-over.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,11 +153,11 @@ Push `config.local.php` to Git. To push this file to the `master` Git branch, yo
153153

154154
1. Transfer `config.local.php` to your local system using `rsync` or `scp`. You can only add this file to the Git branch through your local.
155155

156-
rsync <SSH URL>:app/etc/config.local.php ./app/etc/config.local.php
156+
`rsync <SSH URL>:app/etc/config.local.php ./app/etc/config.local.php`
157157

158158
2. Add and push `config.local.php` to the Git master branch.
159159

160-
git add app/etc/config.local.php && git commit -m "Add system-specific configuration" && git push origin master
160+
`git add app/etc/config.local.php && git commit -m "Add system-specific configuration" && git push origin master`
161161

162162
### Step 3 & 4: Push Git branch to Staging and Production
163163
Log into the Magento Admin in those environments to verify the settings. If you used `scd-dump`, only configured settings display. You can continue configuring the environment if needed.

guides/v2.2/cloud/live/paypal-onboarding.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
layout: default
3+
group: cloud
4+
subgroup: 090_configure
5+
title: Set up PayPal payment methods
6+
menu_title: Set up PayPal
7+
menu_order: 10
8+
menu_node:
9+
version: 2.2
10+
github_link: cloud/live/paypal-onboarding.md
11+
---
12+
13+
Magento Commerce (Cloud) provides an on-boarding tool to configure PayPal Express Checkout accounts directly through the Magento Admin panel. This tool is available for ECE 2.1.8 and later. To better support going live and testing PayPal payment methods, you can enable and configure your PayPal Express Checkout account for sandbox or production accounts.
14+
15+
You can configure either the sandbox or production account in every environment:
16+
17+
* For Integration and Staging environments, we recommend setting Sandbox credentials.
18+
* For your Production environment, you can set Sandbox credentials for initial testing, then replace with live production credentials for a launched store.
19+
20+
## PayPal account {#accounts}
21+
22+
While we recommend having a PayPal merchant account prepared and configured, you can create a new account or upgrade a personal account through the Admin panel.
23+
24+
PayPal on-boarding supports connecting with the following accounts:
25+
26+
* PayPal Business account
27+
* PayPal personal account, converting to a Business account. If you have an existing personal PayPal account, you can login with those credentials and upgrade this account to a business account as you complete the sync.
28+
29+
If you do not have an existing PayPal account, you have an option to create a new one. Enter an e-mail address for a new account. If a matching PayPal account is not found, you will be prompted to create a new PayPal Business account. Or you can create an account directly through [PayPal](https://www.paypal.com/us/webapps/mpp/account-selection){:target="_blank"}.
30+
31+
Please note the [PayPal account limitations](#limitations) for further information.
32+
33+
![Log in to PayPal]({{ site.baseurl }}common/images/cloud_paypal-access.png){:width="336px"}
34+
35+
### PayPal limitations {#limitations}
36+
37+
PayPal supports connecting PayPal Express Checkout for countries across the globe except for the following limitations:
38+
39+
* India, and Japan (future PayPal updates may support these accounts)
40+
* Israel
41+
42+
For Brazil, you must have an existing PayPal business account to connect. You cannot convert an existing personal PayPal account for Brazil during this process. If you need an account, please create a new business PayPal account through [their website](https://www.paypal.com/us/webapps/mpp/account-selection){:target="_blank"}.
43+
44+
## Configure PayPal Express Checkout
45+
46+
To configure PayPal Express Checkout:
47+
48+
1. Access the Admin console for the environment you need to configure.
49+
2. In the left-side navigation, select __Stores__ > __Configuration__, then select __Sales__ > __Payment Methods__.
50+
3. For PayPal, select __Configure__. Configuration fields display in expandable sections for Express Checkout, Adveritise PayPal Credit, and Basic and Advanced settings.
51+
4. Connect your PayPal account. Until the account is connected, the options to enable are disabled. For details on available and supported accounts to connect and limitations, see [PayPal account](#accounts).
52+
53+
* To connect your PayPal live account, click Connect with PayPal and follow the prompts. Any customer purchases using a live PayPal complete and actively charge customers in a live store.
54+
* To connect your sandbox account for testing, click Sandbox Credentials and follow the prompts. Any customer purchases using a Sandbox PayPal complete without actively charging customers.
55+
56+
5. Configure the Express Checkout settings to authenticate and use the PayPal API:
57+
58+
* __Email Associated with PayPal Merchant Account__ (Optional) enter the email address associated with your PayPal merchant account. This email is case-sensitive.
59+
* __API Authentication Methods__ as API Signature or API Certificate.
60+
* API Username, Password, and Signature captured from your PayPal account.
61+
* __Sandbox Mode__ select Yes or No to indicate if the credentials you entered are for sandbox. If you entered production credentials, select No.
62+
* __API Uses Proxy__ select Yes or No to set if the system uses a proxy server to establish a connection between Magento and the PayPal payment system. If Yes, enter the proxy host and port.
63+
6. For detailed information and steps for configuring your account, see [PayPal Express Checkout](http://docs.magento.com/m2/ce/user_guide/payment/paypal-express-checkout.html){:target="_blank"} starting with Step 2 Complete the Required Settings.
64+
65+
66+
With the account configured and authenticated, you can enable and disable PayPal payment options under Required PayPal Settings:
67+
68+
* __Enable this Solution__ displays the PayPal payment method to customers through the website.
69+
* __Enable In-Context Checkout Experience__
70+
* __Enable PayPal Credit__ allows customers to PayPal credit financing without additional costs. PayPal pays the order up-front, handling all repayments for the credit directly with the customer.
71+
72+
## PayPal variables {#deploy}
73+
When using the PayPal on-boarding tool with {{site.data.var.ece}} 2.2, you need to add the following variable to `magento.app.yaml` in the environment variables section.
74+
75+
# Environment variables
76+
variables:
77+
env:
78+
CONFIG__DEFAULT__PAYPAL_ONBOARDING__MIDDLEMAN_DOMAIN: 'payment-broker.magento.com'
79+
80+
If you are upgrading to 2.2 from 2.1.8 or later, you still need to add this variable.

guides/v2.2/cloud/live/sens-data-over.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ It provides the following benefits:
2626
These new methods are optional but strongly recommended. The process ensures faster deployments and consistent configurations across your environments.
2727
</div>
2828

29+
<div class="bs-callout bs-callout-info" markdown="1">
30+
If you used configuration management in 2.1, this process is similar in 2.2. The name of the file has changed to `config.php` and updating the file changed. You can [migrate](#migrate) your `config.local.php` settings to a new `config.php`.
31+
</div>
32+
2933
## Feature availability {#release}
3034
Configuration management was released in `magento-cloud-configuration` 101.4.1 on {{site.data.var.ece}} 2.1.4 and later. The options and functions differ in {{site.data.var.ece}} 2.2. We provide recommendations for {{site.data.var.ece}} deployments in this section.
3135

@@ -157,11 +161,11 @@ Push `config.php` to Git. To push this file to the `master` Git branch, you need
157161

158162
1. Transfer `config.php` to your local system using `rsync` or `scp`. You can only add this file to the Git branch through your local.
159163

160-
rsync <SSH URL>:app/etc/config.php ./app/etc/config.php
164+
`rsync <SSH URL>:app/etc/config.php ./app/etc/config.php`
161165

162166
2. Add and push `config.php` to the Git master branch.
163167

164-
git add app/etc/config.php && git commit -m "Add system-specific configuration" && git push origin master
168+
`git add app/etc/config.php && git commit -m "Add system-specific configuration" && git push origin master`
165169

166170
### Step 3 & 4: Push Git branch to Staging and Production
167171
Log into the Magento Admin in those environments to verify the settings. If you used `scd-dump`, only configured settings display. You can continue configuring the environment if needed.
@@ -187,5 +191,18 @@ To complete extensive changes:
187191
While you can manually edit `config.php` in Staging and Production, we don't recommend it. The file helps keep all of your configurations consistent across all of your environments.
188192
</div>
189193

194+
## Migrate config.local.php to config.php {#migrate}
195+
If you upgrade to {{site.data.var.ece}} 2.2 or later, you may want to migrate settings from `config.local.php` to your new `config.php` file. If the configuration settings in your Magento Admin match the contents of the file, you can follow the instructions to generate and add `config.php`.
196+
197+
If they differ, you can append content from `config.local.php` to your new `config.php` file:
198+
199+
1. Follow instructions to generate the `config.php` file using the [recommended method](#cloud-config-specific-recomm).
200+
2. Open `config.php`and delete the last line.
201+
3. Open `config.local.php`and copy the contents.
202+
4. Paste the contents into `config.php`, save, and complete adding it to Git.
203+
5. Deploy across your environments.
204+
205+
You only need to complete this migration once. When you need to update the file, you will always update the new `config.php`.
206+
190207
#### Next step
191208
[Example of managing system-specific settings]({{ page.baseurl }}cloud/live/sens-data-initial.html)

0 commit comments

Comments
 (0)