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

Subscribers

People subscribed via source and target branches

to all changes: