Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Initial draft of the Eucalyptus Console Guide

  • Loading branch information...
commit 43fa5d7a9ec307922864f4471779cafe56bba7fe 1 parent 71ebe0c
scottb dharmabumstead authored
1  content/en_us/cg.ditamap
@@ -21,6 +21,7 @@
21 21 </topicref>
22 22
23 23 <topicref href="shared/console_configure_intro.dita">
  24 + <topicref href="shared/console_config_locating_config_file.dita"/>
24 25 <topicref href="shared/console_config_server_address.dita"/>
25 26 <topicref href="shared/console_config_polling_frequency.dita"/>
26 27 <topicref href="shared/console_config_ui_port.dita"/>
10 content/en_us/shared/console_config_admin_email.dita
... ... @@ -1,15 +1,19 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_config_admin_email">
4 4 <title>Setting the Administrator Email</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To set administrator email address displayed in the console: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>email</codeph> entry in the
  13 + <codeph>[server]</codeph> section of the configuration file. For example:</cmd>
  14 + <info>
  15 + <codeblock>email: help@example.com</codeblock>
  16 + </info>
13 17 </step>
14 18 </steps>
15 19 </taskbody>
11 content/en_us/shared/console_config_cloud_admin_portal.dita
... ... @@ -1,15 +1,20 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_configure_cloud_admin_portal">
4 4 <title>Setting the Cloud Administration Portal URL</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To configure the cloud administration portal URL: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>admin.page</codeph> entry in the
  13 + <codeph>[server]</codeph> section of the configuration file. For example:</cmd>
  14 + <info>
  15 + <codeblock>admin.page: https://example.com/admin-portal</codeblock>
  16 + </info>
  17 +
13 18 </step>
14 19 </steps>
15 20 </taskbody>
11 content/en_us/shared/console_config_cookie_generator.dita
... ... @@ -1,15 +1,20 @@
15 content/en_us/shared/console_config_help_page.dita
... ... @@ -1,15 +1,24 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_configure_help_page">
4 4 <title>Setting the Help Page URL</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To configure the help page URL for the console: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>help.page</codeph> entry in the
  13 + <codeph>[server]</codeph> section of the configuration file. For example:</cmd>
  14 + <info>
  15 + <codeblock>help.page: https://example.com/help-me</codeblock>
  16 + </info>
  17 + <info>
  18 + <p>
  19 + This URL will open when the console user selects the <uicontrol>Help</uicontrol> menu item from the console dashboard.
  20 + </p>
  21 + </info>
13 22 </step>
14 23 </steps>
15 24 </taskbody>
25 content/en_us/shared/console_config_instance_types.dita
@@ -5,11 +5,32 @@
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>You can customize the available instance types that are listed in the console for
  9 + your cloud. To do this: </p>
9 10 </context>
10 11 <steps>
11 12 <step>
12   - <cmd>Task step.</cmd>
  13 + <cmd>Modify the <codeph>[instance_type]</codeph> section of the console configuration file. Each instance type has a property for number of CPUs, memory (in megabytes), and disk size (in gigabytes).
  14 + The default configuration file that is installed with the console is pre-populated with common instance types:</cmd>
  15 + <info>
  16 + <codeblock>[instance_type]
  17 +m1.small.cpu: 1
  18 +m1.small.mem: 128
  19 +m1.small.disk: 2
  20 +c1.medium.cpu: 2
  21 +c1.medium.mem: 128
  22 +c1.medium.disk: 5
  23 +m1.large.cpu: 2
  24 +m1.large.mem: 512
  25 +m1.large.disk: 10
  26 +m1.xlarge.cpu: 2
  27 +m1.xlarge.mem: 1024
  28 +m1.xlarge.disk: 10
  29 +c1.xlarge.cpu: 4
  30 +c1.xlarge.mem: 2048
  31 +c1.xlarge.disk: 10</codeblock>
  32 + </info>
  33 +
13 34 </step>
14 35 </steps>
15 36 </taskbody>
10 content/en_us/shared/console_config_locale.dita
... ... @@ -1,15 +1,19 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_configure_locale">
4 4 <title>Setting the Locale</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To set the locale that you want the console to use for localization: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>language</codeph> entry in the
  13 + <codeph>[server]</codeph> section of the configuration file with a Linux-compliant locale name. For example:</cmd>
  14 + <info>
  15 + <codeblock>language: en_US</codeblock>
  16 + </info>
13 17 </step>
14 18 </steps>
15 19 </taskbody>
11 content/en_us/shared/console_config_locating_config_file.dita
... ... @@ -0,0 +1,11 @@
  1 +<?xml version="1.0" encoding="UTF-8"?>
  2 +<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
  3 +<topic id="console_config_locating_config_file">
  4 + <title>Locating the Console Configuration File</title>
  5 + <body>
  6 + <p>The Eucalyptus Console configuration settings are stored in the console.ini file.</p>
  7 + <p>For Centos and RHEL installations from packages, this file is located in <codeph>/etc/eucalyptus-ui/server/console.ini</codeph>.</p>
  8 + <p>For Ubuntu installations from packages, this file is located in <codeph>/opt/euca-ui/server/console.ini</codeph>.</p>
  9 + <p>For installations from source, this file is in <codeph>&lt;your-git-directory&gt;/eucalyptus-ui/console.ini</codeph></p>
  10 + </body>
  11 +</topic>
24 content/en_us/shared/console_config_polling_frequency.dita
... ... @@ -1,15 +1,33 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_configure_polling_frequency">
4 4 <title>Configuring Polling Frequency</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To configure the polling frequency for console updates from the CLC: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>pollfreq</codeph> entry in the <codeph>[server]</codeph> section of the
  13 + configuration file with a polling value in seconds. For example:</cmd>
  14 + <info>
  15 + <codeblock>pollfreq: 20</codeblock>
  16 + </info>
  17 + </step>
  18 + <step>
  19 + <cmd>You can optionally override the main polling frequency value specified in <codeph>pollfreq</codeph> by adding an entry in the form <codeph>pollfreq.&gt;resouce_name&lt;</codeph>.
  20 + Valid resource name values are: <codeph>images</codeph>, <codeph>instances</codeph>, <codeph>keypairs</codeph>, <codeph>groups</codeph>,
  21 + <codeph>addresses</codeph>, <codeph>volumes</codeph>, and <codeph>snapshots</codeph>. For example: </cmd>
  22 + <info>
  23 + <codeblock>pollfreq.images: 60
  24 +pollfreq.snapshots: 10
  25 +pollfreq.instances: 5
  26 +pollfreq.groups: 20
  27 +pollfreq.addresses: 30
  28 +pollfreq.volumes: 30
  29 +pollfreq.keypairs: 60</codeblock>
  30 + </info>
13 31 </step>
14 32 </steps>
15 33 </taskbody>
10 content/en_us/shared/console_config_server_address.dita
... ... @@ -1,15 +1,19 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_configure_server_address">
4 4 <title>Setting the Front End Address</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To set the IP address or DNS name of your cloud front end: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>clchost</codeph> entry in the <codeph>[server]</codeph> section of the
  13 + configuration file. For example:</cmd>
  14 + <info>
  15 + <codeblock>clchost: 127.0.0.1</codeblock>
  16 + </info>
13 17 </step>
14 18 </steps>
15 19 </taskbody>
23 content/en_us/shared/console_config_ssl_certs.dita
... ... @@ -1,15 +1,30 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
4   - <title>Configure SSL Certification Paths</title>
  3 +<task id="console_configure_ssl_certs">
  4 + <title>Configuring SSL Certification Paths</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To optionally specify an SSL certificate to run your console over Secure HTTP: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>sslcert</codeph> and <codeph>sslkey</codeph> entries in the
  13 + <codeph>[server]</codeph> section of the configuration file with paths to your SSL certificate and key files. For
  14 + example:</cmd>
  15 + <info>
  16 + <codeblock>sslcert: /example/path/server.crt
  17 +sslkey: /example/path/server.key</codeblock>
  18 + </info>
  19 + <info>
  20 + <note>
  21 + <p> For more information on generating self-signed SSL certificates, go to
  22 + <xref
  23 + href="http://www.akadia.com/services/ssh_test_certificate.html"
  24 + >http://www.akadia.com/services/ssh_test_certificate.html</xref>.
  25 + </p>
  26 + </note>
  27 + </info>
13 28 </step>
14 29 </steps>
15 30 </taskbody>
10 content/en_us/shared/console_config_ui_port.dita
... ... @@ -1,15 +1,19 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_u2c_3t1_vh">
  3 +<task id="console_configure_ui_port">
4 4 <title>Configuring the UI Port</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To set the port that the console will listen on: </p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Modify the <codeph>uiport</codeph> entry in the <codeph>[server]</codeph> section of the
  13 + configuration file. For example:</cmd>
  14 + <info>
  15 + <codeblock>uiport: 8888</codeblock>
  16 + </info>
13 17 </step>
14 18 </steps>
15 19 </taskbody>
2  content/en_us/shared/console_configure_intro.dita
@@ -5,6 +5,6 @@
5 5 <title>Configuring the Eucalyptus Console</title>
6 6 <shortdesc>This section covers how to configure the Eucalyptus Console.</shortdesc>
7 7 <conbody>
8   - <p></p>
  8 +
9 9 </conbody>
10 10 </concept>
38 content/en_us/shared/console_install_centos_rhel5.dita
... ... @@ -1,16 +1,48 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_hfy_ms1_vh">
  3 +<task id="console_install_console_centos_rhel5_package">
4 4 <title>Install on Centos / RHEL 5.8</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To install the Eucalyptus Console from packages on Centos and RHEL 5.8:</p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Configure the EPEL repository by editing the file <codeph>/etc/yum.repos.d/epel.repo</codeph>:</cmd>
  13 + <info>
  14 + <codeblock>[epel]
  15 +name=Extra Packages for Enterprise Linux - $basearch
  16 +baseurl=http://mirror.eucalyptus/epel/$releasever/$basearch
  17 +enabled=1
  18 +gpgcheck=0</codeblock>
  19 + </info>
  20 + </step>
  21 + <step>
  22 + <cmd>
  23 + Create a new file mamed <codeph>/etc/yum.repos.d/eucalyptus-ui.repo</codeph> and add the following content:
  24 + </cmd>
  25 + <info>
  26 + <codeblock>[eucalyptus-ui]
  27 +name = Eucalyptus UI
  28 +mirrorlist = http://packages.release.eucalyptus-systems.com/api/1/genrepo/?distro=centos&amp;releasever=5&amp;arch=x86_64&amp;url=git://github.com/eucalyptus/eucalyptus-ui.git&amp;ref=master
  29 +enabled = 1
  30 +gpgcheck = 0</codeblock>
  31 + </info>
  32 + </step>
  33 + <step>
  34 + <cmd>Install the package using yum:</cmd>
  35 + <info>
  36 + <codeblock>yum install python26 python26-eucalyptus-ui</codeblock>
  37 + </info>
13 38 </step>
14 39 </steps>
  40 + <result>
  41 + Your installation is now complete.
  42 + </result>
  43 + <postreq>
  44 + You are now ready to <xref href="console_configure_intro.dita">configure
  45 + the Eucalyptus Console</xref>.
  46 + </postreq>
15 47 </taskbody>
16 48 </task>
44 content/en_us/shared/console_install_centos_rhel6.dita
... ... @@ -1,16 +1,54 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_hfy_ms1_vh">
  3 +<task id="console_install_console_centos_rhel6_package">
4 4 <title>Install on Centos / RHEL 6.3</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To install the Eucalyptus Console from packages on Centos and RHEL 6.3:</p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Configure the EPEL repository by editing the file <codeph>/etc/yum.repos.d/epel.repo</codeph>:</cmd>
  13 + <info>
  14 + <codeblock>[epel]
  15 +name=Extra Packages for Enterprise Linux - $basearch
  16 +baseurl=http://mirror.eucalyptus/epel/$releasever/$basearch
  17 +enabled=1
  18 +gpgcheck=0</codeblock>
  19 + </info>
  20 + </step>
  21 + <step>
  22 + <cmd>
  23 + Create a new file mamed <codeph>/etc/yum.repos.d/eucalyptus-ui.repo</codeph> and add the following content:
  24 + </cmd>
  25 + <info>
  26 + <codeblock>[eucalyptus-ui]
  27 +name = Eucalyptus UI
  28 +mirrorlist = http://packages.release.eucalyptus-systems.com/api/1/genrepo/?distro=centos&amp;releasever=6&amp;arch=x86_64&amp;url=git://github.com/eucalyptus/eucalyptus-ui.git&amp;ref=master
  29 +enabled = 1
  30 +gpgcheck = 0</codeblock>
  31 + </info>
  32 + </step>
  33 + <step>
  34 + <cmd>Install dependencies:</cmd>
  35 + <info>
  36 + <codeblock>yum install python-boto python-tornado</codeblock>
  37 + </info>
  38 + </step>
  39 + <step>
  40 + <cmd>Install the package using yum:</cmd>
  41 + <info>
  42 + <codeblock>yum install python-eucalyptus-ui</codeblock>
  43 + </info>
13 44 </step>
14 45 </steps>
  46 + <result>
  47 + Your installation is now complete.
  48 + </result>
  49 + <postreq>
  50 + You are now ready to <xref href="console_configure_intro.dita">configure
  51 + the Eucalyptus Console</xref>.
  52 + </postreq>
15 53 </taskbody>
16 54 </task>
28 content/en_us/shared/console_install_ubuntu.dita
... ... @@ -1,16 +1,38 @@
1 1 <?xml version="1.0" encoding="UTF-8"?>
2 2 <!DOCTYPE task PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd">
3   -<task id="task_hfy_ms1_vh">
  3 +<task id="console_install_console_ubuntu_package">
4 4 <title>Install on Ubuntu Lucid and Precise</title>
5 5 <shortdesc/>
6 6 <taskbody>
7 7 <context>
8   - <p>Context for the current task</p>
  8 + <p>To install the Eucalyptus Console from packages on Ubuntu Lucid or Precise:</p>
9 9 </context>
10 10 <steps>
11 11 <step>
12   - <cmd>Task step.</cmd>
  12 + <cmd>Add the following line to the /etc/apt/sources.list, replacing the word "release" with either "lucid" or "precise":</cmd>
  13 + <info>
  14 + <codeblock>deb http://packages.release.eucalyptus-systems.com/ubuntu release main </codeblock>
  15 + </info>
  16 + </step>
  17 + <step>
  18 + <cmd>Update the package cache:</cmd>
  19 + <info>
  20 + <codeblock>sudo apt-get update</codeblock>
  21 + </info>
  22 + </step>
  23 + <step>
  24 + <cmd>Install the Eucalyptus Console:</cmd>
  25 + <info>
  26 + <codeblock>sudo apt-get install eucalyptus-ui</codeblock>
  27 + </info>
13 28 </step>
14 29 </steps>
  30 + <result>
  31 + Your installation is now complete.
  32 + </result>
  33 + <postreq>
  34 + You are now ready to <xref href="console_configure_intro.dita">configure
  35 + the Eucalyptus Console</xref>.
  36 + </postreq>
15 37 </taskbody>
16 38 </task>

0 comments on commit 43fa5d7

Please sign in to comment.
Something went wrong with that request. Please try again.