Git Product home page Git Product logo

cf_oo's Introduction

Build Status

I'm cf_oo. Im an object oriented library to help managing Cloud Formation Stacks.

Installation

Pre-requisites

  • AWS Account
  • nix OS with ruby (I'm tested with 1.9.3p125)

Steps

Install cf_oo

gem install cf_oo

Setup the credentials file .cf_oo.yml within your home directory. This will be used to manage Cloud Formation stacks across different accounts and different environments of the SDLC.

prod:
  app1:
    aws_access_key_id: XXXXXXXXXXXXXXXXXXXX
    aws_secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
preprod:
  app1:
    aws_access_key_id: XXXXXXXXXXXXXXXXXXXX
    aws_secret_access_key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Getting Started With CLI

Create New Stack

To create a new stack, you will need to give a template and specify any options as well as a name for the new stack.

cf_oo create -n my-stack -e preprod -t ~/stacks/default.json -p Param1=value?1Param2=value2

Required parameters:

-e environement [Environement to build stack. Must match keys in ~/.cf_oo.yml]
-n name [name for the new stack]
-p parameters [? seperated KEY=VALUE pairs of parameters to overide]
-t template [Cloud Formation template to build stack against]

Optional parameters:

-r region [AWS region]

Listing Available Stacks

Stacks are listed based on the contents of the .cf_oo.yml file created earlier. To see a list of stacks.

cf_oo list

Get Stack Details

cf_oo describe -n my-stack -e preprod

List Stack Instances

cf_oo instances -n my-stack -e preprod

Show Stack Template

cf_oo template -n my-stack -e preprod

Update Running Stack

To update a running stack, you can either use the existing template and provide new paramaters. For example:

cf_oo update -n my-stack -e preprod -p Param1=NewValue

or provide a new template if changes to non parameter resources are required:

cf_oo update -n my-stack -e preprod -t my-update-template.json

You can use the template command to download a stacks running template and make changes if desired.

Deleting A Stack

You must specify the stack name and environment you are deleting. Be careful, theres no going back once this is in motion!

cf_oo delete -n my-stack -e preprod

cf_oo's People

Contributors

tobyw4n avatar weavenet avatar

Watchers

 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.