1.2

Cloud Admin UI Settings

Determine how to locate settings with Cloud Admin UI: Project settings, user management, environments, logs, and environment controls.

Exam Critical: Understanding the Cloud Admin UI is essential for the AD0-E717 exam! Know how to locate project settings, manage environments, access logs, and use environment controls.

Cloud Admin UI Navigation

mindmap root((Cloud Admin UI)) Project Settings User management Project variables General settings Environments Access links Environment list Status indicators Logs var log location SSH access Pro platform logs Environment Controls Disable enable Outgoing emails Search engine indexing HTTP access control Action Buttons Git CLI commands Branch create Merge to parent Sync code data Backup snapshot

Cloud Admin UI Overview

The Cloud Admin UI provides a web interface to manage your Commerce Cloud project, environments, settings, and deployments.

Important: Use this as a guide for hands-on experience with the Admin UI, not just reading!

Project Settings

Where to Find Project Settings

Access project-level settings from the main project dashboard:

  • User Management: Add/remove users and manage access permissions
  • Project Variables: Configure environment variables available across all environments
  • General Settings: Project name, region, and configuration

User Management

Manage team access to the Cloud project:

  • Add new users with email addresses
  • Set permission levels (Admin, Contributor, Viewer)
  • Remove user access
  • Manage SSH key access
Security: Only grant necessary permissions. Use Viewer role for read-only access.

Project Variables

Configure variables that apply to all environments:

  • Set environment-specific configuration
  • Store API keys and credentials securely
  • Configure application settings
  • Available across all branches/environments
Best Practice: Use project variables for shared configuration; environment variables for environment-specific settings.

Locate Environments, Access Links, and Logs

Environments View

The Environments page shows your project's environment tree:

  • Visual tree structure of all branches/environments
  • Active vs inactive environments
  • Parent-child relationships
  • Environment status indicators

Environment Tree Structure

For Starter:

  • master (production)
  • staging
  • integration branches

For Pro:

  • master (production)
  • staging
  • integration (base)
  • development branches

Access Links

Each environment provides multiple access methods:

  • Web URL: Direct link to frontend
  • SSH Access: Command-line access to environment
  • Admin Panel: Link to Magento admin
  • Database Access: MySQL connection details
Quick Access: Click environment name to see all access links and credentials.

Logs

Log Locations

Logs are stored in different locations depending on environment tier:

Starter & Pro Integration Environments

/var/log

Access via SSH to the environment.

Pro Staging & Production

/var/log/platform/

Important for Pro: You must log into all three nodes to access logs across the cluster.

Accessing Logs

  • SSH into the environment
  • Navigate to log directory
  • Use commands like tail, less, or grep
  • Download logs for local analysis if needed

Common Log Files

  • deploy.log - Deployment process logs
  • system.log - Magento system logs
  • exception.log - PHP exceptions
  • debug.log - Debug information
  • error.log - Server error logs

Environment Control Panel Actions

The Environment Control Panel provides basic actions for each environment:

  • View Logs: Access deployment and application logs
  • Restart Services: Restart web server, cache, etc.
  • Clear Cache: Flush Magento and platform caches
  • Redeploy: Trigger a new deployment
  • Delete Environment: Remove inactive environments

Environment Settings

Inside each environment's configuration, you can change settings:

Available Settings

1. Environment Status

  • Enable or disable the environment
  • Disabled environments don't consume resources
  • Cannot access disabled environments via web

2. Outgoing Emails

  • Disabled by default in all non-production environments
  • Must explicitly enable for testing email functionality
  • Prevents accidental customer emails from staging/integration
Important: Outgoing emails are disabled by default to prevent sending test emails to real customers!

3. Search Engine Indexing

  • Control whether search engines can index the environment
  • Disable for staging/development to prevent duplicate content issues
  • Enable only for production

4. HTTP Access Control

  • Restrict access with username/password (HTTP Basic Auth)
  • Ideally used on staging to prevent search engines and unauthorized access
  • Add multiple username/password combinations
  • Protects non-production environments
Best Practice: Always enable HTTP access control on staging to prevent public access and search engine crawling.

Five Important Environment Buttons

At the top of each branch/environment, there are 5 very important buttons:

1. 📋 Git/CLI Access

  • Provides commands and git remote details
  • Shows how to load project locally to your system
  • Includes SSH connection string
  • Git clone command with authentication
git clone <project-url>
magento-cloud checkout <environment>

2. 🌿 Branch (Create New Environment)

  • Create a new branch (environment) from the current branch
  • Only enabled if you have permission and available environments
  • Creates child environment with copied data
Note: Branch and environment are used interchangeably. An environment is a branch that is publicly accessible via the web (when enabled).

3. 🔀 Merge

  • Merges the current branch to its parent
  • Integration → Staging
  • Staging → Master
  • Not available on master branch (no parent to merge to)
  • Triggers automatic deployment to parent environment
Important: Merge button is NOT available on master branch!

4. 🔄 Sync

  • Syncs code and/or data and files from parent
  • Can sync code only, data only, or both
  • Also available via magento-cloud CLI
  • Useful for refreshing integration with production data
magento-cloud environment:synchronize

5. 💾 Backup (Snapshot)

  • Creates a backup/snapshot of the environment
  • Includes database and files
  • Can restore from snapshots later
  • Recommended before major changes
Best Practice: Always create a snapshot before merging to production or making major configuration changes.

Key Terminology

Branch vs Environment

The DevDocs and Admin UI use branch and environment interchangeably:

  • Branch: Git branch in your repository
  • Environment: A branch that is activated and publicly accessible via the web
  • An environment is an enabled branch
  • Inactive branches exist in git but don't have running environments

Pro Environment Specifics

Three-Node Cluster

For Pro Staging and Production:

  • Runs on three separate nodes for fault tolerance
  • Must log into all three nodes to access complete logs
  • Load balanced across nodes
  • Higher availability and performance
Remember: Pro production has 3 nodes - check logs on all of them!

Further Reading

Exam Tips

  • Logs: /var/log for Starter/Integration; /var/log/platform/ for Pro Staging/Production (3 nodes).
  • Outgoing emails: Disabled by default in all environments.
  • HTTP Access Control: Ideally used on staging to prevent unauthorized access.
  • 5 Buttons: Git/CLI, Branch, Merge, Sync, Backup.
  • Merge: Not available on master (no parent). Integration→Staging→Master.
  • Branch vs Environment: Environment = enabled branch accessible via web.
  • Pro Logs: Must check all 3 nodes for complete log coverage.
  • Sync: Available via UI and magento-cloud CLI tool.