Giter VIP home page Giter VIP logo

deployer-cron's Introduction

Cron functions for Deployer

Latest Version Latest Unstable Version Software License Build Status

Simple handling of cronjobs in your deployment process using the Cron builder library.

Installation

$ composer require setono/deployer-cron

Usage

The easiest usage is to include the cron recipe which hooks into default Deployer events:

<?php
// deploy.php

require_once 'recipe/cron.php';

Deployer parameters

The following Deployer parameters are defined:

Parameter Description Default value
cron_source_dir The directory to search for cronjob config files etc/cronjobs
cron_delimiter The marker in the crontab file that delimits the generated cronjobs from manually added cronjobs {{application}} ({{stage}})
cron_variable_resolvers An array of variable resolvers to add to the cron builder []
cron_context The context to give as argument to the CronBuilder::build method [ 'stage' => get('stage') ]
cron_user The user onto which the crontab should be added get('http_user') if you are root, else ''
cron_dry_run If true, this recipe will not apply the generated crontab false

NOTICE that the default value of cron_variable_resolvers is an empty array, but this lib will always add a ReplacingVariableResolver with the variables described in the section below.

Build context

The default build context is defined in the Deployer parameter cron_context. It adds the stage as context which means you can use the condition key in your cronjob config:

# /etc/cronjobs/jobs.yaml

- schedule: "0 0 * * *"
  command: "%php_bin% %release_path%/bin/console my:dev:command"
  condition: "context.stage === 'dev'"

The above cronjob will only be added to the final cron file if the deployment stage equals dev.

Extra variables available

This library also adds more variables you can use in your cronjob configs:

  • %application%: Will output the application name
  • %stage%: Will output the stage, i.e. dev, staging, or prod
  • %php_bin%: Will output the path to the PHP binary
  • %release_path%: Will output the release path on the server

With these variables you can define a cronjob like:

# /etc/cronjobs/jobs.yaml

- schedule: "0 0 * * *"
  command: "%php_bin% %release_path%/bin/console my:command"

And that will translate into the following line in your crontab:

0 0 * * * /usr/bin/php /var/www/your_application/releases/23/bin/console my:command

deployer-cron's People

Contributors

dependabot[bot] avatar localheinz avatar loevgaard avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

localheinz shop25

deployer-cron's Issues

PHP8 support

[InvalidArgumentException]                                                                                                  
Package setono/deployer-cron has a PHP requirement incompatible with your PHP version, PHP extensions and Composer version 

Arbitrary configuration loading

Hi

Thanks for this deployer addon, really helpful!

I just set it up in a local project and wanted to put the jobs.yaml into the root directory instead of cluttering the project setup with an etc/* folder that wouldn't be used otherwise โ€“ most of the configs, like the deployer configuration files, are in the project root anyways.

I discovered that the deployment always failed because deployer-cron tried to load any file from the configured directory; .sql, .md, other .yml files, etc. I think it would be a better solution to either have a fixed filename or some sort of resolver for files that is restricting to certain file types. Loading SQL files wouldn't be a use case in the real world anyway.

Parallel deployment causes inconsistency in resulting crontab

When deploying two stages in parallel on the same server with the same user, the resulting crontab can be overwritten by the job that finishes last.

To fix this we should put a 'cron lock' that makes sure that only one process can edit the crontab at a time

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.