Skip to content

Commit 55a8ff9

Browse files
dharmabumsteaddharmabumstead
committed
Merge branch '4.0.2'
* 4.0.2: DOC-1403: cleaning up getting started section of the user guide; adding content suggestions from doc summit. DOC-1469: new content for troubleshooting in ops content DOC-1469: new content for monitoring and policies DOC-1403: rearranging/denormalizing existing content to enhance getting started flow. DOC-1469: updates to recovery narrative. DOC-1469: Adding files and content for new backup and recovery narratives. DOC-1469: updated backup content. Edits to structure from pull request 1e38cbe. Corrected 4.0.1 paths and added clarification for setting up secure HTTP. Likewise for user console section in the admin guide. DOC-1458: Added missing steps and revised incorrect ones. Initial pass at DOC-1462: euca2ools release notes for 3.0.4 and 3.1.1 Fixes DOC-895; also fixes a typo in the health check configuration example. DOC-1469: Adding file for back-up content.
2 parents 1e38cbe + 414c1a4 commit 55a8ff9

29 files changed

+918
-224
lines changed

‎content/en_us/admin-guide/backup_euca.dita

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3+
<task id="backup_euca">
4+
<title>Back Up Your Cloud</title>
5+
<shortdesc>This section explains what you need to back up to protect your cloud data.</shortdesc>
6+
<taskbody>
7+
<context>
8+
<p>We recommend that you back up the following data:</p>
9+
<ul>
10+
<li>The cloud database: see <xref href="backup_postgres.dita"/></li>
11+
<li>Object storage. For objects in Walrus, the frequency depends on current load. Use your
12+
own discretion to determine backup plan and strategy. You must have Walrus running. For
13+
information about backing up Riak CS, go to <xref
14+
href="http://docs.basho.com/riak/latest/ops/running/backups/" scope="external"
15+
format="html">Backing Up Riak</xref>.
16+
</li>
17+
<li>Volumes in each cluster (DAS and Overlay)</li>
18+
<li>Configuration files for each Eucalyptus component
19+
(<filepath>/etc/eucalyptus/eucalyptus.conf</filepath>)</li>
20+
<li>Eucalyptus and LVM snapshots</li>
21+
<li>SAN technologies vary, so see the backup documentation for your SAN.</li>
22+
</ul>
23+
<p>Users are responsible for volume backups using EBS snapshots on their defined schedules.</p>
24+
</context>
25+
</taskbody>
26+
</task>

‎content/en_us/admin-guide/backup_postgres.dita

+2-51
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
33
<task id="backup_postgres">
4-
<title>Back Up and Restore the Database</title>
5-
<shortdesc>To back up and restore the database follow the steps listed in this topic.</shortdesc>
4+
<title>Back Up the Database</title>
5+
<shortdesc>To back up the cloud database follow the steps listed in this topic.</shortdesc>
66
<taskbody>
77
<context>
88

@@ -20,55 +20,6 @@
2020
<codeblock>tar -czvf ~/eucalyptus-keydir.tgz /var/lib/eucalyptus/keys</codeblock>
2121
</info>
2222
</step>
23-
<step>
24-
<cmd>Stop the CLC service.</cmd>
25-
<info>
26-
<codeblock>/etc/init.d/eucalyptus-cloud stop</codeblock>
27-
</info>
28-
</step>
29-
<step>
30-
<cmd>Remove traces of the old database.</cmd>
31-
<info>
32-
<codeblock>rm -rf /var/lib/eucalyptus/db</codeblock>
33-
</info>
34-
</step>
35-
<step>
36-
<cmd>Re-initialize the database structure.</cmd>
37-
<info>
38-
<codeblock>euca_conf --initialize</codeblock>
39-
</info>
40-
</step>
41-
<step>
42-
<cmd>Start the database manually.</cmd>
43-
<info>
44-
<codeblock>su eucalyptus -c "/usr/pgsql-9.1/bin/pg_ctl start -w \
45-
-s -D/var/lib/eucalyptus/db/data -o '-h0.0.0.0/0 -p8777 -i'"</codeblock>
46-
</info>
47-
</step>
48-
<step>
49-
<cmd>Restore the backup.</cmd>
50-
<info>
51-
<codeblock>psql -U root -d postgres -p 8777 -h /var/lib/eucalyptus/db/data -f ~/eucalyptus_pg_dumpall-backup.sql</codeblock>
52-
</info>
53-
</step>
54-
<step>
55-
<cmd>Restore the keys.</cmd>
56-
<info>
57-
<codeblock>tar -xvf ~/eucalyptus-keysdir.tgz -C /</codeblock>
58-
</info>
59-
</step>
60-
<step>
61-
<cmd>Stop the database manually.</cmd>
62-
<info>
63-
<codeblock>su eucalyptus -c "/usr/pgsql-9.1/bin/pg_ctl stop -D/var/lib/eucalyptus/db/data"</codeblock>
64-
</info>
65-
</step>
66-
<step>
67-
<cmd>Start CLC service</cmd>
68-
<info>
69-
<codeblock>/etc/init.d/eucalyptus-cloud start</codeblock>
70-
</info>
71-
</step>
7223
</steps>
7324
</taskbody>
7425
</task>

‎content/en_us/admin-guide/euca_recover.dita

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3+
<task id="euca_recover">
4+
<title>Recover Cloud Data</title>
5+
<shortdesc>This topic explains what steps to take to bring your backed-up data to your cloud.</shortdesc>
6+
<taskbody>
7+
<context>
8+
<p>We recommend that you back up the following data:</p>
9+
<ul>
10+
<li>The cloud database: see <xref href="restore_postgres.dita"/></li>
11+
<li>Objects in Walrus: The frequency depends on current load. Use your own discretion to determine backup plan and strategy
12+
You must have Walrus running.
13+
</li>
14+
<li>Volumes in each cluster (DAS and Overlay)</li>
15+
<li>Configuration files for each Eucalyptus component
16+
(<filepath>/etc/eucalyptus/eucalyptus.conf</filepath>)</li>
17+
<li>Eucalyptus and LVM snapshots</li>
18+
<li>SAN technologies vary, so see the backup documentation for your SAN.</li>
19+
</ul>
20+
<p>Users are responsible for volume backups using EBS snapshots on their defined schedules.</p>
21+
</context>
22+
23+
</taskbody>
24+
</task>

‎content/en_us/admin-guide/ops-monitoring.dita

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="ops-monitoring">
4+
<title>Monitoring</title>
5+
<shortdesc>This topic includes details about which resources you should monitor.</shortdesc>
6+
<conbody>
7+
<table>
8+
<tgroup cols="3">
9+
<thead>
10+
<row>
11+
<entry>Component</entry>
12+
<entry>Open Ports</entry>
13+
<entry>Running Processes</entry>
14+
</row>
15+
</thead>
16+
<tbody>
17+
<row>
18+
<entry>Cloud Controller (CLC)</entry>
19+
<entry>8773 (web services), 8777 (PostGres)</entry>
20+
<entry>eucalyptus-cloud, postgres</entry>
21+
</row>
22+
<row>
23+
<entry>User-facing services (UFS)</entry>
24+
<entry></entry>
25+
<entry>eucalyptus-cloud</entry>
26+
</row>
27+
<row>
28+
<entry>Walrus</entry>
29+
<entry></entry>
30+
<entry>eucalyptus-cloud</entry>
31+
</row>
32+
<row>
33+
<entry>Cluster Controller (CC) </entry>
34+
<entry></entry>
35+
<entry>eucalyptus-cloud</entry>
36+
</row>
37+
<row>
38+
<entry>Storage Controller (SC) </entry>
39+
<entry></entry>
40+
<entry>eucalyptus-cloud, tgtd (for DAS and Overlay)</entry>
41+
</row>
42+
<row>
43+
<entry>Node Controller (NC) </entry>
44+
<entry></entry>
45+
<entry>httpd, dhcpd, eucanetd (edge modes), qemu-kvm / 1 per instance </entry>
46+
</row>
47+
<row>
48+
<entry>User Console</entry>
49+
<entry>8888</entry>
50+
<entry>eucaconsole</entry>
51+
</row>
52+
</tbody>
53+
</tgroup>
54+
</table>
55+
</conbody>
56+
</concept>

‎content/en_us/admin-guide/ops_policies.dita

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="ops_policies">
4+
<title>Managing Policies</title>
5+
<shortdesc>This topic details best practices for managing your cloud policies.</shortdesc>
6+
<conbody>
7+
<ul>
8+
<li>Establish a workflow for account creation, including the initial request for a cloud account
9+
and the email containing credentials. </li>
10+
<li>Limit your use of individual policies. Focus your policies on groups and add individuals to
11+
the group. </li>
12+
<li>Use groups to assign permissions to individual users. Limit the use of policies for
13+
individual users.</li>
14+
</ul>
15+
<p>For more information about policy best practices, go to <xref
16+
href="http://docs.aws.amazon.com/IAM/latest/UserGuide/IAMBestPractices.html">IAM Best Practices</xref>.</p>
17+
</conbody>
18+
</concept>

‎content/en_us/admin-guide/ops_ts.dita

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd">
3+
<concept id="ops_ts">
4+
<title>Troubleshooting</title>
5+
<shortdesc>This topic details how to find information you need to troubleshoot most problems in
6+
your cloud.</shortdesc>
7+
<conbody>
8+
<p>Concept definition.</p>
9+
</conbody>
10+
</concept>

‎content/en_us/admin-guide/ops_ts_instance_fails.dita

+61
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3+
<task id="ops_ts_instance_fails">
4+
<title>Problem: instance runs but fails</title>
5+
<shortdesc/>
6+
<taskbody>
7+
<context>
8+
<p>Run <apiname>euca_describe_nodes</apiname> to verify if instance is there. </p>
9+
</context>
10+
<steps-unordered>
11+
<step>
12+
<cmd>If the instance is there:</cmd>
13+
<substeps>
14+
<substep>
15+
<cmd>Go to NC log for that NC and grep your instance ID and see if the instance is there.</cmd>
16+
<info>
17+
<ul>
18+
<li>If the instance is there: is there error message?
19+
<ul>
20+
<li>If there is an error message, this clues you in to some helpful information</li>
21+
<li>No: go to CC log, grep instance ID</li>
22+
</ul>
23+
</li>
24+
</ul>
25+
</info>
26+
</substep>
27+
<substep>
28+
<cmd>No: go to CC log, grep Instance ID. Is it there error message?</cmd>
29+
<info>
30+
<ul>
31+
<li>Yes: good- this clues you in to some helpful information
32+
</li>
33+
<li>No: grep instance ID in cloud-output.log. Is there error message?
34+
<ul><li>Yes: good - this clues you in to some helpful information</li>
35+
<li>No: grep volume ID in SC log</li></ul></li>
36+
</ul>
37+
</info>
38+
</substep>
39+
</substeps>
40+
41+
</step>
42+
<step><cmd>If the instance is not there, log in as admin and run
43+
<apiname>euca_describe_instance</apiname>. Is the instance there?</cmd>
44+
<info>
45+
<ul>
46+
<li>If the instance is there, note your A2 and do the following.
47+
<ul>
48+
<li>Run <apiname>euca_describe-az verbose</apiname>. </li>
49+
<li>Note the CC IP</li>
50+
<li>Go to the CC log and grep Instance ID.</li>
51+
</ul>
52+
</li>
53+
<li>If the instance is not there, start over and run a new instance, recreate failure, and
54+
start these steps over.</li>
55+
</ul>
56+
</info>
57+
58+
</step>
59+
</steps-unordered>
60+
</taskbody>
61+
</task>

‎content/en_us/admin-guide/restore_postgres.dita

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3+
<task id="restore_postgres">
4+
<title>Restore the Database</title>
5+
<shortdesc>To restore the cloud database follow the steps listed in this topic.</shortdesc>
6+
<taskbody>
7+
<context>
8+
9+
</context>
10+
<steps>
11+
<step>
12+
<cmd>Stop the CLC service.</cmd>
13+
<info>
14+
<codeblock>/etc/init.d/eucalyptus-cloud stop</codeblock>
15+
</info>
16+
</step>
17+
<step>
18+
<cmd>Remove traces of the old database.</cmd>
19+
<info>
20+
<codeblock>rm -rf /var/lib/eucalyptus/db</codeblock>
21+
</info>
22+
</step>
23+
<step>
24+
<cmd>Re-initialize the database structure.</cmd>
25+
<info>
26+
<codeblock>euca_conf --initialize</codeblock>
27+
</info>
28+
</step>
29+
<step>
30+
<cmd>Start the database manually.</cmd>
31+
<info>
32+
<codeblock>su eucalyptus -c "/usr/pgsql-9.1/bin/pg_ctl start -w \
33+
-s -D/var/lib/eucalyptus/db/data -o '-h0.0.0.0/0 -p8777 -i'"</codeblock>
34+
</info>
35+
</step>
36+
<step>
37+
<cmd>Restore the backup.</cmd>
38+
<info>
39+
<codeblock>psql -U root -d postgres -p 8777 -h /var/lib/eucalyptus/db/data -f ~/eucalyptus_pg_dumpall-backup.sql</codeblock>
40+
</info>
41+
</step>
42+
<step>
43+
<cmd>Restore the keys.</cmd>
44+
<info>
45+
<codeblock>tar -xvf ~/eucalyptus-keysdir.tgz -C /</codeblock>
46+
</info>
47+
</step>
48+
<step>
49+
<cmd>Stop the database manually.</cmd>
50+
<info>
51+
<codeblock>su eucalyptus -c "/usr/pgsql-9.1/bin/pg_ctl stop -D/var/lib/eucalyptus/db/data"</codeblock>
52+
</info>
53+
</step>
54+
<step>
55+
<cmd>Start CLC service</cmd>
56+
<info>
57+
<codeblock>/etc/init.d/eucalyptus-cloud start</codeblock>
58+
</info>
59+
</step>
60+
</steps>
61+
</taskbody>
62+
</task>

0 commit comments

Comments
 (0)