Merge lp:~mbruzek/charms/precise/redis-slave/README into lp:charms/redis-slave

Proposed by Matt Bruzek
Status: Merged
Merged at revision: 7
Proposed branch: lp:~mbruzek/charms/precise/redis-slave/README
Merge into: lp:charms/redis-slave
Diff against target: 121 lines (+106/-1)
3 files modified
README.md (+88/-0)
copyright (+18/-0)
revision (+0/-1)
To merge this branch: bzr merge lp:~mbruzek/charms/precise/redis-slave/README
Reviewer Review Type Date Requested Status
charmers Pending
Review via email: mp+231733@code.launchpad.net

Description of the change

The redis-slave charm lacks a copyright and README file, this merge adds them.

To post a comment you must log in.

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== added file 'README.md'
--- README.md 1970-01-01 00:00:00 +0000
+++ README.md 2014-08-21 13:37:06 +0000
@@ -0,0 +1,88 @@
1# Overview
2
3Redis (<http://redis.io>) is an open source, advanced key-value cache and
4store. It is often referred to as a data structure server since keys can
5contain strings, hashes, lists, sets, sorted sets, bitmaps and hyperloglogs.
6In order to achieve its outstanding performance, Redis works with an in-memory
7dataset that can be written to disk. Redis also supports master-slave
8asynchronous replication.
9
10Redis can be configured in a master or slave configuration. This charm
11provides a slave implementation of Redis software. The slaves are configured
12as _read-only_ so you can not set values on a redis-slave. Go to the Redis
13web pages for more information on [replication](http://redis.io/topics/replication).
14
15# Usage
16
17To deploy this charm first bootstrap your Juju environment and issue the
18following commands:
19
20 juju deploy redis-master
21 juju deploy redis-slave
22
23 juju add-relation redis-slave:redis-master redis-master:redis-master
24
25Expose the slave or master if you need to contact them for some reason.
26
27 juju expose redis-slave
28
29# Replication
30
31Redis replication is very simple to use with Juju. Simply deploy a
32redis-master node and a redis-slave node and add the redis-master relation
33between them. Adding a relation causes the charms to properly configure
34master-slave replication on both servers without having to know how to
35configure Redis replication.
36
37Redis slaves contain the exact copy of the master server. Redis replication
38is a non-blocking operation, meaning the master and slave will continue to
39handle queries when synchronization starts from other nodes. A master can
40have multiple slaves.
41
42Go to the Redis web pages for more information on [replication](http://redis.io/topics/replication).
43
44
45# Testing Redis
46
47To test if Redis software is functioning properly telnet to the redis ip
48address using port 6379:
49
50 telnet redis-slave-ip 6379
51
52You can also install the redis-tools package `apt-get install redis-tools`
53and connect using the Redis client command:
54
55 redis-cli
56
57From there you can issue [Redis commands](http://redis.io/commands) to test
58that Redis is working as intended.
59
60Note that redis-slave are configured as read-only so set commands will not work.
61
62## Known Limitations and Issues
63
64If you run into problems or issues:
65
66Go to the [issue database on github](https://github.com/antirez/redis/issues) to check for problems related to the Redis software.
67
68Go to the [redis-slave page on launchpad](https://bugs.launchpad.net/charms/+source/redis-slave) to check for redis-slave related bugs.
69
70The Redis log file can be found on the deployed instance at:
71`/var/log/redis/redis-server.log`
72
73## Configuration
74
75There are no Juju configuration options for the redis-slave charm. Just deploy
76the charm in Juju and you will have a working Redis installation!
77
78## Contact Information
79
80The charm was originally created by Juan Negron <juan.negron@canonical.com>
81
82# Redis Information
83
84- Redis [home page](http://redis.io/)
85- Redis [github bug tracker](https://github.com/antirez/redis/issues)
86- Redis [documentation](http://redis.io/documentation)
87- Redis [mailing list](http://groups.google.com/group/redis-db)
88- Using IRC join the #redis channel on Freenode ([web access link](http://webchat.freenode.net/?channels=redis))
089
=== added file 'copyright'
--- copyright 1970-01-01 00:00:00 +0000
+++ copyright 2014-08-21 13:37:06 +0000
@@ -0,0 +1,18 @@
1Format: http://dep.debian.net/deps/dep5/
2
3Files: *
4Copyright: Copyright 2014, Canonical Ltd., All Rights Reserved.
5License: GPL-3
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
10 .
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
15 .
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
18
019
=== removed file 'revision'
--- revision 2011-10-13 08:15:47 +0000
+++ revision 1970-01-01 00:00:00 +0000
@@ -1,1 +0,0 @@
12

Subscribers

People subscribed via source and target branches

to all changes: