Clone and branch the project

Previous step:

Set up the Magento file system owner

The Magento Commerce Cloud project is a Git repository of Magento code. Each active branch in the Integration environment includes a database and services to fully access the Magento site and store. You can clone the project and create an active branch from the Integration environment to develop code and add extensions using your local workstation.

Clone the project

The following instructions use a combination of Magento Cloud CLI commands and Git commands to clone a master environment from your project to your local workstation. To see a full list of Magento Cloud CLI commands, use the magento-cloud list command.

Some Git commands cannot complete an action in your Magento Commerce Cloud project. For example, you can create a new branch using a Git command, but you cannot create and activate a new environment using the git checkout -b <branch-name> command. You must create an environment using the magento-cloud environment:branch <branch-name> command for the environment to become active. Alternatively, you can use the Project Web UI to create active environments. See Magento CLI reference.

To clone a project master environment:

  1. Log in to your local workstation with a Magento file system owner account.

  2. Change to the web server or virtual host docroot directory.

  3. Log in to the Magento Cloud CLI.

    1
    
    magento-cloud login
    
  4. List your projects.

    1
    
    magento-cloud project:list
    
  5. Clone a project.

    1
    
    magento-cloud project:get <project-ID>
    

    When prompted for a directory name, enter magento2.

  6. Change to the magento2 directory.

  7. List available environments for the project.

    1
    
    magento-cloud environment:list
    

    The magento-cloud environment:list command displays environment hierarchies, whereas the git branch command does not.

  8. Fetch the remote branches.

    1
    
    git fetch magento
    
  9. Pull updated code.

    1
    
    git pull magento <environment-ID>
    

Change the Magento ADMIN variables

We recommend changing the environment-level variables for the Magento Admin URL and administrator account. It is a best practice to configure these settings for security reasons prior to branching from the cloned master environment. All branches created from the master branch inherit the environment-level variables and their values.

  • ADMIN_EMAIL—An email address for the administrative user. This address is used to send password reset notifications.
  • ADMIN_USERNAME—A username for the administrative user with the ability to create other users, including administrative users. This username defaults to the License Owner email address. You can use the default value, or change it to a secure username.
  • ADMIN_PASSWORD—A password for the administrative user. When the project was created, the License Owner received a default password in email.
  • ADMIN_URL— The relative URL to access the Admin panel, such as <domain>/admin. For security reasons, we recommend you choose a value other than admin or backend or another term that is easy to guess.

Make note of any updated values so that you can use them to install Magento from the command line and to verify the installation. The values for the ADMIN_EMAIL, ADMIN_USERNAME, and ADMIN_PASSWORD variables are used only for installation.

To view existing variables:

If you are not sure that the master branch has all Magento Admin variables and settings configured, you can view a list of existing variables:

1
magento-cloud variables
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
Variables on the project Project-Name (<project-id>), environment <environment-name>:
+----------------------------+-------------+-------------------------------------+
| Name                       | Level       | Value                               |
+----------------------------+-------------+-------------------------------------+
| php:blackfire.agent_socket | project     | tcp://blackfire.magento.cloud:8307  |
| env:COMPOSER_AUTH          | project     | {                                   |
|                            |             |    "http-basic": {                  |
|                            |             |       "repo.magento.com": {         |
|                            |             |       "username":                   |
|                            |             | "<public-key>",                     |
|                            |             |       "password":                   |
|                            |             | "<private-key>"                     |
|                            |             |     }                               |
|                            |             |   }                                 |
|                            |             | }                                   |
| ADMIN_EMAIL                | project     | admin@123.com                       |
| ADMIN_EMAIL                | environment | admin@123.com                       |
| ADMIN_PASSWORD             | environment | password                            |
| ADMIN_URL                  | environment | admin123                            |
| ADMIN_USERNAME             | environment | admin                               |
+----------------------------+-------------+-------------------------------------+

To set a variable:

1
magento-cloud vset <variable-name> <variable-value>

Every time you add or modify a variable using the web interface or the CLI, the branch automatically redeploys.

To add variables using the Project Web Interface:

Alternatively, you can add or update variables in the Project Web Interface.

  1. Log in to your Magento Commerce Cloud account.

  2. Click the Configure environment gear icon Configure your environment next to the Project name.

    Project without code

  3. Select the Variables tab.

  4. Click Add Variable.

  5. Enter the Name and Value for the variable. For example, enter ADMIN_EMAIL and your License Owner email address or another accessible email for resetting the password for the default admin account.

    Project variable

  6. Click Add variable. After you add the variable, wait until deployment completes.

Create a branch for development

After cloning your project and updating the Magento administrator account configuration, you can branch for development. As stated earlier, you must create an environment using the magento-cloud environment:branch <branch-name> command or the Project Web Interface for the environment to become active.

  • For Starter, consider creating a branch for staging, then create a development branch based on the staging branch.
  • For Pro, create development branches based on the Integration environment.

To branch from master:

  1. Do one of the following from the CLI.

    • To create a new environment:

      1
      
       magento-cloud branch <environment-name> <parent-environment-ID>
      
    • To check out an existing environment:

      1
      
      magento-cloud checkout <environment-name>
      
  2. Update dependencies.

    1
    
    composer --no-ansi --no-interaction install --no-progress --prefer-dist --optimize-autoloader
    
  3. Create a snapshot of the environment.

    1
    
    magento-cloud snapshot:create -e <environment-ID>
    

Next step:

Install Magento