from-scratch 0.1.0 → 0.1.1

data/cookbooks/postgresql/metadata.json

@@ -0,0 +1,56 @@
+{
+  "name": "postgresql",
+  "description": "Installs and configures postgresql for clients or servers",
+  "long_description": "Description\n===========\n\nInstalls and configures PostgreSQL as a client or a server.\n\nRequirements\n============\n\n## Platforms\n\n* Debian, Ubuntu\n* Red Hat/CentOS/Scientific (6.0+ required) - \"EL6-family\"\n* Fedora\n* SUSE\n\nTested on:\n\n* Ubuntu 10.04, 11.10, 12.04, 14.04, 14.10\n* Red Hat 6.1, Scientific 6.1, CentOS 6.3\n\n## Cookbooks\n\nRequires Opscode's `openssl` cookbook for secure password generation.\n\nRequires a C compiler and development headers in order to build the\n`pg` RubyGem to provide Ruby bindings in the `ruby` recipe.\n\nOpscode's `build-essential` cookbook provides this functionality on\nDebian, Ubuntu, and EL6-family.\n\nWhile not required, Opscode's `database` cookbook contains resources\nand providers that can interact with a PostgreSQL database. This\ncookbook is a dependency of database.\n\nAttributes\n==========\n\nThe following attributes are set based on the platform, see the\n`attributes/default.rb` file for default values.\n\n* `node['postgresql']['version']` - version of postgresql to manage\n* `node['postgresql']['dir']` - home directory of where postgresql\n  data and configuration lives.\n\n* `node['postgresql']['client']['packages']` - An array of package names\n  that should be installed on \"client\" systems.\n* `node['postgresql']['server']['packages']` - An array of package names\n  that should be installed on \"server\" systems.\n* `node['postgresql']['server']['config_change_notify']` - Type of\n  notification triggered when a config file changes.\n* `node['postgresql']['contrib']['packages']` - An array of package names\n  that could be installed on \"server\" systems for useful sysadmin tools.\n\n* `node['postgresql']['enable_pgdg_apt']` - Whether to enable the apt repo\n  by the PostgreSQL Global Development Group, which contains newer versions\n  of PostgreSQL.\n\n* `node['postgresql']['enable_pgdg_yum']` - Whether to enable the yum repo\n  by the PostgreSQL Global Development Group, which contains newer versions\n  of PostgreSQL.\n\n* `node['postgresql']['initdb_locale']` - Sets the default locale for the\n  database cluster. If this attribute is not specified, the locale is\n  inherited from the environment that initdb runs in. Sometimes you must\n  have a system locale that is not what you want for your database cluster,\n  and this attribute addresses that scenario. Valid only for EL-family\n  distros (RedHat/Centos/etc.).\n\nThe following attributes are generated in\n`recipe[postgresql::server]`.\n\n* `node['postgresql']['password']['postgres']` - randomly generated\n  password by the `openssl` cookbook's library.\n  (TODO: This is broken, as it disables the password.)\n\nConfiguration\n-------------\n\nThe `postgresql.conf` and `pg_hba.conf` files are dynamically\ngenerated from attributes. Each key in `node['postgresql']['config']`\nis a postgresql configuration directive, and will be rendered in the\nconfig file. For example, the attribute:\n\n    node['postgresql']['config']['listen_addresses'] = 'localhost'\n\nWill result in the following line in the `postgresql.conf` file:\n\n    listen_addresses = 'localhost'\n\nThe attributes file contains default values for Debian and RHEL\nplatform families (per the `node['platform_family']`). These defaults\nhave disparity between the platforms because they were originally\nextracted from the postgresql.conf files in the previous version of\nthis cookbook, which differed in their default config. The resulting\nconfiguration files will be the same as before, but the content will\nbe dynamically rendered from the attributes. The helpful commentary\nwill no longer be present. You should consult the PostgreSQL\ndocumentation for specific configuration details.\n\nSee __Recipes__ `config_initdb` and `config_pgtune` below to\nauto-generate many postgresql.conf settings.\n\nFor values that are \"on\" or \"off\", they should be specified as literal\n`true` or `false`. String values will be used with single quotes. Any\nconfiguration option set to the literal `nil` will be skipped\nentirely. All other values (e.g., numeric literals) will be used as\nis. So for example:\n\n    node.default['postgresql']['config']['logging_collector'] = true\n    node.default['postgresql']['config']['datestyle'] = 'iso, mdy'\n    node.default['postgresql']['config']['ident_file'] = nil\n    node.default['postgresql']['config']['port'] = 5432\n\nWill result in the following config lines:\n\n    logging_collector = 'on'\n    datestyle = 'iso,mdy'\n    port = 5432\n\n(no line printed for `ident_file` as it is `nil`)\n\nNote that the `unix_socket_directory` configuration was renamed to\n`unix_socket_directories` in Postgres 9.3 so make sure to use the\n`node['postgresql']['unix_socket_directories']` attribute instead of\n`node['postgresql']['unix_socket_directory']`.\n\nThe `pg_hba.conf` file is dynamically generated from the\n`node['postgresql']['pg_hba']` attribute. This attribute must be an\narray of hashes, each hash containing the authorization data. As it is\nan array, you can append to it in your own recipes. The hash keys in\nthe array must be symbols. Each hash will be written as a line in\n`pg_hba.conf`. For example, this entry from\n`node['postgresql']['pg_hba']`:\n\n    [{:comment => '# Optional comment',\n    :type => 'local', :db => 'all', :user => 'postgres', :addr => nil, :method => 'md5'}]\n\nWill result in the following line in `pg_hba.conf`:\n\n    # Optional comment\n    local   all             postgres                                md5\n\nUse `nil` if the CIDR-ADDRESS should be empty (as above).\nDon't provide a comment if none is desired in the `pg_hba.conf` file.\n\nNote that the following authorization rule is supplied automatically by\nthe cookbook template. The cookbook needs this to execute SQL in the\nPostgreSQL server without supplying the clear-text password (which isn't\nknown by the cookbook). Therefore, your `node['postgresql']['pg_hba']`\nattributes don't need to specify this authorization rule:\n\n    # \"local\" is for Unix domain socket connections only\n    local   all             all                                     ident\n\n(By the way, the template uses `peer` instead of `ident` for PostgreSQL-9.1\nand above, which has the same effect.)\n\nRecipes\n=======\n\ndefault\n-------\n\nIncludes the client recipe.\n\nclient\n------\n\nInstalls the packages defined in the\n`node['postgresql']['client']['packages']` attribute.\n\nruby\n----\n\n**NOTE** This recipe may not currently work when installing Chef with\n  the\n  [\"Omnibus\" full stack installer](http://opscode.com/chef/install) on\n  some platforms due to an incompatibility with OpenSSL. See\n  [COOK-1406](http://tickets.opscode.com/browse/COOK-1406). You can\n  build from source into the Chef omnibus installation to work around\n  this issue.\n\nInstall the `pg` gem under Chef's Ruby environment so it can be used\nin other recipes. The build-essential packages and postgresql client\npackages will be installed during the compile phase, so that the\nnative extensions of `pg` can be compiled.\n\nserver\n------\n\nIncludes the `server_debian` or `server_redhat` recipe to get the\nappropriate server packages installed and service managed. Also\nmanages the configuration for the server:\n\n* generates a strong default password (via `openssl`) for `postgres`\n  (TODO: This is broken, as it disables the password.)\n* sets the password for postgres\n* manages the `postgresql.conf` file.\n* manages the `pg_hba.conf` file.\n\nserver\\_debian\n--------------\n\nInstalls the postgresql server packages and sets up the service. You\nshould include the `postgresql::server` recipe, which will include\nthis on Debian platforms.\n\nserver\\_redhat\n--------------\n\nManages the postgres user and group (with UID/GID 26, per RHEL package\nconventions), installs the postgresql server packages, initializes the\ndatabase, and manages the postgresql service. You should include the\n`postgresql::server` recipe, which will include this on RHEL/Fedora\nplatforms.\n\nconfig\\_initdb\n--------------\n\nTakes locale and timezone settings from the system configuration.\nThis recipe creates `node.default['postgresql']['config']` attributes\nthat conform to the system's locale and timezone. In addition, this\nrecipe creates the same error reporting and logging settings that\n`initdb` provided: a rotation of 7 days of log files named\npostgresql-Mon.log, etc.\n\nThe default attributes created by this recipe are easy to override with\nnormal attributes because of Chef attribute precedence. For example,\nsuppose a DBA wanted to keep log files indefinitely, rolling over daily\nor when growing to 10MB. The Chef installation could include the\n`postgresql::config_initdb` recipe for the locale and timezone settings,\nbut customize the logging settings with these node JSON attributes:\n\n    \"postgresql\": {\n      \"config\": {\n        \"log_rotation_age\": \"1d\",\n        \"log_rotation_size\": \"10MB\",\n        \"log_filename\": \"postgresql-%Y-%m-%d_%H%M%S.log\"\n      }\n    }\n\nCredits: This `postgresql::config_initdb` recipe is based on algorithms\nin the [source code](http://doxygen.postgresql.org/initdb_8c_source.html)\nfor the PostgreSQL `initdb` utility.\n\nconfig\\_pgtune\n--------------\n\nPerformance tuning.\nTakes the wimpy default postgresql.conf and expands the database server\nto be as powerful as the hardware it's being deployed on. This recipe\ncreates a baseline configuration of `node.default['postgresql']['config']`\nattributes in the right general range for a dedicated Postgresql system.\nMost installations won't need additional performance tuning.\n\nThe only decision you need to make is to choose a `db_type` from the\nfollowing database workloads. (See the recipe code comments for more\ndetailed descriptions.)\n\n * \"dw\" -- Data Warehouse\n * \"oltp\" -- Online Transaction Processing\n * \"web\" -- Web Application\n * \"mixed\" -- Mixed DW and OLTP characteristics\n * \"desktop\" -- Not a dedicated database\n\nThis recipe uses a performance model with three input parameters.\nThese node attributes are completely optional, but it is obviously\nimportant to choose the `db_type` correctly:\n\n * `node['postgresql']['config_pgtune']['db_type']` --\n   Specifies database type from the list of five choices above.\n   If not specified, the default is \"mixed\".\n\n * `node['postgresql']['config_pgtune']['max_connections']` --\n   Specifies maximum number of connections expected.\n   If not specified, it depends on database type:\n   \"web\":200, \"oltp\":300, \"dw\":20, \"mixed\":80, \"desktop\":5\n\n * `node['postgresql']['config_pgtune']['total_memory']` --\n   Specifies total system memory in kB. (E.g., \"49416564kB\".)\n   If not specified, it will be taken from Ohai automatic attributes.\n   This could be used to tune a system that isn't a dedicated database.\n\nThe default attributes created by this recipe are easy to override with\nnormal attributes because of Chef attribute precedence. For example, if\nyou are running application benchmarks to try different buffer cache\nsizes, you would experiment with this node JSON attribute:\n\n    \"postgresql\": {\n      \"config\": {\n        \"shared_buffers\": \"3GB\"\n      }\n    }\n\nNote that the recipe uses `max_connections` in its computations. If\nyou want to override that setting, you should specify\n`node['postgresql']['config_pgtune']['max_connections']` instead of\n`node['postgresql']['config']['max_connections']`.\n\nCredits: This `postgresql::config_pgtune` recipe is based on the\n[pgtune python script](https://github.com/gregs1104/pgtune)\ndeveloped by\n[Greg Smith](http://notemagnet.blogspot.com/2008/11/automating-initial-postgresqlconf.html)\nand\n[other pgsql-hackers](http://www.postgresql.org/message-id/491C6CDC.8090506@agliodbs.com).\n\ncontrib\n-------\n\nInstalls the packages defined in the\n`node['postgresql']['contrib']['packages']` attribute. The contrib\ndirectory of the PostgreSQL distribution includes porting tools,\nanalysis utilities, and plug-in features that database engineers often\nrequire. Some (like `pgbench`) are executable. Others (like\n`pg_buffercache`) would need to be installed into the database.\n\nAlso installs any contrib module extensions defined in the\n`node['postgresql']['contrib']['extensions']` attribute. These will be\navailable in any subsequently created databases in the cluster, because\nthey will be installed into the `template1` database using the\n`CREATE EXTENSION` command. For example, it is often necessary/helpful\nfor problem troubleshooting and maintenance planning to install the\nviews and functions in these [standard instrumentation extensions]\n(http://www.postgresql.org/message-id/flat/4DC32600.6080900@pgexperts.com#4DD3D6C6.5060006@2ndquadrant.com):\n\n    node['postgresql']['contrib']['extensions'] = [\n      \"pageinspect\",\n      \"pg_buffercache\",\n      \"pg_freespacemap\",\n      \"pgrowlocks\",\n      \"pg_stat_statements\",\n      \"pgstattuple\"\n    ]\n\nNote that the `pg_stat_statements` view only works if `postgresql.conf`\nloads its shared library, which can be done with this node attribute:\n\n    node['postgresql']['config']['shared_preload_libraries'] = 'pg_stat_statements'\n\nIf using `shared_preload_libraries` in combination with the `contrib` recipe,\nmake sure that the `contrib` recipe is called before the `server` recipe (to\nensure the dependencies are installed and setup in order).\n\napt\\_pgdg\\_postgresql\n----------------------\n\nEnables the PostgreSQL Global Development Group yum repository\nmaintained by Devrim G&#252;nd&#252;z for updated PostgreSQL packages.\n(The PGDG is the groups that develops PostgreSQL.)\nAutomatically included if the `node['postgresql']['enable_pgdg_apt']`\nattribute is true. Also set the\n`node['postgresql']['client']['packages']` and\n`node['postgresql']['server]['packages']` to the list of packages to\nuse from this repository, and set the `node['postgresql']['version']`\nattribute to the version to use (e.g., \"9.2\").\n\nyum\\_pgdg\\_postgresql\n---------------------\n\nEnables the PostgreSQL Global Development Group yum repository\nmaintained by Devrim G&#252;nd&#252;z for updated PostgreSQL packages.\n(The PGDG is the groups that develops PostgreSQL.)\nAutomatically included if the `node['postgresql']['enable_pgdg_yum']`\nattribute is true. Also use `override_attributes` to set a number of\nvalues that will need to have embedded version numbers. For example:\n\n    node['postgresql']['enable_pgdg_yum'] = true\n    node['postgresql']['version'] = \"9.2\"\n    node['postgresql']['dir'] = \"/var/lib/pgsql/9.2/data\"\n    node['postgresql']['config']['data_directory'] = node['postgresql']['dir']\n    node['postgresql']['client']['packages'] = [\"postgresql92\", \"postgresql92-devel\"]\n    node['postgresql']['server']['packages'] = [\"postgresql92-server\"]\n    node['postgresql']['server']['service_name'] = \"postgresql-9.2\"\n    node['postgresql']['contrib']['packages'] = [\"postgresql92-contrib\"]\n\nYou may set `node['postgresql']['pgdg']['repo_rpm_url']` attributes\nto pick up recent [PGDG repo packages](http://yum.postgresql.org/repopackages.php).\n\nResources/Providers\n===================\n\nSee the [database](http://community.opscode.com/cookbooks/database)\nfor resources and providers that can be used for managing PostgreSQL\nusers and databases.\n\nUsage\n=====\n\nOn systems that need to connect to a PostgreSQL database, add to a run\nlist `recipe[postgresql]` or `recipe[postgresql::client]`.\n\nOn systems that should be PostgreSQL servers, use\n`recipe[postgresql::server]` on a run list. This recipe does set a\npassword for the `postgres` user.\nIf you're using `chef server`, if the attribute\n`node['postgresql']['password']['postgres']` is not found,\nthe recipe generates a random password and performs a node.save.\n(TODO: This is broken, as it disables the password.)\nIf you're using `chef-solo`, you'll need\nto set the attribute `node['postgresql']['password']['postgres']` in\nyour node's `json_attribs` file or in a role.\n\nOn Debian family systems, SSL will be enabled, as the packages on\nDebian/Ubuntu also generate the SSL certificates. If you use another\nplatform and wish to use SSL in postgresql, then generate your SSL\ncertificates and distribute them in your own cookbook, and set the\n`node['postgresql']['config']['ssl']` attribute to true in your\nrole/cookboook/node.\n\nOn server systems, the postgres server is restarted when a configuration\nfile changes.  This can be changed to reload only by setting the\nfollowing attribute:\n\n    node['postgresql']['server']['config_change_notify'] = :reload\n\nChef Solo Note\n==============\n\nThe following node attribute is stored on the Chef Server when using\n`chef-client`. Because `chef-solo` does not connect to a server or\nsave the node object at all, to have the password persist across\n`chef-solo` runs, you must specify them in the `json_attribs` file\nused. For Example:\n\n    {\n      \"postgresql\": {\n        \"password\": {\n          \"postgres\": \"iloverandompasswordsbutthiswilldo\"\n        }\n      },\n      \"run_list\": [\"recipe[postgresql::server]\"]\n    }\n\nThat should actually be the \"encrypted password\" instead of cleartext,\nso you should generate it as an md5 hash using the PostgreSQL algorithm.\n\n* You could copy the md5-hashed password from an existing postgres\ndatabase if you have `postgres` access and want to use the same password:<br>\n`select * from pg_shadow where usename='postgres';`\n* You can run this from any postgres database session to use a new password:<br>\n`select 'md5'||md5('iloverandompasswordsbutthiswilldo'||'postgres');`\n* You can run this from a linux commandline:<br>\n`echo -n 'iloverandompasswordsbutthiswilldo''postgres' | openssl md5 | sed -e 's/.* /md5/'`\n\nLicense and Author\n==================\n\n- Author:: Joshua Timberman (<joshua@opscode.com>)\n- Author:: Lamont Granquist (<lamont@opscode.com>)\n- Author:: Chris Roberts (<chrisroberts.code@gmail.com>)\n- Author:: David Crane (<davidc@donorschoose.org>)\n- Author:: Aaron Baer (<aaron@hw-ops.com>)\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n",
+  "maintainer": "Heavy Water Operations, LLC",
+  "maintainer_email": "support@hw-ops.com",
+  "license": "Apache 2.0",
+  "platforms": {
+    "ubuntu": "< 14.10",
+    "debian": ">= 0.0.0",
+    "fedora": ">= 0.0.0",
+    "suse": ">= 0.0.0",
+    "amazon": ">= 0.0.0",
+    "redhat": "~> 6.0",
+    "centos": "~> 6.0",
+    "scientific": "~> 6.0",
+    "oracle": "~> 6.0"
+  },
+  "dependencies": {
+    "apt": ">= 1.9.0",
+    "build-essential": ">= 0.0.0",
+    "openssl": "~> 4.0.0"
+  },
+  "recommendations": {
+
+  },
+  "suggestions": {
+
+  },
+  "conflicting": {
+
+  },
+  "providing": {
+
+  },
+  "replacing": {
+
+  },
+  "attributes": {
+
+  },
+  "groupings": {
+
+  },
+  "recipes": {
+    "postgresql": "Includes postgresql::client",
+    "postgresql::ruby": "Installs pg gem for Ruby bindings",
+    "postgresql::client": "Installs postgresql client package(s)",
+    "postgresql::server": "Installs postgresql server packages, templates",
+    "postgresql::server_redhat": "Installs postgresql server packages, redhat family style",
+    "postgresql::server_debian": "Installs postgresql server packages, debian family style"
+  },
+  "version": "3.4.20",
+  "source_url": "",
+  "issues_url": ""
+}

data/cookbooks/postgresql/recipes/apt_pgdg_postgresql.rb

@@ -0,0 +1,18 @@
+if not %w(jessie squeeze wheezy sid lucid precise saucy trusty utopic).include? node['postgresql']['pgdg']['release_apt_codename']
+  raise "Not supported release by PGDG apt repository"
+end
+
+include_recipe 'apt'
+
+file "remove deprecated Pitti PPA apt repository" do
+  action :delete
+  path "/etc/apt/sources.list.d/pitti-postgresql-ppa"
+end
+
+apt_repository 'apt.postgresql.org' do
+  uri 'http://apt.postgresql.org/pub/repos/apt'
+  distribution "#{node['postgresql']['pgdg']['release_apt_codename']}-pgdg"
+  components ['main', node['postgresql']['version']]
+  key 'https://www.postgresql.org/media/keys/ACCC4CF8.asc'
+  action :add
+end

data/cookbooks/postgresql/recipes/client.rb

@@ -0,0 +1,32 @@
+#
+# Cookbook Name:: postgresql
+# Recipe:: client
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+if platform_family?('debian') && node['postgresql']['version'].to_f > 9.3
+  node.default['postgresql']['enable_pgdg_apt'] = true
+end
+
+if(node['postgresql']['enable_pgdg_apt']) and platform_family?('debian')
+  include_recipe 'postgresql::apt_pgdg_postgresql'
+end
+
+if(node['postgresql']['enable_pgdg_yum']) and platform_family?('rhel')
+  include_recipe 'postgresql::yum_pgdg_postgresql'
+end
+
+node['postgresql']['client']['packages'].each do |pg_pack|
+  package pg_pack
+end

data/cookbooks/postgresql/recipes/config_initdb.rb

@@ -0,0 +1,148 @@
+#
+# Cookbook Name:: postgresql
+# Recipe:: config_initdb
+# Author:: David Crane (<davidc@donorschoose.org>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#######
+# Load the locale_date_order() and select_default_timezone(tzdir)
+# methods from libraries/default.rb
+::Chef::Recipe.send(:include, Opscode::PostgresqlHelpers)
+
+#######
+# This recipe is derived from the setup_config() source code in the
+# PostgreSQL initdb utility. It determines postgresql.conf settings that
+# conform to the system's locale and timezone configuration, and also
+# sets the error reporting and logging settings.
+#
+# See http://doxygen.postgresql.org/initdb_8c_source.html for the
+# original initdb source code.
+#
+# By examining the system configuration, this recipe will set the
+# following node.default['postgresql']['config'] attributes:
+#
+# - Locale and Formatting -
+#   * datestyle
+#   * lc_messages
+#   * lc_monetary
+#   * lc_numeric
+#   * lc_time
+#   * default_text_search_config
+#
+# - Timezone Conversion -
+#   * log_timezone
+#   * timezone
+#
+# In addition, this recipe will recommend the same error reporting and
+# logging settings that initdb provided. These settings do differ from
+# the PostgreSQL default settings, which would log to stderr only. The
+# initdb settings rotate 7 days of log files named postgresql-Mon.log,
+# etc. through these node.default['postgresql']['config'] attributes:
+#
+# - Where to Log -
+#   * log_destination = 'stderr'
+#   * log_directory = 'pg_log'
+#   * log_filename = 'postgresql-%a.log'
+#     (Default was: postgresql-%Y-%m-%d_%H%M%S.log)
+#   * logging_collector = true # on
+#     (Turned on to capture stderr logging and redirect into log files)
+#     (Default was: false # off)
+#   * log_rotation_age = 1d
+#   * log_rotation_size = 0
+#     (Default was: 10MB)
+#   * log_truncate_on_rotation = true # on
+#     (Default was: false # off)
+
+#######
+# Locale Configuration
+
+# See libraries/default.rb for the locale_date_order() method.
+node.default['postgresql']['config']['datestyle'] = "iso, #{locale_date_order()}"
+
+# According to the locale(1) manpage, the locale settings are determined
+# by environment variables according to the following precedence:
+# LC_ALL > (LC_MESSAGES, LC_MONETARY, LC_NUMERIC, LC_TIME) > LANG.
+
+node.default['postgresql']['config']['lc_messages'] =
+  [ ENV['LC_ALL'], ENV['LC_MESSAGES'], ENV['LANG'] ].compact.first
+
+node.default['postgresql']['config']['lc_monetary'] =
+  [ ENV['LC_ALL'], ENV['LC_MONETARY'], ENV['LANG'] ].compact.first
+
+node.default['postgresql']['config']['lc_numeric'] =
+  [ ENV['LC_ALL'], ENV['LC_NUMERIC'], ENV['LANG'] ].compact.first
+
+node.default['postgresql']['config']['lc_time'] =
+  [ ENV['LC_ALL'], ENV['LC_TIME'], ENV['LANG'] ].compact.first
+
+node.default['postgresql']['config']['default_text_search_config'] =
+  case ENV['LANG']
+  when /da_.*/
+    'pg_catalog.danish'
+  when /nl_.*/
+    'pg_catalog.dutch'
+  when /en_.*/
+    'pg_catalog.english'
+  when /fi_.*/
+    'pg_catalog.finnish'
+  when /fr_.*/
+    'pg_catalog.french'
+  when /de_.*/
+    'pg_catalog.german'
+  when /hu_.*/
+    'pg_catalog.hungarian'
+  when /it_.*/
+    'pg_catalog.italian'
+  when /no_.*/
+    'pg_catalog.norwegian'
+  when /pt_.*/
+    'pg_catalog.portuguese'
+  when /ro_.*/
+    'pg_catalog.romanian'
+  when /ru_.*/
+    'pg_catalog.russian'
+  when /es_.*/
+    'pg_catalog.spanish'
+  when /sv_.*/
+    'pg_catalog.swedish'
+  when /tr_.*/
+    'pg_catalog.turkish'
+  else
+    nil
+  end
+
+#######
+# Timezone Configuration
+
+# Determine the name of the system's default timezone and specify node
+# defaults for the postgresql.cof settings. If the timezone cannot be
+# identified, do as initdb would do: leave it unspecified so PostgreSQL
+# uses it's internal default of GMT.
+tzdirpath = pg_TZDIR() # See libraries/default.rb
+default_timezone = select_default_timezone(tzdirpath) # See libraries/default.rb
+if !default_timezone.nil?
+    node.default['postgresql']['config']['log_timezone'] = default_timezone
+    node.default['postgresql']['config']['timezone'] = default_timezone
+end
+
+#######
+# - Where to Log -
+node.default['postgresql']['config']['log_destination'] = 'stderr'
+node.default['postgresql']['config']['log_directory'] = 'pg_log'
+node.default['postgresql']['config']['log_filename'] = 'postgresql-%a.log'
+node.default['postgresql']['config']['logging_collector'] = true # on
+node.default['postgresql']['config']['log_rotation_age'] = '1d'
+node.default['postgresql']['config']['log_rotation_size'] = 0
+node.default['postgresql']['config']['log_truncate_on_rotation'] = true # on

data/cookbooks/postgresql/recipes/config_pgtune.rb

@@ -0,0 +1,284 @@
+#
+# Cookbook Name:: postgresql
+# Recipe:: config_pgtune
+# Author:: David Crane (<davidc@donorschoose.org>)
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+#######
+# Load the binaryround(value) method from libraries/default.rb
+::Chef::Recipe.send(:include, Opscode::PostgresqlHelpers)
+
+#######
+# This recipe is based on Greg Smith's pgtune script (the Feb 1, 2012
+# version at https://github.com/gregs1104/pgtune). Introduction: pgtune
+# takes the wimpy default postgresql.conf and expands the database
+# server to be as powerful as the hardware it's being deployed on.
+#
+# The default postgresql.conf aims at a system with approximately 128MB
+# of RAM. This recipe recommends a baseline configuration in the right
+# general range for a dedicated Postgresql system.
+#
+# This recipe takes three optional parameters that may be passed in as
+# node['postgresql']['config_pgtune'] attributes:
+#   * db_type -- Specifies database type as one of: dw, oltp,
+#     web, mixed, desktop. If not specified, the default is mixed.
+#   * max_connections -- Specifies number of maximum connections
+#     expected. If not specified, it depends on database type.
+#   * total_memory -- Specifies total system memory. If not specified,
+#     it will be detected from the Ohai automatic attributes.
+#
+# Using those inputs, this recipe will compute and set the following
+# node.default['postgresql']['config'] attributes:
+#   * max_connections
+#   * shared_buffers
+#   * effective_cache_size
+#   * work_mem
+#   * maintenance_work_mem
+#   * checkpoint_segments
+#   * checkpoint_completion_target
+#   * wal_buffers
+#   * default_statistics_target
+#
+# This recipe deviates from the original pgtune script for 2 settings:
+# shared_buffers is capped for large memory systems (which Greg
+# mentioned in a TODO.rst) and wal_buffers will auto-tune starting with
+# 9.1 (which is a feature that Greg built into Postgresql).
+
+#######
+# These are the workload characteristics of the five database types
+# that can be specified as node['postgresql']['config_pgtune']['db_type']:
+#
+# dw -- Data Warehouse
+#   * Typically I/O- or RAM-bound
+#   * Large bulk loads of data
+#   * Large complex reporting queries
+#   * Also called "Decision Support" or "Business Intelligence"
+#
+# oltp -- Online Transaction Processing
+#   * Typically CPU- or I/O-bound
+#   * DB slightly larger than RAM to 1TB
+#   * 20-40% small data write queries
+#   * Some long transactions and complex read queries
+#
+# web -- Web Application
+#   * Typically CPU-bound
+#   * DB much smaller than RAM
+#   * 90% or more simple queries
+#
+# mixed -- Mixed DW and OLTP characteristics
+#   * A wide mixture of queries
+#
+# desktop -- Not a dedicated database
+#   * A general workstation, perhaps for a developer
+
+# Parse out db_type option, or use default.
+db_type = 'mixed'
+
+if (node['postgresql'].attribute?('config_pgtune') && node['postgresql']['config_pgtune'].attribute?('db_type'))
+  db_type = node['postgresql']['config_pgtune']['db_type']
+  if (!(["dw","oltp","web","mixed","desktop"].include?(db_type)))
+    Chef::Log.fatal([
+        "Bad value (#{db_type})",
+        "for node['postgresql']['config_pgtune']['db_type'] attribute.",
+        "Valid values are one of dw, oltp, web, mixed, desktop."
+      ].join(' '))
+    raise
+  end
+end
+
+# Parse out max_connections option, or use a value based on db_type.
+con =
+{ "web" => 200,
+  "oltp" => 300,
+  "dw" => 20,
+  "mixed" => 80,
+  "desktop" => 5
+}.fetch(db_type)
+
+if (node['postgresql'].attribute?('config_pgtune') && node['postgresql']['config_pgtune'].attribute?('max_connections'))
+  max_connections = node['postgresql']['config_pgtune']['max_connections'].to_i
+  if max_connections <= 0
+    Chef::Log.fatal([
+        "Bad value (#{max_connections})",
+        "for node['postgresql']['config_pgtune']['max_connections'] attribute.",
+        "Valid values are non-zero integers only."
+      ].join(' '))
+    raise
+  end
+  con = max_connections
+end
+
+# Parse out total_memory option, or use value detected by Ohai.
+total_memory = node['memory']['total']
+
+# Override max_connections with a node attribute if DevOps desires.
+# For example, on a system *not* dedicated to Postgresql.
+if (node['postgresql'].attribute?('config_pgtune') && node['postgresql']['config_pgtune'].attribute?('total_memory'))
+  total_memory = node['postgresql']['config_pgtune']['total_memory']
+  if (total_memory.match(/\A[1-9]\d*kB\Z/) == nil)
+    Chef::Application.fatal!([
+        "Bad value (#{total_memory})",
+        "for node['postgresql']['config_pgtune']['total_memory'] attribute.",
+        "Valid values are non-zero integers followed by kB (e.g., 49416564kB)."
+      ].join(' '))
+  end
+end
+
+# Ohai reports node[:memory][:total] in kB, as in "921756kB"
+mem = total_memory.split("kB")[0].to_i / 1024 # in MB
+
+#######
+# RAM-related settings computed as in Greg Smith's pgtune script.
+# Remember that con and mem were either chosen above based on the
+# db_type or the actual total memory, or were passed in attributes.
+
+# (1) max_connections
+#     Sets the maximum number of concurrent connections.
+node.default['postgresql']['config']['max_connections'] = con
+
+# The calculations for the next four settings would not be optimal
+# for low memory systems. In that case, the calculation is skipped,
+# leaving the built-in Postgresql settings, which are actually
+# intended for those low memory systems.
+if (mem >= 256)
+
+  # (2) shared_buffers
+  #     Sets the number of shared memory buffers used by the server.
+  shared_buffers =
+  { "web" => mem/4,
+    "oltp" => mem/4,
+    "dw" => mem/4,
+    "mixed" => mem/4,
+    "desktop" => mem/16
+  }.fetch(db_type)
+
+  # Robert Haas has advised to cap the size of shared_buffers based on
+  # the memory architecture: 2GB on 32-bit and 8GB on 64-bit machines.
+  # http://rhaas.blogspot.com/2012/03/tuning-sharedbuffers-and-walbuffers.html
+  case node['kernel']['machine']
+  when "i386" # 32-bit machines
+    if shared_buffers > 2*1024
+      shared_buffers = 2*1024
+    end
+  when "x86_64" # 64-bit machines
+    if shared_buffers > 8*1024
+      shared_buffers = 8*1024
+    end
+  end
+
+  node.default['postgresql']['config']['shared_buffers'] = binaryround(shared_buffers*1024*1024)
+
+  # (3) effective_cache_size
+  #     Sets the planner's assumption about the size of the disk cache.
+  #     That is, the portion of the kernel's disk cache that will be
+  #     used for PostgreSQL data files.
+  effective_cache_size =
+  { "web" => mem * 3 / 4,
+    "oltp" => mem * 3 / 4,
+    "dw" => mem * 3 / 4,
+    "mixed" => mem * 3 / 4,
+    "desktop" => mem / 4
+  }.fetch(db_type)
+
+  node.default['postgresql']['config']['effective_cache_size'] = binaryround(effective_cache_size*1024*1024)
+
+  # (4) work_mem
+  #     Sets the maximum memory to be used for query workspaces.
+  mem_con_v = (mem.to_f / con).ceil
+
+  work_mem =
+    { "web" => mem_con_v,
+      "oltp" => mem_con_v,
+      "dw" => mem_con_v / 2,
+      "mixed" => mem_con_v / 2,
+      "desktop" => mem_con_v / 6
+    }.fetch(db_type)
+
+  node.default['postgresql']['config']['work_mem'] = binaryround(work_mem*1024*1024)
+
+  # (5) maintenance_work_mem
+  #     Sets the maximum memory to be used for maintenance operations.
+  #     This includes operations such as VACUUM and CREATE INDEX.
+  maintenance_work_mem =
+  { "web" => mem / 16,
+    "oltp" => mem / 16,
+    "dw" => mem / 8,
+    "mixed" => mem / 16,
+    "desktop" => mem / 16
+  }.fetch(db_type)
+
+  # Cap maintenence RAM at 1GB on servers with lots of memory
+  if (maintenance_work_mem > 1*1024)
+      maintenance_work_mem = 1*1024
+  end
+
+  node.default['postgresql']['config']['maintenance_work_mem'] = binaryround(maintenance_work_mem*1024*1024)
+
+end
+
+#######
+# Checkpoint-related parameters that affect transaction rate and
+# maximum tolerable recovery playback time.
+
+# (6) checkpoint_segments
+#     Sets the maximum distance in log segments between automatic WAL checkpoints.
+checkpoint_segments =
+{ "web" => 8,
+  "oltp" => 16,
+  "dw" => 64,
+  "mixed" => 16,
+  "desktop" => 3
+}.fetch(db_type)
+
+node.default['postgresql']['config']['checkpoint_segments'] = checkpoint_segments
+
+# (7) checkpoint_completion_target
+#     Time spent flushing dirty buffers during checkpoint, as fraction
+#     of checkpoint interval.
+checkpoint_completion_target =
+{ "web" => "0.7",
+  "oltp" => "0.9",
+  "dw" => "0.9",
+  "mixed" => "0.9",
+  "desktop" => "0.5"
+}.fetch(db_type)
+
+node.default['postgresql']['config']['checkpoint_completion_target'] = checkpoint_completion_target
+
+# (8) wal_buffers
+#     Sets the number of disk-page buffers in shared memory for WAL.
+# Starting with 9.1, wal_buffers will auto-tune if set to the -1 default.
+# For 8.X and 9.0, it needed to be specified, which pgtune did as follows.
+if node['postgresql']['version'].to_f < 9.1
+  wal_buffers = 512 * checkpoint_segments
+  # The pgtune seems to use 1kB units for wal_buffers
+  node.default['postgresql']['config']['wal_buffers'] = binaryround(wal_buffers*1024)
+else
+  node.default['postgresql']['config']['wal_buffers'] = "-1"
+end
+
+# (9) default_statistics_target
+#     Sets the default statistics target. This applies to table columns
+#     that have not had a column-specific target set via
+#     ALTER TABLE SET STATISTICS.
+default_statistics_target =
+{ "web" => 100,
+  "oltp" => 100,
+  "dw" => 500,
+  "mixed" => 100,
+  "desktop" => 100
+}.fetch(db_type)
+
+node.default['postgresql']['config']['default_statistics_target'] = default_statistics_target