crowbar/crowbar-core

View on GitHub
chef/cookbooks/apache2/metadata.json

Summary

Maintainability
Test Coverage
{
  "platforms": {
    "debian": [

    ],
    "centos": [

    ],
    "arch": [

    ],
    "ubuntu": [

    ],
    "redhat": [

    ]
  },
  "suggestions": {

  },
  "license": "Apache 2.0",
  "conflicting": {

  },
  "long_description": "= DESCRIPTION:\n\nComplete Debian/Ubuntu style Apache2 configuration.\n\n= REQUIREMENTS:\n\nDebian or Ubuntu preferred.\n\nRed Hat, CentOS, Fedora and ArchLinux can be used but will be converted to a Debian/Ubuntu style Apache as it's far easier to manage with Chef.\n\n= ATTRIBUTES:\n\nThe file attributes/apache.rb contains the following attribute types:\n\n* platform specific locations and settings.\n* general settings\n* prefork attributes\n* worker attributes\n\nGeneral settings and prefork/worker attributes are tunable.\n\n= USAGE:\n\nInclude the apache2 recipe to install Apache2 and get 'sane' default settings. Configuration is modularized through Apache vhost sites a la Debian style configuration.\n\nFor Red Hat, CentOS and Fedora you should first disable selinux as it's not supported (yet), then remove the stock httpd and all it's dependencies prior to attempting to use this recipe. Many packages in these distributions drop conflicting configs into conf.d, all of which haven't been accounted for yet. Starting from scratch will also make it far easier to debug.\n\n== Defines:\n\n* +apache_module+: sets up an Apache module.\n* +apache_conf+: sets up a config file for an apache module.\n* +apache_site+: sets up a vhost site. The conf file must be available.\n* +web_app+: copies the template for a web app and enables it as a site via +apache_site+.\n\n== Web Apps:\n\nVarious applications that can be set up with Apache as the front end, such as PHP, Django, Rails and others can use the web_app define to set up the template and the Apache site. The define is kind of dumb, so the template needs have the application implementation settings, since we don't know what your app is or what is needed from Apache.\n\nWe only prototype one parameter for the +web_app+ define, \"template\". This is used to specify the name of the template to use in the current cookbook. When you use +web_app+, you can set up any parameters you want to use in your template. They will get passed to the template through the params hash. For example, the sample +web_app.conf.erb+ template in this cookbook makes use of these.\n\n* +docroot+\n* +server_name+\n* +server_aliases+\n\nThese are available as +params[:docroot]+, +params[:server_name]+, +params[:server_aliases]+ prefixed with an @ within the template.\n\nIf 'cookbook' and 'template' are not specified, the current cookbook's +templates/default/web_app.conf.erb+ will be used. If this template is not suitable for your application, copy it to your cookbook and customize as needed.\n\n== God Monitor:\n\nThere's a new recipe, +apache2::god_monitor+. You will need to make sure to include the 'god' recipe before using the +apache2::god_monitor+ recipe in your cookbook.\n\n== OpenID Auth\n\nInstalls the +mod_auth_openid+ module from source. Specify an array of OpenIDs that are allowed to authenticate with the attribute +apache[:allowed_openids]+. Use the following in a vhost to protect with OpenID authentication:\n\n    AuthOpenIDEnabled On\n    AuthOpenIDDBLocation /var/cache/apache2/mod_auth_openid.db\n    AuthOpenIDUserProgram /usr/local/bin/mod_auth_openid.rb\n\nChange the DBLocation as appropriate for your platform. You'll need to change the file in the recipe to match. The UserProgram is optional if you don't want to limit access by certain OpenIDs.\n\n= LICENSE & AUTHOR:\n\nAuthor:: Joshua Timberman (<joshua@opscode.com>)\nCopyright:: 2009, Opscode, Inc\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",
  "providing": {

  },
  "description": "Installs and configures all aspects of apache2 using Debian style symlinks with helper definitions",
  "version": "0.99.3",
  "maintainer": "Opscode, Inc.",
  "replacing": {

  },
  "attributes": {
    "apache/traceenable": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "On",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Trace Enable",
      "description": "Determine behavior of TRACE requests"
    },
    "apache/serversignature": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "On",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Server Signature",
      "description": "Configure footer on server-generated documents"
    },
    "apache/contact": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "ops@example.com",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Contact",
      "description": "Email address of webmaster"
    },
    "apache/icondir": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "/usr/share/apache2/icons",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Icondir",
      "description": "Directory location for icons"
    },
    "apache/user": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "www-data",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache User",
      "description": "User Apache runs as"
    },
    "apache/worker/threadsperchild": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "64",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Worker MPM ThreadsPerChild",
      "description": "Constant number of worker threads in each server process"
    },
    "apache/worker/maxclients": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "1024",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Worker MPM MaxClients",
      "description": "Maximum number of simultaneous connections"
    },
    "apache/worker": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "type": "hash",
      "recipes": [

      ],
      "display_name": "Apache Worker",
      "description": "Hash of Apache prefork tuning attributes."
    },
    "apache/keepaliverequests": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "100",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Keepalive Requests",
      "description": "Number of requests allowed on a persistent connection"
    },
    "apache/timeout": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "300",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Timeout",
      "description": "Connection timeout value"
    },
    "apache/worker/maxrequestsperchild": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "0",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Worker MPM MaxRequestsPerChild",
      "description": "Maximum number of request a child process will handle"
    },
    "apache/dir": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "/etc/apache2",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Directory",
      "description": "Location for Apache configuration"
    },
    "apache/prefork/serverlimit": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "400",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Prefork MPM ServerLimit",
      "description": "Upper limit on configurable server processes"
    },
    "apache/prefork/minspareservers": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "16",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Prefork MPM MinSpareServers",
      "description": "Minimum number of spare server processes"
    },
    "apache/allowed_openids": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Allowed OpenIDs",
      "description": "Array of OpenIDs allowed to authenticate"
    },
    "apache/binary": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "/usr/sbin/apache2",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Binary",
      "description": "Apache server daemon program"
    },
    "apache/prefork/startservers": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "16",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Prefork MPM StartServers",
      "description": "Number of MPM servers to start"
    },
    "apache/listen_ports": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": [
        "80",
        "443"
      ],
      "type": "array",
      "recipes": [

      ],
      "display_name": "Apache Listen Ports",
      "description": "Ports that Apache should listen on"
    },
    "apache/prefork/maxrequestsperchild": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "10000",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Prefork MPM MaxRequestsPerChild",
      "description": "Maximum number of request a child process will handle"
    },
    "apache/keepalivetimeout": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "5",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Keepalive Timeout",
      "description": "Time to wait for requests on persistent connection"
    },
    "apache/keepalive": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "On",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Keepalive",
      "description": "HTTP persistent connections"
    },
    "apache": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "type": "hash",
      "recipes": [

      ],
      "display_name": "Apache Hash",
      "description": "Hash of Apache attributes"
    },
    "apache/worker/maxsparethreads": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "192",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Worker MPM MaxSpareThreads",
      "description": "Maximum number of spare worker threads"
    },
    "apache/worker/startservers": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "4",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Worker MPM StartServers",
      "description": "Initial number of server processes to start"
    },
    "apache/prefork/maxclients": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "400",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Prefork MPM MaxClients",
      "description": "Maximum number of simultaneous connections"
    },
    "apache/prefork": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "type": "hash",
      "recipes": [

      ],
      "display_name": "Apache Prefork",
      "description": "Hash of Apache prefork tuning attributes."
    },
    "apache/servertokens": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "Prod",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Server Tokens",
      "description": "Server response header"
    },
    "apache/log_dir": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "/etc/apache2",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Log Directory",
      "description": "Location for Apache logs"
    },
    "apache/worker/minsparethreads": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "64",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Worker MPM MinSpareThreads",
      "description": "Minimum number of spare worker threads"
    },
    "apache/prefork/maxspareservers": {
      "required": "optional",
      "calculated": false,
      "choice": [

      ],
      "default": "32",
      "type": "string",
      "recipes": [

      ],
      "display_name": "Apache Prefork MPM MaxSpareServers",
      "description": "Maximum number of spare server processes"
    }
  },
  "maintainer_email": "cookbooks@opscode.com",
  "name": "apache2",
  "recipes": {
    "apache2::mod_dav": "Apache module 'dav'",
    "apache2::mod_proxy_ajp": "Apache module 'proxy_ajp'",
    "apache2::mod_php5": "Apache module 'php5'",
    "apache2::mod_mime": "Apache module 'mime' with config file",
    "apache2::mod_deflate": "Apache module 'deflate' with config file",
    "apache2::mod_ssl": "Apache module 'ssl' with config file, adds port 443 to listen_ports",
    "apache2::mod_setenvif": "Apache module 'setenvif' with config file",
    "apache2::mod_python": "Apache module 'python'",
    "apache2::mod_negotiation": "Apache module 'negotiation' with config file",
    "apache2::mod_cgi": "Apache module 'cgi'",
    "apache2::mod_authz_groupfile": "Apache module 'authz_groupfile'",
    "apache2::mod_auth_basic": "Apache module 'auth_basic'",
    "apache2::mod_rewrite": "Apache module 'rewrite'",
    "apache2::mod_dav_svn": "Apache module 'dav_svn'",
    "apache2::mod_autoindex": "Apache module 'autoindex' with config file",
    "apache2::mod_authz_host": "Apache module 'authz_host'",
    "apache2::mod_headers": "Apache module 'headers'",
    "apache2::mod_authz_user": "Apache module 'authz_user'",
    "apache2::mod_proxy_connect": "Apache module 'proxy_connect'",
    "apache2::mod_proxy": "Apache module 'proxy' with config file",
    "apache2::mod_fcgid": "Apache module 'fcgid', package on ubuntu/debian, rhel/centos, compile source on suse; with config file",
    "apache2::mod_authnz_ldap": "Apache module 'authnz_ldap'",
    "apache2::mod_auth_digest": "Apache module 'auth_digest'",
    "apache2::mod_env": "Apache module 'env'",
    "apache2::mod_status": "Apache module 'status' with config file",
    "apache2::mod_proxy_http": "Apache module 'proxy_http'",
    "apache2::mod_log_config": "Apache module 'log_config'",
    "apache2::mod_ldap": "Apache module 'ldap'",
    "apache2::mod_expires": "Apache module 'expires'",
    "apache2::mod_alias": "Apache module 'alias' with config file",
    "apache2": "Main Apache configuration",
    "apache2::mod_authn_file": "Apache module 'authn_file'",
    "apache2::mod_auth_openid": "Apache module 'authopenid'",
    "apache2::mod_proxy_balancer": "Apache module 'proxy_balancer'",
    "apache2::mod_dir": "Apache module 'dir' with config file",
    "apache2::mod_authz_default": "Apache module 'authz_default'"
  },
  "groupings": {

  },
  "dependencies": {

  },
  "recommendations": {

  }
}