Download as
Browse Code »

Commit 56dd9d0ad03d8029ee0562461d6dd1f5748c67c2

Authored by Paulo Tada
1 parent c2802883
Exists in master and in 5 other branches automates_core_packing, high_contrast, high_contrast_style, mezuro_spb, stable-5.1

Updating README.chef.md

Showing 1 changed file with 28 additions and 17 deletions   Show diff stats
README.chef.md
  Diff comments   View file @56dd9d0
... ... @@ -3,7 +3,8 @@
3 3 ## Requirements
4 4  
5 5 * [chake](https://rubygems.org/gems/chake)
6   -* rake
  6 +* [rake](https://rubygems.org/gems/rake)
  7 +* python-sphinx
7 8  
8 9 For development
9 10  
... ... @@ -15,16 +16,22 @@ For development
15 16 ## Configuration parameters
16 17  
17 18 All configuration parameters are defined in `nodes.yaml`, with exception of IP
18   -addresses, which are defined in different files:
19   -
20   -- for local development, the IP addresses of the Vagrant VMs are defined in
21   - config/local/ips.yaml.
22   -
23   -- for production, you need to create a new file called
24   - `config/production/ips.yaml`
25   -
26   -You will probably not need to change nodes.yaml unless you are developing the
27   -deployment process.
  19 +addresses and ssh configuration, which are defined in different files.
  20 +Each environment are defined on `config/<ENV>/*` and to deploy
  21 +you're need to use the `SPB_ENV` variable. The environment
  22 +`local` is defined by default. The files to configure a new env are:
  23 +
  24 +- **config.yaml**: any configuration used for the specific environment.
  25 +- **ips.yaml**: the IP of each node.
  26 +- **ssh_config**: used to login into the machine with the
  27 +command `rake login:$server`.
  28 +- **iptables-filter-rules**: any iptables configuration needed
  29 +to the environment.
  30 +
  31 +If you need to do any changes on the IPs addresses, make sure
  32 +that the ips.yaml are configure for the right environment.
  33 +You will probably not need to change nodes.yaml unless you are
  34 +developing the deployment process.
28 35  
29 36 ## Deploy
30 37  
... ... @@ -38,9 +45,13 @@ $ rake preconfig
38 45 $ rake bootstrap_common
39 46 ```
40 47  
41   -Right now there are 5 VM's, so this might take a while. The basic commands for
42   -deployment:
  48 +```
  49 +WARNING: Right now there are 7 VM's: six of them with 512MB of
  50 + RAM and one with 1GB of RAM. Make sure that your local machine
  51 + can handle this environment. Also, this might take a while.
  52 +```
43 53  
  54 +The basic commands for deployment:
44 55 ```bash
45 56 $ rake # deploys all servers
46 57 $ rake nodes # lists all servers
... ... @@ -60,7 +71,8 @@ $ rake preconfig SPB_ENV=production
60 71 ```
61 72  
62 73 This will perform some initial configuration to the system that is required
63   -before doing the actual deployment.
  74 +before doing the actual deployment. This command should only be
  75 +runned **one** time.
64 76  
65 77 After that:
66 78  
... ... @@ -70,8 +82,8 @@ $ rake nodes SPB_ENV=production # lists all servers
70 82 $ rake converge:$server SPB_ENV=production # deploys only $server
71 83 ```
72 84  
73   -You can also do `export SPB_ENV=production` in your shell and omit it in the
74   -`rake` calls.
  85 +You can also do `export SPB_ENV=production` in your shell and
  86 +omit it in the `rake` calls.
75 87  
76 88 See the output of `rake -T` for other tasks.
77 89  
... ... @@ -93,4 +105,3 @@ Google DNS servers will do that automatically, otherwise you might add the follo
93 105 127.0.53.53 softwarepublico.dev
94 106 127.0.53.53 listas.softwarepublico.dev
95 107 ```
96   -
... ...