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

Proposed by Matt Bruzek
Status: Merged
Merged at revision: 9
Proposed branch: lp:~mbruzek/charms/precise/redis-master/README
Merge into: lp:charms/redis-master
Diff against target: 109 lines (+94/-1)
3 files modified
README.md (+76/-0)
copyright (+18/-0)
revision (+0/-1)
To merge this branch: bzr merge lp:~mbruzek/charms/precise/redis-master/README
Reviewer Review Type Date Requested Status
Marco Ceppi (community) Approve
Chris Glass (community) Approve
Review via email: mp+231732@code.launchpad.net

Description of the change

The redis-master charm lacks a copyright and README this merge adds them.

To post a comment you must log in.
Revision history for this message
Chris Glass (tribaal) wrote :

Nice! +1

review: Approve
Revision history for this message
Marco Ceppi (marcoceppi) wrote :

LGTM

review: Approve

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:36:00 +0000
4@@ -0,0 +1,76 @@
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 single stand alone master implementation of Redis software. Go to
16+the Redis web pages for more information on [replication](http://redis.io/topics/replication).
17+
18+# Usage
19+
20+To deploy this charm first bootstrap your Juju environment and issue the
21+following command:
22+
23+ juju deploy redis-master
24+
25+
26+Expose the master if you need to contact them for some reason.
27+
28+ juju expose redis-master
29+
30+
31+# Replication
32+
33+Redis can be set up with master-slave replication in Juju. This allows the
34+Redis slave to be an exact copy of master server. A master can have multiple
35+slaves.
36+
37+See the [redis-slave](http://manage.jujucharms.com/charms/precise/redis-slave) charm for more details about how to configure the Juju charms with replication.
38+
39+# Testing Redis
40+
41+To test if Redis software is functioning properly telnet to the redis ip
42+address using port 6379:
43+
44+ telnet redis-master-ip 6379
45+
46+You can also install the redis-tools package `apt-get install redis-tools`
47+and connect using the Redis client command:
48+
49+ redis-cli
50+
51+From there you can issue [Redis commands](http://redis.io/commands) to test
52+that Redis is working as intended.
53+
54+## Known Limitations and Issues
55+
56+If you run into problems or issues:
57+
58+Go to the [issue database on github](https://github.com/antirez/redis/issues) to check for problems related to the Redis software.
59+
60+Go to the [redis-master page on launchpad](https://bugs.launchpad.net/charms/+source/redis-master) to check for redis-master related bugs.
61+
62+The Redis log file can be found on the deployed instance at:
63+`/var/log/redis/redis-server.log`
64+
65+## Configuration
66+
67+There are no configuration options for the redis-master charm. Just deploy
68+the charm in Juju and you will have a working Redis installation!
69+
70+## Contact Information
71+
72+The charm was originally created by Juan Negron <juan.negron@canonical.com>
73+
74+# Redis Information
75+
76+- Redis [home page](http://redis.io/)
77+- Redis [github bug tracker](https://github.com/antirez/redis/issues)
78+- Redis [documentation](http://redis.io/documentation)
79+- Redis [mailing list](http://groups.google.com/group/redis-db)
80+- Using IRC join the #redis channel on Freenode ([web access link](http://webchat.freenode.net/?channels=redis))
81
82=== added file 'copyright'
83--- copyright 1970-01-01 00:00:00 +0000
84+++ copyright 2014-08-21 13:36:00 +0000
85@@ -0,0 +1,18 @@
86+Format: http://dep.debian.net/deps/dep5/
87+
88+Files: *
89+Copyright: Copyright 2014, Canonical Ltd., All Rights Reserved.
90+License: GPL-3
91+ This program is free software: you can redistribute it and/or modify
92+ it under the terms of the GNU General Public License as published by
93+ the Free Software Foundation, either version 3 of the License, or
94+ (at your option) any later version.
95+ .
96+ This program is distributed in the hope that it will be useful,
97+ but WITHOUT ANY WARRANTY; without even the implied warranty of
98+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
99+ GNU General Public License for more details.
100+ .
101+ You should have received a copy of the GNU General Public License
102+ along with this program. If not, see <http://www.gnu.org/licenses/>.
103+
104
105=== removed file 'revision'
106--- revision 2011-10-13 08:12:21 +0000
107+++ revision 1970-01-01 00:00:00 +0000
108@@ -1,1 +0,0 @@
109-2

Subscribers

People subscribed via source and target branches

to all changes: