~ce-hyperscale/charms/precise/wordpress/arm64-trusty

« back to all changes in this revision

Viewing changes to README.md

  • Committer: Jorge O. Castro
  • Date: 2013-12-12 18:42:27 UTC
  • Revision ID: jorge@ubuntu.com-20131212184227-njjnb8k12towzrqf
README and Metadata audit updates.

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
WordPress is a powerful blogging platform written in PHP. This charm aims to deploy WordPress in a fashion that will allow anyone to scale and grow out
4
4
a single installation.
5
5
 
6
 
# Installation
 
6
# Usage
7
7
 
8
8
This charm is available in the Juju Charm Store, to deploy you'll need at a minimum: a cloud environment, a working Juju installation,
9
9
and a successful bootstrap. Please refer to the [Juju Getting Started](https://juju.ubuntu.com/docs/getting-started.html) documentation before continuing.
21
21
 
22
22
    juju expose wordpress
23
23
 
 
24
## Scaled Down Usage for Personal Use
 
25
 
 
26
If you're just looking to run a personal blog and want to save money you can run all of this on a single node, here's an entire single node installation from scratch: 
 
27
 
 
28
    juju bootstrap
 
29
    juju deploy --to 0 wordpress
 
30
    juju deploy --to 0 mysql
 
31
    juju add-relation wordpress mysql 
 
32
    juju expose wordpress
 
33
 
 
34
This will run everything on one node, however we still have the flexibility to grow horizontally. If your blog gets more traffic and you need to scale:
 
35
 
 
36
    juju add-unit wordpress
 
37
 
 
38
Since we're omitting the `--to` command Juju will fire up a new dedicated machine for Wordpress and relate it. You can also `remove-unit` when the surge is over and go back to a cheaper one node set up. 
 
39
 
 
40
# Scale Out Usage 
 
41
 
 
42
You can deploy a memcached server and relate it to your WordPress service to add memcache caching. This will 
 
43
automagically install [WP-FFPC](http://wordpress.org/extend/plugins/wp-ffpc/) (regardless of your tuning settings) and configure it to cache 
 
44
rendered pages to the memcache server. In addition to this layer of caching, Nginx will pull directly from memcached bypassing PHP altogether. 
 
45
You could theoretically then turn off php5-fpm on all of your servers and just have Nginx serve static content via memcached (though, you 
 
46
wouldn't be able to access the admin panel or any uncached pages - it's just a potential scenario).
 
47
 
 
48
    juju deploy memcached
 
49
    juju add-relation memcached wordpress
 
50
    
 
51
This setup will also synchronize the flushing of cache across all WordPress nodes, making it ideal to avoid stale caches.
 
52
 
 
53
A small note, when using the Apache2 engine and memcache, all request will still be sent to WordPress via Apache where typical caching 
 
54
procedures will take place and wp-ffpc will render the memcached page.
 
55
 
24
56
# Configuration
25
57
 
26
58
This WordPress charm comes with several tuning levels designed to encompass the different styles in which this charm will be used.
27
59
 
28
 
## Tuning
29
 
 
30
60
A use case for each tuning style is outlined below:
31
61
 
32
 
### Bare
 
62
## Bare
33
63
 
34
64
The Bare configuration option is meant for those who wish to run the stock WordPress setup with no caching, no manipulation of data, 
35
65
and no additional scale out features enabled. This is ideal if you intend to install additional plugins to deal with coordinating
40
70
 
41
71
    juju set wordpress tuning=bare
42
72
 
43
 
### Single
 
73
## Single
44
74
 
45
75
When running in Single mode, this charm will make every attempt to provide a solid base for your WordPress install. By running in single
46
76
the following will be enabled: Nginx microcache, APC OpCode caching, WordPress caching module, and the ability to sync files via NFS.
52
82
 
53
83
    juju set wordpress tuning=single
54
84
 
55
 
### Optimized
 
85
## Optimized
56
86
 
57
87
If you need to run WordPress on more than one instance constantly, or require scaling out and in on a regular basis, then Optimized is the
58
88
recommended configuration. When you run WordPress under an Optimized tuning level, the ability to install, edit, and upgrade themes and plugins
64
94
 
65
95
    juju set wordpress tuning=optimized
66
96
 
67
 
## wp-content
 
97
### Handling wp-content
68
98
 
69
99
In order to allow for custom WordPress content within the Juju charm a separate configuration option exists for pointing to any Git or Bzr 
70
100
repository. An example of a valid formed wp-content repository can be found on the [Juju Tools Github page](https://github.com/jujutools/wordpress-site). 
128
158
 
129
159
Any other value will result in the default (nginx) being used.
130
160
 
131
 
# Caveats
 
161
# Known Limitations and Issues
132
162
 
133
 
## HP Cloud
 
163
## HP Cloud 
134
164
 
135
165
At this time WordPress + Memcached don't work on HP Cloud's standard.xsmall. To get around this deploy the WordPress charm with the 
136
166
charm to at least a `standard.small`, to do this:
161
191
 
162
192
    juju add-unit -n3 wordpress
163
193
 
164
 
## I want more caching, I want MEMCACH(ED)ING!
165
 
 
166
 
Why not? We could ALL use more caching. Deploy a memcached server and relate it to your WordPress service to add memcache caching. This will 
167
 
automagically install [WP-FFPC](http://wordpress.org/extend/plugins/wp-ffpc/) (regardless of your tuning settings) and configure it to cache 
168
 
rendered pages to the memcache server. In addition to this layer of caching, Nginx will pull directly from memcached bypassing PHP altogether. 
169
 
You could theoretically then turn off php5-fpm on all of your servers and just have Nginx serve static content via memcached (though, you 
170
 
wouldn't be able to access the admin panel or any uncached pages - it's just a potential scenario).
171
 
 
172
 
    juju deploy memcached
173
 
    juju add-relation memcached wordpress
174
 
    
175
 
This setup will also synchronize the flushing of cache across all WordPress nodes, making it ideal to avoid stale caches.
176
 
 
177
 
A small note, when using the Apache2 engine and memcache, all request will still be sent to WordPress via Apache where typical caching 
178
 
procedures will take place and wp-ffpc will render the memcached page.
179
 
 
180
 
## I don't want to run three different machines for one WP install
181
 
 
182
 
If you're just looking to run a personal blog and want to save money you can run all of this on a single node, here's an entire single node installation from scratch
183
 
 
184
 
    juju bootstrap
185
 
    juju deploy --to 0 wordpress
186
 
    juju deploy --to 0 mysql
187
 
    juju add-relation wordpress mysql 
188
 
    juju expose wordpress
189
 
 
190
 
This will run everything on one node, however we still have the flexibility to grow horizontally. If your blog gets more traffic and you need to scale:
191
 
 
192
 
    juju add-unit wordpress
193
 
 
194
 
Since we're omitting the `--to` command Juju will fire up a new dedicated machine for Wordpress and relate it. You can also `remove-unit` when the surge is over and go back to a cheaper one node set up. 
 
 
b'\\ No newline at end of file'
 
194
# Contact Information
 
195
 
 
196
## WordPress Contact Information
 
197
 
 
198
- [WordPress Homepage](http://www.wordpress.org)
 
199
- [Reporting bugs](http://codex.wordpress.org/Reporting_Bugs) on WordPress itself
 
 
b'\\ No newline at end of file'