Management Console

Platform.sh provides a responsive management console which allows you to interact with your projects and manage your environments.

Management Console

Everything you can do with the management console you can also achieve with the CLI (Command Line Interface).

Platform.sh recently launched a new web management console. This documentation refers to the new console. To access the legacy user interface select the user drop-down in the top right and click Legacy under the "Console mode" option. Documentation for the legacy interface is still available until it is fully retired.

Environment List

From your project's main page, each of the environments are available from the pull-down menu ENVIRONMENT at the top of the page.

Environment Pull-down

There is also a graphic view of your environments on the right hand side, where you can view your environments as a list or as a project tree.

Environment Activity

The name of the environment is struck out if it's been disabled. If it has an arrow next to it, this means the environment has children.

Activity Feed

The management console displays all the activity happening on your environments. You can filter messages per type.

Environment Activity

Within a project`s environment, the management console exposes 4 main actions and 4 drop-down command options that you can use to interface with your environments.

Header

Button Actions

Branch

Header Branch

Branching an environment means creating a new branch in the Git repository, as well as an exact copy of that environment.

The new branch includes code, all of the data that is stored on disk (database, Solr indexes, uploaded files, etc.), and also a new copy of the running services (and their configuration) that the application needs. This means that when you branch an environment, you also branch the complete infrastructure.

During a branch, three things happen:

  • A new branch is created in Git.
  • The application is rebuilt on the new branch, if necessary.
  • The new branch is deployed.

After clicking Branch a dialog box will appear that will provide commands to execute future merges from the command line using the Platform.sh CLI.

Branch confirmation cli

Merge

Header Merge

Merging an environment means introducing the code changes from a branch to its parent branch and redeploying the parent.

During a merge:

  • The code changes are merged via Git to the parent branch.
  • The application is rebuilt on the parent branch, if necessary.
  • The parent branch is deployed.

Rebuilding the application is not necessary if the same code was already built (for any environment): in this case you will see the message Slug already built for this tree id, skipping.

After clicking Merge a dialog box will appear that will provide commands to execute future merges from the command line using the Platform.sh CLI.

Merge confirmation cli

Sync

Header Sync

Synchronization performs a merge from a parent into a child environment, and then redeploys that environment. You have the option of performing a Sync on only the code, replacing the data (i.e. databases) of that environment from its parent, or both. These options are provided in a separate dialog box that will appear when you click the Sync button, along with the Platform.sh CLI commands that perform the same action.

sync confirmation cli

Be aware that sync uses the Snapshot mechanism and will have the same caveats.

Note that Sync is only available if your branch has no unmerged commits, and can be fast-forwarded. It is good practice to take a snapshot of your environment before performing a synchronization.

Backup

Header Backup

Creating a snapshot for an environment means saving a copy of the database so that it can be restored (in other words, create a backup). You will see the snapshot in the activity feed of you environment in the Platform.sh management console where you can trigger the restore by clicking on the restore link.

After clicking Backup a dialog box will appear that will provide commands to execute future merges from the command line using the Platform.sh CLI.

Backup confirmation cli

You can also use the CLI with:

$ platform environment:backup

to create a snapshot,

$ platform environment:restore

and to restore an existing snapshot.

Command Pull-downs

URLs

Header URL

The URLs pull-down exposes the domains that can be used to access application environments from the web.

GIT

Header Git

The Git pull-down displays the commands to use to clone the codebase via Git.

CLI

Header CLI

The CLI pull-down displays the commands to get your project set up locally with the Platform.sh CLI.

SSH

Header SSH

The SSH pull-down display the commands to access your project over SSH.