Deploying PHP Projects with CelerBuild Using the Symfony Framework Example

This guide demonstrates how to deploy a PHP project using CelerBuild Standard Version, including:

• Branch deployment for development environment
• Tag deployment for production environment
• Tag version rollback operations

We'll use the celerbuild-example-php (opens in a new tab) project built with the Symfony framework.

Note:

• This tutorial uses the Standard Version with the admin user
• For Pro Version features with multiple roles and approval process, please refer to the Pro Version Guide

Prerequisites

1. System Prerequisites

Complete all Prerequisites setup steps

2. PHP Environment Setup

Installing PHP and PHP-FPM

macOS

# Using Homebrew
brew install php
 
# Verify installation
php -v

Ubuntu/Debian

# Update package list
sudo apt update
 
# Install PHP and PHP-FPM
sudo apt install php php-fpm
 
# Verify installation
php -v

CentOS/RHEL

# Install EPEL repository
sudo yum install epel-release
 
# Install PHP and PHP-FPM
sudo yum install php php-fpm
 
# Verify installation
php -v

Note:

• PHP and PHP-FPM should be installed on both the CelerBuild machine and the deployment machine.

3. Composer Setup

Installing Composer

macOS, Ubuntu/Debian, CentOS/RHEL

# Download the installer
php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
 
# Install Composer globally
php composer-setup.php --install-dir=/usr/local/bin --filename=composer
 
# Remove the installer
php -r "unlink('composer-setup.php');"
 
# Verify installation
composer -v

Note:

• Composer should be installed on the CelerBuild machine for managing PHP dependencies.

4. Web Server Setup

Installing Nginx

Ubuntu/Debian

# Update package list
sudo apt update
 
# Install Nginx
sudo apt install nginx
 
# Start Nginx
sudo systemctl start nginx
 
# Enable Nginx to start on boot
sudo systemctl enable nginx
 
# Verify installation
nginx -v

CentOS/RHEL

# Install Nginx
sudo yum install nginx
 
# Start Nginx
sudo systemctl start nginx
 
# Enable Nginx to start on boot
sudo systemctl enable nginx
 
# Verify installation
nginx -v

Nginx Configuration

1. Create Site Configuration File:

Create a new configuration file named my_php_project in /etc/nginx/sites-available/:

   server {
       listen 8081;
       server_name your_server_ip_or_domain;
 
       root /home/ubuntu/celerbuild-example-php/public;
       index index.php index.html index.htm;
 
       location / {
           try_files $uri $uri/ /index.php?$query_string;
       }
 
       location ~ \.php$ {
           include snippets/fastcgi-php.conf;
           fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;
           fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
           include fastcgi_params;
       }
 
       location ~ /\.ht {
           deny all;
       }
   }

2. Enable Site Configuration

Create a symbolic link to sites-enabled:

sudo ln -s /etc/nginx/sites-available/my_php_project /etc/nginx/sites-enabled/

3. Test and Restart Nginx

Test the configuration for syntax errors and restart Nginx:

sudo nginx -t
sudo systemctl restart nginx

These steps will help you configure Nginx to serve your PHP Symfony application.

Note:

• Nginx should be installed on the deployment machine, typically a Linux server, to serve the PHP Symfony application.
• Ensure Nginx is configured to work with PHP-FPM for handling PHP requests.

5. Additional Permissions

Before setting permissions, ensure that your project is created under the current user. In this example, the project celerbuild-example-php is created under the ubuntu user. You can adjust this according to your actual setup.

# Allow others to access the home directory
sudo chmod o+x /home/ubuntu
 
# Allow others to access the project directory
sudo chmod o+x /home/ubuntu/celerbuild-example-php
 
# Add www-data to the ubuntu group to allow Nginx access
sudo usermod -aG ubuntu www-data

Branch Deployment

1. Create Server Infrastructure

Create Server Cluster

• Navigate to Global/Server Clusters
• Create a cluster named "example-php-server-cluster(dev)"

Add Server

• Navigate to the Global/Servers section or go to the Actions menu of the newly created example-php-server-cluster(dev) and select "Servers"
• Select cluster "example-php-server-cluster(dev)"
• Fill in:
  • Server Name
  • Server IP
  • SSH Port (default: 22)

2. Import Project Template

Download Template

• Download project template: celerbuild-example-php-dev.yaml
• Template source: celerbuild-example-php dev template (opens in a new tab)

Import Template

• Navigate to Projects/Projects
• Click "Import YAML"
• Upload the downloaded template

Create Project

• Review and confirm project settings
• Click "Create Project" to finish

Note: This example uses Ubuntu system with ubuntu user. Please adjust the Deployment Configuration (Target Deployment Path, Target Deploy Warehouse Path, Deployment User, etc.) according to your actual environment.

3. Initiating Deployment

1. Go to Operations/Applications
2. Select project "celerbuild-example-php-dev"
3. Fill in Title and Description
4. Click sync icon next to "Branch" and select latest dev branch
5. Click "Submit Application"

For detailed steps, see Creating Deployment

4. Executing Deployment

1. In Operations/Tasks, find your project task
2. Click "Deploy" button
3. On the task page, click "Start Deploy"
4. Monitor Server Status and Operation Logs
5. If issues occur, check error messages and retry deployment after fixing

5. Verification

Access http://server:8081/version (replace "server" with your server address)

# Example command
➜  ~ curl http://server:8081/version
 
# Expected response
{"version":"1.0.3"}

Note:

• Replace "server" with your actual server IP address
• A response similar to {"version":"1.0.3"} indicates successful deployment
• If you cannot access the endpoint, check:
  • Server firewall settings
  • Port 8081 accessibility
  • Application running status

Tag Deployment

1. Create Server Infrastructure

Create Server Cluster

• Navigate to Global/Server Clusters
• Create a cluster named "example-php-server-cluster(prod)"

Add Server

• Navigate to the Global/Servers section or go to the Actions menu of the newly created example-php-server-cluster(prod) and select "Servers"

• Select cluster "example-php-server-cluster(prod)"

• Fill in:

  • Server Name
  • Server IP
  • SSH Port (default: 22)

2. Import Project Template

Download Template

• Download project template: celerbuild-example-php-prod.yaml
• Template source: celerbuild-example-php prod template (opens in a new tab)

Import Template

• Navigate to Projects/Projects
• Click "Import YAML"
• Upload the downloaded template

Create Project

• Review and confirm project settings
• Click "Create Project" to finish

3. Initiating Deployment

1. Go to Operations/Applications
2. Select project "celerbuild-example-php-prod" and Click "Apply Deploy"
3. Fill in Title and Description
4. Click sync icon next to "Tag" and select latest tag
5. Click "Submit Application"

For detailed steps, see Creating Deployment

4. Executing Deployment

Follow the same steps as branch deployment execution.

5. Verification

Access http://server:8081/version (replace "server" with your server address)

# Example command
➜  ~ curl http://server:8081/version
 
# Expected response
{"version":"1.0.1"}

Note:

• Replace "server" with your actual server IP address
• A response similar to {"version":"1.0.1"} indicates successful deployment
• If you cannot access the endpoint, check:
  • Server firewall settings
  • Port 8081 accessibility
  • Application running status

Rollback Operations

Note: Branch deployment rollback is not demonstrated here because the system only maintains the latest committed version. We'll demonstrate rollback using tag deployments instead.

Tag Deployment Rollback Example

1. Initial Deployment (v1.0.3)

For detailed deployment steps, refer to:

For detailed deployment steps, refer to:

• Initiating Deployment
• Executing Deployment

1. Go to Operations/Applications
2. Select project "celerbuild-example-php-prod"
3. Fill in deployment information:

• Title: "Deploy v1.0.3"
• Description: "Initial deployment of v1.0.3"

4. Click sync icon next to "Tag" and select "v1.0.3"
5. Click "Submit Application"
6. Execute deployment and verify:

curl http://server:8081/version
{"version":"1.0.3"}
 

2. Upgrade to v1.0.4

For detailed deployment steps, refer to:

• Initiating Deployment
• Executing Deployment

1. Go to Operations/Applications
2. Create new deployment
3. Fill in deployment information:
   • Title: "Upgrade to v1.0.4"
   • Description: "Upgrading from v1.0.3 to v1.0.4"
4. Select tag "v1.0.4"
5. Submit and execute deployment
6. Verify upgrade:

curl http://server:8081/version
{"version":"1.0.4"}

3. Rollback to v1.0.3

1. In Operations/Applications, find your project
2. Click Actions (three dots) and select "Apply Rollback"
3. Fill in rollback information:
   • Title: "Rollback to v1.0.3"
   • Description: "Rolling back from v1.0.4 to v1.0.3"
4. Click sync icon next to "Select Rollback Tag"
5. Select "v1.0.3" from the available tags
6. Click "Submit Rollback"

4. Execute Rollback

1. Go to Operations/Tasks
2. Find your rollback task
3. Click "Rollback" in Actions
4. Click "Start Rollback" on the task page
5. Monitor Server Status and Operation Logs
6. Verify rollback success:

curl http://server:8081/version
{"version":"1.0.3"}

For detailed rollback instructions, see:

• Rollback Deployment
• Execute Deployment Task

Congratulations! You have successfully learned how to deploy Symfony Framework using CelerBuild Standard Edition, including branch deployment, tag deployment, and tag version rollback operations! 🎉