README.md in ops_tasks-0.4.3 vs README.md in ops_tasks-0.4.4
- old
+ new
@@ -1,8 +1,8 @@
# Ops Tasks
-Provides your rails project with rake tasks for deploying to AWS via Opsworks
+Provides your project with rake tasks for deploying to AWS via Opsworks
- Alerts Slack channel that deployment is starting
- Initiates a deployment on Opsworks
- Monitors deployment until completion
- Alerts Slack channel of result status for deployment
@@ -10,12 +10,16 @@
## Setup
#### Add gem & source
# Gemfile
- gem 'ops_tasks'
+ gem 'ops_tasks', '~> 0.4'
+#### or install
+
+ gem install 'ops_tasks'
+
#### Find your AWS IAM Credentials
If my AWS IAM user name was `Nick`
`https://console.aws.amazon.com/iam/home?region=us-east-1#users/Nick`
@@ -24,11 +28,10 @@
#### Find your stack and instance IDs
These are listed on the settings or details page for stacks and instances, and they're called _Opsworks ID_.
-
#### Setup your environment variables as follows:
| variable name | description |
| --------------|-------------- |
| AWS_ACCESS_KEY_ID | your AWS access key id / API key |
@@ -52,22 +55,35 @@
your_server_name_project_name
your_server_name_slack_channel
your_server_name_room_notifications
```
-You can use figaro or dotenv. I prefer figaro.
+You can use [figaro](https://github.com/laserlemon/figaro) or [dotenv](https://github.com/bkeepers/dotenv). I prefer figaro.
-## Usage
+#### Ruby Setup (without rails)
+1. If using figaro, add your `application.yml` file to the `./config/` directory (create one).
+1. If using dotenv, use a `.env` file in the root of your project.
+1. To generate a dotenv file, run the command
+
+ ops_tasks init
+
+1. To add a deploy environment, run the command
+
+ ops_tasks add <environment name>
+
+## Usage (With Rails)
+
+If you only have one deployment environment in your env file, ops_tasks will run that one automatically. If more than one exists, ops_tasks will prompt you via a graphical menu.
+
### Update Cookbooks
- rake staging:update_cookbooks
- rake production:update_cookbooks
+ bundle exec rake ops_tasks:update_cookbooks
### Deploy to AWS
- bundle exec rake deploy
+ bundle exec rake ops_tasks:deploy
Select a server...
1. staging
2. production
3. realtime
@@ -75,7 +91,30 @@
5. quit
? 4
Sidekiq Server: Preparing deployment... successful
Sidekiq Server: Running... successful
+### Run Configuration Recipes
+
+ bundle exec rake ops_tasks:configure
+
+### Run Setup Recipes
+
+ bundle exec rake ops_tasks:setup
+
+## Usage (Without Rails)
+
+Run any of these tasks from your project directory
+
+ # Run the deploy recipe noted in your env
+ ops_tasks deploy
+
+ # Run the setup recipe(s) as listed in your OpsWorks Layer
+ ops_tasks setup
+
+ # Update your cookbooks on OpsWorks
+ ops_tasks update_cookbooks
+
+ # Run the configure recipe(s) as listed in your OpsWorks Layer
+ ops_tasks configure