You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: _includes/cloud/backup-db.md
+18-18Lines changed: 18 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -3,33 +3,33 @@ We recommend creating a backup of your project before an upgrade. Use the follow
3
3
{:.procedure}
4
4
To back up your Integration environment database and code:
5
5
6
-
1.Create a local backup of the remote database.
6
+
1. Create a local backup of the remote database.
7
7
8
-
```bash
9
-
magento-cloud db:dump
10
-
```
8
+
```bash
9
+
magento-cloud db:dump
10
+
```
11
11
12
-
{: .bs-callout-info }
13
-
The `magento-cloud db:dump`command runs the [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) command with the `--single-transaction` flag, which allows you to back up your database without locking the tables.
12
+
{: .bs-callout-info }
13
+
The `magento-cloud db:dump` command runs the [mysqldump](https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html) command with the `--single-transaction` flag, which allows you to back up your database without locking the tables.
14
14
15
-
1. Back up code and media.
15
+
1. Back up code and media.
16
16
17
-
```bash
18
-
php bin/magento setup:backup --code [--media]
19
-
```
17
+
```bash
18
+
php bin/magento setup:backup --code [--media]
19
+
```
20
20
21
-
Optionally, you can omit `[--media]`if you have a large number of static files that are already insource control.
21
+
Optionally, you can omit `[--media]` if you have a large number of static files that are already in source control.
22
22
23
23
{:.procedure}
24
24
To back up your Staging or Production environment database before deploying:
25
25
26
-
1. Use SSH to log in to the remote server.
26
+
1. Use SSH to log in to the remote server.
27
27
28
-
2. Create a database dump.
28
+
1. Create a database dump.
29
29
30
-
```bash
31
-
vendor/bin/ece-tools db-dump
32
-
```
30
+
```bash
31
+
vendor/bin/ece-tools db-dump
32
+
```
33
33
34
-
- We recommend setting the application in maintenance mode before doing a database dump in Production environments.
35
-
- This creates an `dump-<timestamp>.sql.gz` archive file in your local project directory. See [Snapshot and backup management]({{ site.baseurl }}/guides/v2.2/cloud/project/project-webint-snap.html#db-dump).
34
+
- We recommend setting the application in maintenance mode before doing a database dump in Production environments.
35
+
- This creates an `dump-<timestamp>.sql.gz` archive file in your local project directory. See [Snapshot and backup management]({{ site.baseurl }}/guides/v2.2/cloud/project/project-webint-snap.html#db-dump).
Copy file name to clipboardExpand all lines: _includes/cloud/enable-ssh.md
+53-53Lines changed: 53 additions & 53 deletions
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,8 @@ You must create an SSH key pair on every machine and workspace you and your team
2
2
3
3
The SSH keys require the following:
4
4
5
-
* Set up SSH keys as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
6
-
* Create the keys using the email address used for the GitHub account.
5
+
*Set up SSH keys as the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html).
6
+
*Create the keys using the email address used for the GitHub account.
7
7
8
8
For more information on SSH keys, see the following:
9
9
@@ -33,8 +33,8 @@ If you do not have SSH keys, you need to generate the keys for adding to your Ma
33
33
34
34
If you already have SSH keys, continue to:
35
35
36
-
*[Add a public SSH key to your Magento account](#ssh-add-to-account) section
37
-
*[Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
36
+
*[Add a public SSH key to your Magento account](#ssh-add-to-account) section
37
+
*[Add your SSH key to your GitHub account](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/)
38
38
39
39
## Create a new SSH key pair {#ssh-create-new-key-pair}
40
40
@@ -43,70 +43,70 @@ Use the `ssh-keygen` command to create an SSH key pair. `ssh-keygen` is typicall
43
43
{:.procedure}
44
44
To create an SSH key pair:
45
45
46
-
1.The command syntax follows, entering the email used for your GitHub account:
46
+
1. The command syntax follows, entering the email used for your GitHub account:
47
47
48
-
```bash
49
-
ssh-keygen -t rsa
50
-
```
48
+
```bash
49
+
ssh-keygen -t rsa
50
+
```
51
51
52
-
GitHub also uses the key length `-b 4096`in the command. Follow the prompts to complete the key.
52
+
GitHub also uses the key length `-b 4096` in the command. Follow the prompts to complete the key.
53
53
54
-
1. When prompted to "Enter a file in which to save the key," press **Enter** to save the file to the default location. The prompt displays the location.
54
+
1. When prompted to "Enter a file in which to save the key," press **Enter** to save the file to the default location. The prompt displays the location.
55
55
56
-
1. When prompted to enter a secure passphrase, enter a phrase to use like a password. Make note of this passphrase. You may be requested to enter it depending on tasks you complete using a terminal during development.
56
+
1. When prompted to enter a secure passphrase, enter a phrase to use like a password. Make note of this passphrase. You may be requested to enter it depending on tasks you complete using a terminal during development.
57
57
58
-
1. After creating the SSH key pair, start the ssh-agent:
58
+
1. After creating the SSH key pair, start the ssh-agent:
59
59
60
-
For Mac or Linux:
60
+
For Mac or Linux:
61
61
62
-
```bash
63
-
eval"$(ssh-agent -s)"
64
-
```
62
+
```bash
63
+
eval"$(ssh-agent -s)"
64
+
```
65
65
66
-
For Mac, you can edit the `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
66
+
For Mac, you can edit the `~/.ssh/config` file to automatically load keys into the ssh-agent and store passphrases in your keychain.
67
67
68
-
```conf
69
-
Host *
70
-
AddKeysToAgent yes
71
-
UseKeychain yes
72
-
IdentityFile ~/.ssh/id_rsa
73
-
```
68
+
```conf
69
+
Host *
70
+
AddKeysToAgent yes
71
+
UseKeychain yes
72
+
IdentityFile ~/.ssh/id_rsa
73
+
```
74
74
75
75
For Windows:
76
76
77
77
```shell
78
78
eval$(ssh-agent -s)
79
79
```
80
80
81
-
1. Add the SSH key to the ssh-agent. If you used a different name for the key file name, replace `id_rsa` with that file name.
81
+
1. Add the SSH key to the ssh-agent. If you used a different name for the key file name, replace `id_rsa` with that file name.
82
82
83
-
For Mac:
83
+
For Mac:
84
84
85
-
```bash
86
-
ssh-add -K ~/.ssh/id_rsa
87
-
```
85
+
```bash
86
+
ssh-add -K ~/.ssh/id_rsa
87
+
```
88
88
89
-
For Windows or Linux:
89
+
For Windows or Linux:
90
90
91
-
```shell
92
-
ssh-add ~/.ssh/id_rsa
93
-
```
91
+
```shell
92
+
ssh-add ~/.ssh/id_rsa
93
+
```
94
94
95
-
1. [Add your SSH key to your GitHub account.](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) The instructions include Mac, Windows, and Linux.
95
+
1. [Add your SSH key to your GitHub account.](https://help.github.com/articles/adding-a-new-ssh-key-to-your-github-account/) The instructions include Mac, Windows, and Linux.
96
96
97
97
### Test the SSH keys {#test}
98
98
99
99
After adding the SSH keys, test the SSH connection to GitHub:
2. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue.
107
+
1. You may see a warning that the authenticity of the host can't be established followed by an RSA fingerprint. Enter `yes` to continue.
108
108
109
-
3. If successful, you should receive a success message. If you receive a permission denied error, see [Error: Permission denied (publickey)](https://help.github.com/articles/error-permission-denied-publickey) troubleshooting on GitHub.
109
+
1. If successful, you should receive a success message. If you receive a permission denied error, see [Error: Permission denied (publickey)](https://help.github.com/articles/error-permission-denied-publickey) troubleshooting on GitHub.
110
110
111
111
## Add a public SSH key to your Magento account {#ssh-add-to-account}
112
112
@@ -120,43 +120,43 @@ You can add SSH keys to your account in any of the following ways:
120
120
To add an SSH key using the CLI:
121
121
122
122
1. Open a terminal application on your local.
123
-
2. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
123
+
1. If you haven't done so already, log in (or switch to) the [Magento file system owner]({{ page.baseurl }}/cloud/before/before-workspace-file-sys-owner.html) to the server on which your SSH keys are located.
124
124
125
-
3. Log in to your project:
125
+
1. Log in to your project:
126
126
127
-
```bash
128
-
magento-cloud login
129
-
```
127
+
```bash
128
+
magento-cloud login
129
+
```
130
130
131
-
3. Add the key:
131
+
1. Add the key:
132
132
133
-
```bash
134
-
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
135
-
```
133
+
```bash
134
+
magento-cloud ssh-key:add ~/.ssh/id_rsa.pub
135
+
```
136
136
137
137
#### Add a key using the Project Web Interface {#add-key-web}
138
138
139
139
You will selectand add your SSH public key to each environment in your account.
140
140
141
-
* Starter: Add to Master (Production) and any environments you create by branching from Master
142
-
* Pro: Add to Master Integration environment. After your Staging and Production environments are provisioned, you can add the SSH keys to those environments.
141
+
*Starter: Add to Master (Production) and any environments you create by branching from Master
142
+
*Pro: Add to Master Integration environment. After your Staging and Production environments are provisioned, you can add the SSH keys to those environments.
143
143
144
144
To add an SSH key using the Project Web Interface:
145
145
146
146
1. Copy your SSH public key to the clipboard.
147
147
148
148
If you do not already have SSH keys on that machine, see [GitHub documentation](https://help.github.com/articles/generating-an-ssh-key) to create them.
149
149
150
-
2. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
151
-
3. In your selected branch, an icon displays if you do not have an SSH key added.
150
+
1. Login and access your project through the [Project Web Interface](https://accounts.magento.cloud).
151
+
1. In your selected branch, an icon displays if you do not have an SSH key added.
1. Access your account. You can open the email you received from Magento Cloud ([email protected]) and click the _Access your project now_ link. Or you can log in to [your {{site.data.var.ee}} account](https://accounts.magento.cloud).
2
-
2. Click the _This project has no code yet_ link next to the Project name.
2
+
1. Click the _This project has no code yet_ link next to the Project name.
3
3
4
4
4. Click **Create a blank site from a template** and click **Continue**. We recommend starting with the Magento template as your initial project option. If you have an existing Magento deployment, you can later import code, extensions, themes, and data after fully deploying this base Magento code.
10
+
1. Click **Create a blank site from a template** and click **Continue**. We recommend starting with the Magento template as your initial project option. If you have an existing Magento deployment, you can later import code, extensions, themes, and data after fully deploying this base Magento code.
11
11
12
12
{:width="650px"}
13
13
14
-
5. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
14
+
1. When prompted, enter your {{site.data.var.ee}} [Magento authentication keys]({{ page.baseurl }}/install-gde/prereq/connect-auth.html) in the provided fields. You created these keys earlier in the Magento Marketplace. Enter the private and public keys and click **Finish**.
15
15
16
16
{:width="650px"}
17
17
18
18
The keys are added to the `auth.json` file in the repository `master` branch, required for all created branches and deployments.
19
19
20
-
6. Wait a few minutes while the project deploys. A status of _Pending_ displays until completed, similar to the following:
20
+
1. Wait a few minutes while the project deploys. A status of _Pending_ displays until completed, similar to the following:
0 commit comments