← Back to branch summary

~dspiteri/charms/precise/cassandra/prodchanges

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Jorge O. Castro
  • Date: 2013-08-02 19:11:22 UTC
  • Revision ID: jorge@ubuntu.com-20130802191122-kbid4ly7petazrvp
Convert README to Markdown

Show diffs side-by-side

added added

removed removed

Lines of Context:
README.md
1
 
Overview
2
 
--------
 
1
# Apache Cassandra Overview
3
2
 
4
3
The Apache Cassandra database is the right choice when you need scalability
5
4
and high availability without compromising performance. Linear scalability
13
12
with the performance of log-structured updates, strong support for materialized
14
13
views, and powerful built-in caching.
15
14
 
16
 
See http://cassandra.apache.org for more information.
 
15
See [cassandra.apache.org](http://cassandra.apache.org) for more information.
17
16
 
18
 
Usage
19
 
-----
 
17
# Usage
20
18
 
21
19
Cassandra deployments are relatively simple in that they consist of a set of
22
20
Cassandra nodes which seed from each other to create a ring of servers::
23
 
 
 
21
    
24
22
    juju deploy --repository . local:cassandra
25
23
    juju add-unit -n 2 cassandra
26
24
 
29
27
The API to Cassandra is supported through Apache Thrift; Thrift is a software
30
28
framework for scalable cross-language services development.
31
29
 
32
 
See http://wiki.apache.org/cassandra/ThriftInterface for more details of how
 
30
See [this documentation](http://wiki.apache.org/cassandra/ThriftInterface) for more details of how
33
31
to use this API.
34
32
 
35
33
Cassandra recommend using one of the many client options - see
36
 
http://wiki.apache.org/cassandra/ClientOptions for more details
 
34
[ClientOptions(http://wiki.apache.org/cassandra/ClientOptions) for more details
37
35
 
38
36
To relate the Cassandra charm to a service that understands how to talk to
39
37
Cassandra using thrift::
41
39
    juju deploy --repository . local:service-that-needs-cassandra
42
40
    juju add-relation service-that-needs-cassandra cassandra
43
41
 
44
 
Configuration
45
 
-------------
 
42
# Configuration
46
43
 
47
44
Cassandra has a pretty good guess at configuring its Java memory settings to
48
45
fit the machine that it has been deployed on.
63
60
pre-allocate all memory to avoid freezes during operation (this happens
64
61
during normal operation as more memory is allocated to heap.
65
62
 
66
 
Words of Caution
67
 
----------------
 
63
# Words of Caution
68
64
 
69
65
Changing the configuration of a deployed Cassandra cluster is supported; however
70
66
it will result in a restart of each Cassandra node as the changes are implemented