Description

This is a template for deploying a memcached server on a single Linux server with OpenStack Heat on the Rackspace Cloud. This template uses chef-solo to setup 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 memcached-stack -f memcached.yaml \
  -P server_hostname=memcache -P ssh_keypair_name=memcache-example

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

Optionally, set environmental 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: Sets the hostname of the server. (Default: memcache)
image: Operating system to install (Default: Ubuntu 14.04 LTS (Trusty Tahr) (PVHVM))
flavor: Cloud server size to use. (Default: 1 GB Performance)
ssh_keypair_name: Name of the SSH key pair to register with nova (Default: none)
memory_percentage: Percentage of server memory to allow memcached to use (Default: 60)
memcached_port: TCP port that memcached will listen on (Default: 11211)

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
memcached_port: TCP port that memcached will listen on

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

memcached is configured to start on boot. There are firewall rules limiting accepted connection to port 22 and the memcached port specified.

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.

rackspace-orchestration-templates/memcached