Đặt vấn đề: Khi bạn làm việc trong một dự án thì bạn sẽ có lúc gặp vấn đề về deploy code lên Server. Cách đầu tiên là bạn chọn cách deploy thủ công, tự mình làm từ a-z, điều này dẫn đến việc deploy dễ bị sai sót. Cách thứ 2 là chọn 1 thèn thứ 3 nào đó nó làm giúp việc đó cho mình, thì hôm nay mình sẽ giới thiệu với các bạn 1 tool deploy dành cho PHP. Đó là Deployer

1 What is Deployer?

Như đã nói ở trên, Đây là một deployment tool viết bằng PHP và nó support cho nhiều framework như Laravel, codeigniter … Bạn có thể tìm hiểu thêm ở đây

Một số tính năng nổi bật:

• Dễ setup và dễ học
• Sử dụng recipes cho các framework
• Có thể chạy các task song song mà không cần extenssion
• Rollback lại bản release trước nếu gặp sự cố khi deploy
• Xác thực với SSH
• Nói KHÔNG với downtime deployments

Main concept của Deployer là recipe, một file PHP định nghĩa các task cần thực hiện trong quá trình deploy. recipe có thể require và extend hoặc override các recipe khác.

2 Installation

Có 3 cách để setup Deployer

• Download file .phar
• Install thông qua composer
• Install qua các distribution composer

Mình sẽ hướng dẫn các bạn cài đặt cách đầu tiên, Nếu bạn muốn tìm hiểu thêm có thể vào đây

1
2
3
curl -LO https://deployer.org/deployer.phar
mv deployer.phar /usr/local/bin/dep
chmod +x /usr/local/bin/dep

Sau khi setup xong thì bạn chuyển đến folder dự án và chạy

1
dep init

Lệnh này sẽ tạo ra một file deploy.php trong thư mục hiện tại. File này chính là 1 recipe chứa cấu hình và các task để triển khai trong quá trình deploy. Mặc định, tất cả các recipe đều extends từ các common recipe

3 Configuration

Deployer cho phép chúng ta config và get các param thông qua set, get function. Trong đó, params có thể là giá trị hoặc 1 function.

1
2
3
4
5
6
7
8
9
set('param', 'value');

set('current_path', function () {
    return run('pwd');
});

task('deploy', function () {
    $param = get('param');
});

Bạn có thể sử dụng hai cặp ngoặc nhọn hoặc sử dụng nối chuỗi và hàm get đê bind các params vào command

1
2
run('cd  && command');
run('cd ' . get('release_path') . ' && command');

Một số params mà chúng ta cần quan tâm khi cấu hình hệ thống gồm.

4 Tasks

Các repice sẽ định nghĩa các task, sau đó chúng ta có thể sử dụng dep để thực thi các tác vụ này. Ngoài ra bạn có thể thêm mô tả cho task thông qua hàm desc

1
2
3
4
desc('My task');
task('my_task', function () {
    run(...);
});

Run task

1
dep my_task

Nếu task của bạn chỉ có lệnh run hoặc chỉ chạy 1 command thì bạn có thể define 1 task đơn giản như này:

1
task('build', 'npm build');

Mặc định thì các task này sẽ cd tới release_path

Bạn cũng có thể define nhiều command như dưới:

1
2
3
4
5
task('build', '
    gulp build;
    webpack -p;
    echo "Build done";
');

Bạn có thể combine các task lại thành 1 group như này:

1
2
3
4
5
6
7
8
task('deploy', [
    'deploy:prepare',
    'deploy:update_code',
    'deploy:vendors',
    'build',
    'deploy:symlink',
    'cleanup'
]);

Ngoài ra bạn có thể define task chạy trước hoặc sau một số task cụ thể:

1
2
3
4
5
// Trước khi chạy task artisan:migrate thì run task deploy:symlink
before('deploy:symlink', 'artisan:migrate');

// Sau khi deploy:failed run thì sẽ run task deploy:unlock
after('deploy:failed', 'deploy:unlock');

Filtering

Once

chỉ thực hiện task duy nhất 1 lần

1
task('do', ...)->once();

By stage

chỉ run trên stage được define

1
2
3
task('test', function () {
    ...
})->onStage('staging');

By roles

chỉ run trên role được define

1
2
3
4
desc('Migrate database');
task('migrate', function () {
    ...
})->onRoles('db');

Note: chúng ta có thể define chạy trên nhiều role. onRoles(‘app’, ‘db’, …)

By hosts

chỉ run trên host được define

1
2
3
4
5
desc('Migrate database');
task('migrate', function () {
    ...
})->onHosts('db.domain.com');

Note: tương tự với role, chúng ta có thể define chạy trên nhiều host. onHosts(‘db.domain.com’, ‘api.domain.com’, …)

Local tasks

Chạy task dưới local và chỉ chạy 1 lần

1
2
3
task('build', function () {
    ...
})->local();

Overriding tasks

Đôi khi bạn muốn các task chạy các command khác so với default thì bạn có thể overide lại bằng cách:

1
2
3
4
task('deploy:update_code', function () {
    // Your custom update code
    upload(...);
});

Parallel task execution

Khi bạn phải deploy lên nhiều server, Deployer sẽ chạy từng task trên các server đó, như hình dưới

Để deploy nhanh hơn thì Deployer cho phép ta chạy các task song song trên các server bằng cách thêm --parallel hoặc -p

Bạn có thể limit lại số concurrent task, Mặc định sẽ có tối đa 10 task được chạy đồng thời

1
dep deploy --parallel --limit 2

5 Hosts

Define host trong Deployer là cần thiết để deploy application. Nó có thể là remote machine, local machine hoặc EC2 … Mỗi host gồm hostname, stage 1 hoặc nhiều roles và một số parameters

Bạn có thể định nghĩa host thông qua host function trong file deploy.php

1
2
3
4
host('domain.com')
    ->stage('production')
    ->roles('app')
    ->set('deploy_path', '~/app');

Host có thể được viết bằng file yaml như ví dụ dưới hosts.yml

1
2
3
4
domain.com:
  stage: production
  roles: app
  deploy_path: ~/app

Nếu bạn dùng file yaml để define host thì bạn cần phải thêm dòng này vào file deploy.php

1
inventory('hosts.yml');

File hosts.yml có thể chưa nhiều definitions giống nhau thì bạn có thể dùng YAML extend syntax:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
.base: &base
  roles: app
  deploy_path: ~/app
  ...

www1.domain.com:
  <<: *base
  stage: production
  
beta1.domain.com:
  <<: *base
  stage: beta
    
...

Bài viết này mình chỉ giới thiệu về Deployer, Bài viết tiếp theo mình sẽ giới thiệu về cách deploy Laravel project lên EC2 bằng Deployer thông qua Bitbucket pipeline tại đây