Giter VIP home page Giter VIP logo

gulp-elastic-beanstalk-deploy's Introduction

gulp-elastic-beanstalk-deploy

A Gulp module for deploying to AWS Elastic Beanstalk

This plugin helps you to integrate your deployment task on the Amazon AWS Elastic Beanstalk service into gulp. Your deployment job will be more mainatainable and efficient, so that you can increase productivity.

Based on gulp-beanstalk-deploy by SeungJae Lee.

Getting Started

You can install plugin by this command:

$ npm install gulp-elastic-beanstalk-deploy

Overview

gulp.task('deploy', function(cb) {
    eb({
        // options here
    }, cb)
});

Options

A * indicates a mandatory option.

profile
  • Type: string

The AWS profile to use. This refers to an IAM user with credentials in the ~/.aws/credentials file.

accessKeyId
  • Type: string
  • Default: ~/.aws/credentials

The AWS access key id. If nothing is passed, it will use your local AWS profile credential.

secretAccessKey
  • Type: string
  • Default: ~/.aws/credentials

The AWS access secret access key. If nothing is passed, it will use your local AWS profile credential.

region *
  • Type: string

Your application region. It must be provided.

applicationName *
  • Type: string

Your application name. It must be provided.

environmentName *
  • Type: string

Your application enviroment name. It must be provided.

versionLabel
  • Type: string
  • Default: sourceBundle file name without the extension
description
  • Type: string

Your deployment description.

settings
  • Type: Array

Your environment setting parameters.

waitForDeploy
  • Type: boolean
  • Default: true
checkIntervalSec
  • Type: number
  • Default: 2sec

Interval time to check deploying status. (sec)

s3Bucket
  • Type: object
  • Default:
{
    bucket: '',    // applicationName
    key: ''        // sourceBundle basename
}
sourceBundle *
  • Type: string

Archive file path to upload. It must exists in your local file system, which means the archive file must be prepared before deployment task.

uploadOnly
  • Type: boolean
  • Default: false

Used if you want to upload a package to the application without deploying to an environment.

Usage Example

const gulp = require('gulp');
const eb = require('gulp-elastic-beanstalk-deploy');

gulp.task('deploy', function(cb) {
    eb({
        profile: 'YOUR-IAM-USER', // optional
        accessKeyId: 'YOUR-AWS-ACCESS-KEY-ID', // optional
        secretAccessKey: 'YOUR-AWS-SECRET-ACCESS-KEY', // optional
        region: 'YOUR-REGION', // required
        applicationName:'my-eb-app',
        environmentName: 'my-eb-env',
        versionLabel: '1.0.0',
        sourceBundle: './archive.zip',
        description: 'Description here'
    }, cb);
});

License

MIT

gulp-elastic-beanstalk-deploy's People

Contributors

scottwrobinson avatar tbenyon avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar

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.