Download the PHP package shopsys/deployment without Composer

On this page you can find all versions of the php package shopsys/deployment. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of shopsys/deployment

Informations about the package deployment

Kubernetes Deployment

How to install

  1. Install package composer require shopsys/deployment

  2. Copy deploy-project.sh into your project to deploy/deploy-project.sh

  3. Create or copy htpasswd file with login credentials to deploy/basicHttpAuth

    Default login for basicHttpAuth is username/password For info about how change http auth credentials see Change HTTP auth

  4. Update your gitlab-ci.yml

    • create new stage with name deploy:

    • Add new deploy template:

    • Add new jobs for deploy devel and production:

  5. Set Environment variables to in Gitlab (Settings -> CI/CD -> Variables)

  6. Push changes and have fun

Environment Variables

Environment variables can be set in Gitlab (Settings -> CI/CD -> Variables)

If you want to define your custom variables see Define custom variables section

Name Example Description Scope
DEPLOY_REGISTER_USER deploy Credentials for downloading docker images *1) All
DEPLOY_REGISTER_PASSWORD *** Credentials for downloading docker images *1) All
DISPLAY_FINAL_CONFIGURATION 1 OR 0 Display configurations after kubernetes scripts are prepared All
RUNNING_PRODUCTION 1 OR 0 Enable/disable HTTP auth and mailer whitelist production/devel
FIRST_DEPLOY 1 OR 0 Set to 1 if you are deploying project instance first time production/devel
DOMAINHOSTNAME* example.com Variable contains URL address for accessing website. See Add more or less domains production/devel
ELASTICSEARCH_URL username:password@elasticsearch Elasticsearch login URL All
POSTGRES_DATABASE_IP_ADDRESS 127.0.0.1 Postgres host IP address production/devel
POSTGRES_DATABASE_PORT 5432 Postgres port All
POSTGRES_DATABASE_PASSWORD *** Postgres login password production/devel
PROJECT_NAME project-prod Name of project (Used for namespace, prefixes and S3 bucket) - must be distinct for production/devel with prod/devel suffix production/devel
S3_API_HOST https://s3.vshosting.cloud S3 API Host All
S3_API_USERNAME s3user S3 API username All
S3_API_PASSWORD *** S3 API password All
APP_SECRET *** Used to add more entropy to security related operations All
RABBITMQ_DEFAULT_USER rabbitadmin Default user used for RabbitMQ and the management service All
RABBITMQ_DEFAULT_PASS *** Password for the default RabbitMQ user All
RABBITMQ_IP_WHITELIST 123.456.123.422, 423.534.223.234 IP Addresses (separated by comma) for which is the RabbitMQ Management accessible All

*1) Credentials can be generated in Gitlab (Settings -> Repository -> Deploy Tokens) with read_registry scope only

You can add your custom variables. Do not forget to edit deploy-project.sh

Customize deployment

You can override kubernetes manifests by place your custom manifest into orchestration/kubernetes/ path in your project

You need to mirror folders to be able to override manifests

Create new cron instance

  1. Create new Phing target that will run your cron:

  2. Declare new cron to your deploy configuration file deploy-project.sh:

    As a key there is used phing target that you created in step 1. and value represents crontab timer

Add more or less domains

This example will work with 3 domains

  1. Create environment variable for every domain:

    Name Value
    DOMAIN_HOSTNAME_1 mydomain.prod.shopsys.cloud
    DOMAIN_HOSTNAME_2 sk.mydomain.prod.shopsys.cloud
    DOMAIN_HOSTNAME_3 en.mydomain.prod.shopsys.cloud
  2. Edit deploy-project.sh

Define custom variables

  1. Create Environment variable

  2. Edit deploy-project.sh

    Left part is name of variable in application and right part is name of variable Gitlab.

Set custom Redis version

Add new variable to deploy/deploy-project.sh and specify your redis version

Enable Horizontal pod autoscaling

Add new variables to deploy/deploy-project.sh to enable pod autoscaling:

How to launch only some domains

Add to deploy/deploy-project.sh new array FORCE_HTTP_AUTH_IN_PRODUCTION with domains which should be not accessible without HTTP auth:

Change HTTP auth

  1. Generate new HTTP auth string (for example here), or by command htpasswd -nb username password
  2. Replace or add new HTTP auth string to deploy/basicHttpAuth
  3. Set new credentials to variable in deploy/deploy-project.sh

Whitelist IP addresses

You need only to add IP address to deploy/deploy-project.sh to WHITELIST_IPS variable

TIP: It would be nice to have all IP addresses described like:

Notify about deployment on Slack

You can enable automatic notification of your deployment directly into Slack channel. It has some features:

  1. Notify about starting of deployment with a preview of features

[!TIP] If you are using Jira and you use [ABC-123] in the commit message, it will automatically create a link to the URL that is specified by JIRA_URL environment variable

[!TIP] Script will exclude commits that contain !ignore keyword

  1. Notify about the end of deployment. There are two possible alerts - Success and Error

This script works only with Gitlab and Slack, but you can override deploy/slack-notification.py if you want to change behavior. For Slack, you have to create some Slack App with permissions (chat:write, chat:write.public).

There has to be set some environment variables list in the table bellow:

ENVIRONMENT VARIABLE Additional information
CI_API_V4_URL Automatic by Gitlab
CI_PROJECT_ID Automatic by Gitlab
CI_JOB_URL Automatic by Gitlab
CI_COMMIT_SHA Automatic by Gitlab
API_TOKEN Token for Gitlab API that has access to read deployments
JIRA_URL Set URL for link Jira ID to Jira.
SLACK_TOKEN Slack Bot User OAuth Token
SLACK_CHANNEL Channel ID to post messages into. This variable should be set only for production Environment
SLACK_DISABLE_CHANGES If set to true, no message with changes will be posted

All versions of deployment with dependencies

PHP Build Version
Package Version
No informations.
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package shopsys/deployment contains the following files

Loading the files please wait ....