~ivoks/charms/trusty/memcached/bind-to-interface

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Jorge O. Castro
  • Date: 2014-01-15 18:42:43 UTC
  • Revision ID: jorge@ubuntu.com-20140115184243-4n7othe6n8nhtuup
Add a README.md

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
# Overview
 
2
 
 
3
[Memcached](http://memcached.org) is a Free & open source, high-performance, distributed memory object caching system, generic in nature, but intended for use in speeding up dynamic web applications by alleviating database load.
 
4
 
 
5
Memcached is an in-memory key-value store for small chunks of arbitrary data (strings, objects) from results of database calls, API calls, or page rendering.
 
6
 
 
7
# Usage
 
8
 
 
9
You can deploy a memcached instance with
 
10
 
 
11
    juju deploy memcached
 
12
 
 
13
Memcached listens to port 11211 on the internal network, it is not recommended to expose memcached directly to the open internet. If you want to check that it has deployed correctly you can ssh into the unit and then check the port by hand:
 
14
 
 
15
    juju status memcached
 
16
    juju ssh memcached/3
 
17
    echo "stats settings" | nc localhost 11211
 
18
 
 
19
The "3" in this case is an example, the `juju status memcached` will show you which machine number the service is running on so you can `juju ssh` to it.
 
20
 
 
21
## Scale out Usage
 
22
 
 
23
This charm currently does not have any scale out workloads implemented
 
24
 
 
25
## Known Limitations and Issues
 
26
 
 
27
- This charm does not implement scale out functionality at this time, so `juju add-unit memcached` will not properly autoscale. This is filed as bug #[1269537](https://bugs.launchpad.net/charms/+source/memcached/+bug/1269537).
 
28
 
 
29
# Configuration
 
30
 
 
31
Standard configuration options are provided, we recommend scanning the [Memcached documentation](https://code.google.com/p/memcached/wiki/NewConfiguringServer) before tweaking the default configuration.
 
32
 
 
33
# Contact Information
 
34
 
 
35
Though this will be listed in the charm store itself don't assume a user will know that, so include that information here:
 
36
 
 
37
## Memcached
 
38
 
 
39
- [Memcached website](http://memcached.org)
 
40
- [Memcached bug tracker](https://code.google.com/p/memcached/issues/list)
 
41
- [Memcached mailing list](https://groups.google.com/forum/#!forum/memcached)
 
 
b'\\ No newline at end of file'