Deploy a new release
Webscale Pro V3 runs your application in containers with supporting services managed by Webscale. Use this guide to deploy a new release for your environment.
1. Open SSH connect and container shell
Login to the Webscale Control Panel:
- Click the three bars in the upper left site navigation > SSH connect
- Find the NFS instance for your environment and open a terminal session by clicking on the instance link.
2. Switch to the deployment user
On the NFS host, switch to the deployment user (for example webscalebuilder):
sudo -iu webscalebuilder
3. List available images
Use the helper script to list available images for this environment:
list-images
This shows a list of the available container images along with their associated tags. For example:
"sha256:5cc440543cc9acf7abfb4875ba149e5bb339b248c15507475a39f04da12f0c1c": [
"commit-da25261-20240829-192048",
"commit-da25261"
]
"sha256:5d9d78fdc7f6ae26861aafeec977b5db6adc9d757995a7c1b880130c18246621": [
"commit-65d7766-20240903-192941",
"commit-65d7766"
]
"sha256:9dd60263109cacfb16fa85d8c40ccd5e22c50ae924fb137eb76a4aa4c55b7aff": [
"commit-1f723a4",
"commit-1f723a4-20240904-160243"
]
4. Check the current deploy tag
Check which tag is currently in use:
grep DEPLOY_TAG /home/webscalebuilder/.env
Example output:
DEPLOY_TAG=staging
5. Tag the new image for deployment
Choose the image you want to deploy and tag it, using deployment helper scripts, with the deploy tag from the previous step.
The following helper scripts are available for deployments on Webscale Pro V3 environments:
Example: tag by commit
tag-by-commit commit-<hash> <deploy-tag>
Example: tag by branch
tag-by-branch branch-<name> <deploy-tag>
Replace <deploy-tag> with the value from DEPLOY_TAG (for example staging or production).
6. Run the deployment using run-deploy-and-cleanup
The run-deploy-and-cleanup script organizes the necessary actions for deployment into a single command. Running this command will:
- Pull the tagged image from above
- Apply any environment hooks if configured (migrations, cache warmups, etc.)
- Update the running containers
It is recommended to run the deployment in a screen session so it continues if your SSH session drops:
screen -S deploy
run-deploy-and-cleanup
Monitor the terminal output for any errors or warnings during the process.
Deployment logs are also available at:
/var/log/deploy/*
7. Verify the deployment
After run-deploy-and-cleanup completes:
-
Verify the site works as expected in a browser
-
Connect to a container shell
shell -
Run a quick version check using your framework-specific command:
php bin/magento --version # or php bin/console --version
When to contact Webscale
Contact Webscale support if:
run-deploy-and-cleanupexits with an error you do not understand- Containers are not updated to the expected image
- The site shows errors after a successful deployment
Related how-to guides
Feedback
Was this page helpful?
Glad to hear it! Have any more feedback? Please share it here.
Sorry to hear that. Have any more feedback? Please share it here.