Description

This is a template for deploying a PHP application from a git repo under mod_php on a single Linux server with OpenStack Heat on the Rackspace Cloud. This template is leveraging chef-solo to set up the server.

Requirements

• A Heat provider that supports the Rackspace OS::Heat::ChefSolo plugin.
• An OpenStack username, password, and tenant id.
• python-heatclient >= v0.2.8:

pip install python-heatclient

We recommend installing the client within a Python virtual environment.

Example Usage

Here is an example of how to deploy this template using the python-heatclient:

heat --os-username <OS-USERNAME> --os-password <OS-PASSWORD> --os-tenant-id \
  <TENANT-ID> --os-auth-url https://identity.api.rackspacecloud.com/v2.0/ \
  stack-create myphpapp -f php_app_single.yaml \
  -P repo=https://github.com/MyUser/MyApp.git -P url=http://myapp.org

• For UK customers, use https://lon.identity.api.rackspacecloud.com/v2.0/ as the --os-auth-url.

Optionally, set environment variables to avoid needing to provide these values every time a call is made:

export OS_USERNAME=<USERNAME>
export OS_PASSWORD=<PASSWORD>
export OS_TENANT_ID=<TENANT-ID>
export OS_AUTH_URL=<AUTH-URL>

Parameters

Parameters can be replaced with your own values when standing up a stack. Use the -P flag to specify a custom parameter.

• server_hostname: Hostname to give your Cloud Servers (Default: php)
• image: Operating system to use (Default: Ubuntu 12.04 LTS (Precise Pangolin))
• flavor: Cloud Server size to use. (Default: 4 GB Performance)
• ssh_keypair_name: Name of the SSH key pair to register with nova (Default: none)
• revision: Git tag or commit hash that should be deployed (Default: HEAD)
• packages: Comma delimited list of additional system packages to install (Default: none)
• repo: specifies a git URL from which to reploy the app (Default: none)
• url: the base url for your application (Default: http://example.com)
• deploy_key: Private key to deploy from a private git repo.
• destination: Directory into which the application will be installed. (Default: /var/www/vhosts/application)
• public: the url path on which the application is accessed (Default: /)
• http_port: the port where http connections are accepted (Default: 80)
• https_port: the port where https connections are accepted (Default: 443)
• memcached_size: Amount of memory, in MB, for memcached to use (Default: 128)
• kitchen: URL for the kitchen to clone with git. The Chef Solo run will copy all files in this repo into the kitchen for the chef run. (Default: https://github.com/rackspace-orchestration-templates/php-app-single)
• chef_version: Chef client version to install for the chef run. (Default: 11.12.4)

Outputs

Once a stack comes online, use heat output-list to see all available outputs. Use heat output-show <OUTPUT NAME> to get the value fo a specific output.

• private_key: SSH private that can be used to login as root to the server.
• server_ip: Public IP address of the cloud server
• mysql_root_password: password for the MySQL root account

For multi-line values, the response will come in an escaped form. To get rid of the escapes, use echo -e '<STRING>' > file.txt. For vim users, a substitution can be done within a file using %s/\\n/\r/g.

Stack Details

By default the application will be deployed under /var/www/application

Contributing

There are substantial changes still happening within the OpenStack Heat project. Template contribution guidelines will be drafted in the near future.

License

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.