Skip to content
Browse files

Initial draft of the Eucalyptus Console Guide

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

0 comments on commit 43fa5d7

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