Basic project information

Projects in Magento Enterprise Cloud Edition (ECE) represent the master branch and all children branches of your Magento code, extensions, themes, and more for your store and sites. These branches are fully functional environments with direct access for testing. To manage and review your project information, branches, SSH and URL links, and more, you can use the Magento Web Interface or CLI commands.

The project console enables you to:

  • Create and manage projects
  • Access up to eight active branches using SSH, CLI, and web links
  • Configure environment settings, environment variables, and routes
  • Manage users
  • Manage Git branches

Log in to your project

The web console URL for your project is available in the following ways:

  • Your welcome e-mail to Magento ECE
  • The Magento Enterprise Cloud Edition command-line interface (CLI)

To find the project URL using the Magento CLI:

  1. Log in to the machine on which your SSH keys are stored.
  2. Log in to your project:

    magento-cloud login
    
  3. Enter the following command:

    magento-cloud project:list
    

    A sample result follows:

    Your projects are:
    
    +---------------+--------------+---------------------------------------------------+
    | ID            | Title        | URL                                               |
    +---------------+--------------+---------------------------------------------------+
    | pwga254dhx97o | Magento 2    | https://us.magento.cloud/#/projects/pwga254dhx97o |
    +---------------+--------------+---------------------------------------------------+
    
  4. Enter the value in the URL column in a web browser.

In a web browser, enter the project URL to access the console and project. When prompted, log in to your project using Bitbucket, GitHub, Google, or an e-mail address and password.

Log in to a project

Access your project and environments

The Web Interface provides several ways to access your project and environments:

  • Your storefront URL for each active (up to eight)
  • Secure Shell (SSH), a way to interact with services using a command terminal
  • Clone the project using the Magento ECE CLI
  • Clone the project using Git

To access projects and environments through the Web Interface:

  1. Log in to your project.
  2. Hover the mouse pointer over Access Project as the following figure shows:

    Access your project by URL or SSH

  3. For example, to view your storefront, click the Web Access link.

    For more information about using SSH, see SSH to an environment.

  4. To clone the project using either the Magento Enterprise Cloud Edition CLI or Git, use the links in the field under the branch name.

    The following figure shows an example.

    Clone the project

    Click either CLI or Git to display the appropriate clone command. Use the Copy to clipboard (Copy to clipboard) button to copy the command to the clipboard.

Get started configuring your project

Configuring a project means:

  • Managing users
  • Using a deploy key to pull code from a private repository

To configure your project:

  1. Log in to your project.
  2. Click configure your project (Configure project) next to the project name.
  3. See one of the following for more information:

Get started configuring an environment

Configuring an environment means:

  • Environment settings
  • Configuring environment variables
  • Configuring routes
  • Managing users

To configure an environment:

  1. Log in to your project.
  2. Click Configure environment under the project name, as the following figure shows.

    Configure environment

  3. See one of the following for more information:

Environment settings

The following table shows available environment settings.

Option Description
Environment status An environment can be either active or inactive. You'll do most of your work in an active environment. After merging an environment with its parent, you can optionally delete the environment, making it inactive. To delete an environment, click Delete. You can active an inactive environment later.
Outgoing emails Setting to On means that code in your environment can send and receive e-mails (for example, using PHP email() function.
HTTP access control Setting to On enables you to configure security for the project's Web Interface using a login and also IP address access control.

Set environment variables

As discussed in Overview of environment variables, environment variables are settings specific to an environment. Variables can be either text or JSON format.

To view or edit environment variables, you must have at minimum the project reader role with environment admin privileges.

For example, you can change the Magento Admin administrative password using environment variables as follows:

  1. Click Add Variable.
  2. In the Name field, enter ADMIN_PASSWORD.
  3. In the Value field, enter the administrator’s password.

    The following figure shows an example.

    Set environment variables

  4. Click Add Variable.
  5. Wait while the environment deploys.

Configure routes

As discussed in routes.yaml, routes (or URLs) used to access your Magento storefront. See that section for details about what the options mean.

The following figure shows an example.

Configure a route

View environment history

An environment’s history includes:

  • Initial creation
  • Snapshots
  • Syncs and merges
  • Code pushes

To view an environment’s history:

  1. Log in to your project.
  2. In the left pane, click the name of an environment.

    The following figure shows a sample history.

    Sample environment history

    The history shows, from oldest to newest:

    • Environment branched from FeatureX
    • Environment sync’d with the parent
    • Environment snapshot created

      We recommend creating a snapshot before you make any code changes.

    • Environment variable added
    • Environment snapshot created