|
|
@@ -5,8 +5,9 @@ This cookbook is initially designed to be able to describe and deploy web applic
|
|
|
|
|
|
* Rails
|
|
|
* Java
|
|
|
+* Django
|
|
|
|
|
|
-Other application stacks (PHP, DJango, etc) will be supported as new recipes at a later date.
|
|
|
+Other application stacks (PHP, etc) will be supported as new recipes at a later date.
|
|
|
|
|
|
This cookbook aims to provide primitives to install/deploy any kind of application driven entirely by data defined in an abstract way through a data bag.
|
|
|
|
|
|
@@ -20,8 +21,10 @@ The following Opscode cookbooks are dependencies:
|
|
|
|
|
|
* runit
|
|
|
* unicorn
|
|
|
-* apache2
|
|
|
+* passenger_apache2
|
|
|
* tomcat
|
|
|
+* python
|
|
|
+* gunicorn
|
|
|
|
|
|
The following are also dependencies, though the recipes are considered deprecated, may be useful for future development.
|
|
|
|
|
|
@@ -41,17 +44,68 @@ Searches the `apps` data bag and checks that a server role in the app exists on
|
|
|
|
|
|
See below regarding the application data bag structure.
|
|
|
|
|
|
+django
|
|
|
+------
|
|
|
+
|
|
|
+Using the node's `run_state` that contains the current application in the search, this recipe will:
|
|
|
+
|
|
|
+* create an application specific virtualenv
|
|
|
+* install required packages and pips
|
|
|
+* set up the deployment scaffolding
|
|
|
+* creates settings_local.py file with the database connection information if required
|
|
|
+* performs a revision-based deploy
|
|
|
+
|
|
|
+This recipe can be used on nodes that are going to run the application, or on nodes that need to have the application code checkout available such as supporting utility nodes or a configured load balancer that needs static assets stored in the application repository.
|
|
|
+
|
|
|
+For pip requirements.txt files: ensure the requirements.txt file is present in the root of the application code (APP_ROOT/requirements.txt) or named after the node's current app_environment in a directory named requirements (requirements/production.txt) and `pip install -r` will be run before migrations.
|
|
|
+
|
|
|
+In order to manage running database migrations (python manage.py migrate), you can use a role that sets the `run_migrations` attribute for the application (`my_app`, below) in the correct environment (production, below). Note the data bag item needs to have migrate set to true. See the data bag example below.
|
|
|
+
|
|
|
+ {
|
|
|
+ "name": "my_app_run_migrations",
|
|
|
+ "description": "Run db:migrate on demand for my_app",
|
|
|
+ "json_class": "Chef::Role",
|
|
|
+ "default_attributes": {
|
|
|
+ },
|
|
|
+ "override_attributes": {
|
|
|
+ "apps": {
|
|
|
+ "my_app": {
|
|
|
+ "production": {
|
|
|
+ "run_migrations": true
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+ },
|
|
|
+ "chef_type": "role",
|
|
|
+ "run_list": [
|
|
|
+ ]
|
|
|
+ }
|
|
|
+
|
|
|
+Simply apply this role to the node's run list when it is time to run migrations, and the recipe will remove the role when done. Since Django does not have a standard database migration function built into the core framework, we assume the popular [South framework](http://south.aeracode.org/) is being used.
|
|
|
+
|
|
|
+gunicorn
|
|
|
+--------
|
|
|
+
|
|
|
+Requires `gunicorn` cookbook.
|
|
|
+
|
|
|
+Gunicorn is installed, default attributes are set for the node and an app specific gunicorn config and runit service are created.
|
|
|
+
|
|
|
`java_webapp`
|
|
|
-----------
|
|
|
|
|
|
-Using the node's `run_state` that contains the current application in the search, this recipe will install required packages, set up the deployment scaffolding, create the context configuration for the servlet container and then performs a `remote_file` deploy.
|
|
|
+Using the node's `run_state` that contains the current application in the search, this recipe will:
|
|
|
+
|
|
|
+* install required packages
|
|
|
+* set up the deployment scaffolding
|
|
|
+* create the context configuration for the servlet container
|
|
|
+* performs a `remote_file` deploy.
|
|
|
|
|
|
The servlet container context configuration (`context.xml`) exposes the following JNDI resources which can be referenced by the webapp's deployment descriptor (web.xml):
|
|
|
|
|
|
* A JDBC datasource for all databases in the node's current `app_environment`. The datasource uses the information (including JDBC driver) specified in the data bag item for the application.
|
|
|
* An Environment entry that matches the node's current `app_environment` attribute value. This is useful for loading environment specific properties files in the web application.
|
|
|
|
|
|
-This recipe assumes some sort of build process, such as Maven or a Continuous Integration server like Hudson, will create a deployable artifact and make it available for download via HTTP (such as S3).
|
|
|
+This recipe assumes some sort of build process, such as Maven or a Continuous Integration server like Hudson, will create a deployable artifact and make it available for download via HTTP (such as S3 or artifactory).
|
|
|
|
|
|
`passenger_apache2`
|
|
|
-------------------
|
|
|
@@ -68,11 +122,16 @@ Sets up a passenger vhost template for the application using the `apache2` cookb
|
|
|
rails
|
|
|
-----
|
|
|
|
|
|
-Using the node's `run_state` that contains the current application in the search, this recipe will install required packages and gems, set up the deployment scaffolding, creates database and memcached configurations if required and then performs a revision-based deploy.
|
|
|
+Using the node's `run_state` that contains the current application in the search, this recipe will:
|
|
|
+
|
|
|
+* install required packages and gems
|
|
|
+* set up the deployment scaffolding
|
|
|
+* creates database and memcached configurations if required
|
|
|
+* performs a revision-based deploy.
|
|
|
|
|
|
This recipe can be used on nodes that are going to run the application, or on nodes that need to have the application code checkout available such as supporting utility nodes or a configured load balancer that needs static assets stored in the application repository.
|
|
|
|
|
|
-For Gem Bundler: include `bundler` or `bundler08` in the gems list. `bundle install` or `gem bundle` will be run before migrations.
|
|
|
+For Gem Bundler: include `bundler` or `bundler08` in the gems list. `bundle install` or `gem bundle` will be run before migrations. The `bundle install` command is invoked with the `--deployment` and `--without` flags following [Bundler best practices](http://gembundler.com/deploying.html).
|
|
|
|
|
|
For config.gem in environment: `rake gems:install RAILS_ENV=<node environment>` will be run when a Gem Bundler command is not.
|
|
|
|
|
|
@@ -124,8 +183,8 @@ The following recipes are deprecated and have been removed from the cookbook. To
|
|
|
`rails_nginx_ree_passenger`
|
|
|
|
|
|
---
|
|
|
-Application Data Bag (Rail's version)
|
|
|
-====================
|
|
|
+Application Data Bag
|
|
|
+=====================
|
|
|
|
|
|
The applications data bag expects certain values in order to configure parts of the recipe. Below is a paste of the JSON, where the value is a description of the key. Use your own values, as required. Note that this data bag is also used by the `database` cookbook, so it will contain database information as well. Items that may be ambiguous have an example.
|
|
|
|
|
|
@@ -133,162 +192,34 @@ The application used in examples is named `my_app` and the environment is `produ
|
|
|
|
|
|
Note about "type": the recipes listed in the "type" will be included in the run list via `include_recipe` in the application default recipe based on the type matching one of the `server_roles` values.
|
|
|
|
|
|
-Note about `databases`, the data specified will be rendered as the `database.yml` file. In the `database` cookbook, this information is also used to set up privileges for the application user, and create the databases.
|
|
|
+Note about packages, the version is optional. If specified, the version will be passed as a parameter to the resource. Otherwise it will use the latest available version per the default `:install` action for the package provider.
|
|
|
|
|
|
-Note about gems and packages, the version is optional. If specified, the version will be passed as a parameter to the resource. Otherwise it will use the latest available version per the default `:install` action for the package provider.
|
|
|
+Rail's version additional notes
|
|
|
+-------------------------------
|
|
|
|
|
|
- {
|
|
|
- "id": "my_app",
|
|
|
- "server_roles": [
|
|
|
- "application specific role(s), typically the name of the app, e.g., my_app",
|
|
|
- "my_app"
|
|
|
- ],
|
|
|
- "type": {
|
|
|
- "my_app": [
|
|
|
- "recipes in this application cookbook to run for this role",
|
|
|
- "rails",
|
|
|
- "unicorn"
|
|
|
- ]
|
|
|
- },
|
|
|
- "memcached_role": [
|
|
|
- "name of the role used for the app-specific memcached server",
|
|
|
- "my_app_memcached"
|
|
|
- ],
|
|
|
- "database_slave_role": [
|
|
|
- "name of the role used by database slaves, typically named after the app, 'my_app_database_slave'",
|
|
|
- "my_app_database_slave"
|
|
|
- ],
|
|
|
- "database_master_role": [
|
|
|
- "name of the role used by database master, typically named after the app 'my_app_database_master'",
|
|
|
- "my_app_database_master"
|
|
|
- ],
|
|
|
- "repository": "git@github.com:company/my_app.git",
|
|
|
- "revision": {
|
|
|
- "production": "commit hash, branch or tag to deploy"
|
|
|
- },
|
|
|
- "force": {
|
|
|
- "production": "true or false w/o quotes to force deployment, see the rails.rb recipe"
|
|
|
- },
|
|
|
- "migrate": {
|
|
|
- "production": "true or false boolean to force migration, see rails.rb recipe"
|
|
|
- },
|
|
|
- "databases": {
|
|
|
- "production": {
|
|
|
- "reconnect": "true",
|
|
|
- "encoding": "utf8",
|
|
|
- "username": "db_user",
|
|
|
- "adapter": "mysql",
|
|
|
- "password": "awesome_password",
|
|
|
- "database": "db_name_production"
|
|
|
- }
|
|
|
- },
|
|
|
- "mysql_root_password": {
|
|
|
- "production": "password for the root user in mysql"
|
|
|
- },
|
|
|
- "mysql_debian_password": {
|
|
|
- "production": "password for the debian-sys-maint user on ubuntu/debian"
|
|
|
- },
|
|
|
- "mysql_repl_password": {
|
|
|
- "production": "password for the 'repl' user for replication."
|
|
|
- },
|
|
|
- "snapshots_to_keep": {
|
|
|
- "production": "if using EBS, integer of the number of snapshots we're going to keep for this environment."
|
|
|
- },
|
|
|
- "deploy_key": "SSH private key used to deploy from a private git repository",
|
|
|
- "deploy_to": "path to deploy, e.g. /srv/my_app",
|
|
|
- "owner": "owner for the application files when deployed",
|
|
|
- "group": "group for the application files when deployed",
|
|
|
- "packages": {
|
|
|
- "package_name": "specific packages required for installation at the OS level to run the app like libraries and specific version, e.g.",
|
|
|
- "curl": "7.19.5-1ubuntu2"
|
|
|
- },
|
|
|
- "gems": {
|
|
|
- "gem_name": "specific gems required for installation to run the application, and if a specific version is required, e.g.",
|
|
|
- "rails": "2.3.5"
|
|
|
- },
|
|
|
- "memcached": {
|
|
|
- "production": {
|
|
|
- "namespace": "specify the memcache namespace, ie my_app_environment"
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
+Note about `databases`, the data specified will be rendered as the `database.yml` file. In the `database` cookbook, this information is also used to set up privileges for the application user, and create the databases.
|
|
|
|
|
|
+Note about gems, the version is optional. If specified, the version will be passed as a parameter to the resource. Otherwise it will use the latest available version per the default `:install` action for the package provider.
|
|
|
|
|
|
----
|
|
|
-Application Data Bag (Java webapp version)
|
|
|
-====================
|
|
|
+An example is data bag item is included in this cookbook at `examples/data_bags/apps/rails_app.json`.
|
|
|
|
|
|
-The applications data bag expects certain values in order to configure parts of the recipe. Below is a paste of the JSON, where the value is a description of the key. Use your own values, as required. Note that this data bag is also used by the `database` cookbook, so it will contain database information as well. Items that may be ambiguous have an example.
|
|
|
+Java webapp version additional notes
|
|
|
+------------------------------------
|
|
|
|
|
|
-The application used in examples is named `my_app` and the environment is `production`. Most top-level keys are Arrays, and each top-level key has an entry that describes what it is for, followed by the example entries. Entries that are hashes themselves will have the description in the value.
|
|
|
+Note about `databases`, the data specified will be rendered as JNDI Datasource `Resources` in the servlet container context confiruation (`context.xml`) file. In the `database` cookbook, this information is also used to set up privileges for the application user, and create the databases.
|
|
|
|
|
|
-Note about "type": the recipes listed in the "type" will be included in the run list via `include_recipe` in the application default recipe based on the type matching one of the `server_roles` values.
|
|
|
+An example is data bag item is included in this cookbook at `examples/data_bags/apps/java_app.json`.
|
|
|
|
|
|
-Note about `databases`, the data specified will be rendered as JNDI Datasource `Resources` in the servlet container context confiruation (`context.xml`) file. In the `database` cookbook, this information is also used to set up privileges for the application user, and create the databases.
|
|
|
+Django version additional notes
|
|
|
+-------------------------------
|
|
|
|
|
|
-Note about packages, the version is optional. If specified, the version will be passed as a parameter to the resource. Otherwise it will use the latest available version per the default `:install` action for the package provider.
|
|
|
+Note about `databases`, the data specified will be rendered as the `settings_local.py` file. In the `database` cookbook, this information is also used to set up privileges for the application user, and create the databases.
|
|
|
|
|
|
- {
|
|
|
- "id": "my_app",
|
|
|
- "server_roles": [
|
|
|
- "application specific role(s), typically the name of the app, e.g., my_app",
|
|
|
- "my_app"
|
|
|
- ],
|
|
|
- "type": {
|
|
|
- "my_app": [
|
|
|
- "recipes in this application cookbook to run for this role",
|
|
|
- "java_webapp",
|
|
|
- "tomcat"
|
|
|
- ]
|
|
|
- },
|
|
|
- "database_slave_role": [
|
|
|
- "name of the role used by database slaves, typically named after the app, 'my_app_database_slave'",
|
|
|
- "my_app_database_slave"
|
|
|
- ],
|
|
|
- "database_master_role": [
|
|
|
- "name of the role used by database master, typically named after the app 'my_app_database_master'",
|
|
|
- "my_app_database_master"
|
|
|
- ],
|
|
|
- "wars": {
|
|
|
- "production": {
|
|
|
- "source": "source url of WAR file to deploy",
|
|
|
- "checksum": "SHA256 (or portion thereof) of the WAR file to deploy"
|
|
|
- }
|
|
|
- },
|
|
|
- "databases": {
|
|
|
- "production": {
|
|
|
- "max_active": "100",
|
|
|
- "max_idle": "30",
|
|
|
- "max_wait": "10000",
|
|
|
- "username": "db_user",
|
|
|
- "adapter": "mysql",
|
|
|
- "driver": "com.mysql.jdbc.Driver",
|
|
|
- "port": "3306",
|
|
|
- "password": "awesome_password",
|
|
|
- "database": "db_name_production"
|
|
|
- }
|
|
|
- },
|
|
|
- "mysql_root_password": {
|
|
|
- "production": "password for the root user in mysql"
|
|
|
- },
|
|
|
- "mysql_debian_password": {
|
|
|
- "production": "password for the debian-sys-maint user on ubuntu/debian"
|
|
|
- },
|
|
|
- "mysql_repl_password": {
|
|
|
- "production": "password for the 'repl' user for replication."
|
|
|
- },
|
|
|
- "snapshots_to_keep": {
|
|
|
- "production": "if using EBS, integer of the number of snapshots we're going to keep for this environment."
|
|
|
- },
|
|
|
- "deploy_to": "path to deploy, e.g. /srv/my_app",
|
|
|
- "owner": "owner for the application files when deployed",
|
|
|
- "group": "group for the application files when deployed",
|
|
|
- "packages": {
|
|
|
- "package_name": "specific packages required for installation at the OS level to run the app like libraries and specific version, e.g.",
|
|
|
- "curl": "7.19.5-1ubuntu2"
|
|
|
- }
|
|
|
- }
|
|
|
+Note about pips, the version is optional. If specified, the version will be passed as a parameter to the resource. Otherwise it will use the latest available version per the default `:install` action for the python_pip package provider.
|
|
|
+
|
|
|
+The `local_settings_file_name` value may be used to supply an alternate name for the environment specific `settings_local.py`, since Django projects do not have a standard name for this file.
|
|
|
|
|
|
+An example is data bag item is included in this cookbook at `examples/data_bags/apps/django_app.json`.
|
|
|
|
|
|
---
|
|
|
Usage
|
|
|
@@ -341,7 +272,7 @@ Author:: Adam Jacob (<adam@opscode.com>)
|
|
|
Author:: Joshua Timberman (<joshua@opscode.com>)
|
|
|
Author:: Seth Chisamore (<schisamo@opscode.com>)
|
|
|
|
|
|
-Copyright 2009-2010, Opscode, Inc.
|
|
|
+Copyright 2009-2011, Opscode, Inc.
|
|
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
|
you may not use this file except in compliance with the License.
|
Seth Chisamore