Docs. Fix CLOUDSTACK-405. Put missing steps back into management server installation. Running cloud-setup-management was missing. Also some copy edits.
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/1e0b8e43 Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/1e0b8e43 Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/1e0b8e43 Branch: refs/heads/marvin-parallel Commit: 1e0b8e43ba2c076b6256b714d8bfcec34ae5694a Parents: b1c72c1 Author: Jessica Tomechak <[email protected]> Authored: Tue Oct 23 16:20:57 2012 -0700 Committer: Jessica Tomechak <[email protected]> Committed: Tue Oct 23 16:20:57 2012 -0700 ---------------------------------------------------------------------- .../management-server-install-db-external.xml | 53 +++++++-------- docs/en-US/management-server-install-db-local.xml | 31 ++++++--- docs/en-US/management-server-install-db.xml | 10 ++-- 3 files changed, 53 insertions(+), 41 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/1e0b8e43/docs/en-US/management-server-install-db-external.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/management-server-install-db-external.xml b/docs/en-US/management-server-install-db-external.xml index e77380f..a749dc7 100644 --- a/docs/en-US/management-server-install-db-external.xml +++ b/docs/en-US/management-server-install-db-external.xml @@ -49,55 +49,54 @@ line. The max_connections parameter should be set to 350 multiplied by the number of Management Servers you are deploying. This example assumes two Management Servers.</para> <note> - <para>On Ubuntu you can also create a file /etc/mysql/conf.d/cloudstack.cnf and add these directives there. Don't forget to add [mysqld] on the first line of the file.</para> + <para>On Ubuntu, you can also create a file /etc/mysql/conf.d/cloudstack.cnf and add + these directives there. Don't forget to add [mysqld] on the first line of the + file.</para> </note> - <programlisting> -innodb_rollback_on_timeout=1 + <programlisting language="Bash">innodb_rollback_on_timeout=1 innodb_lock_wait_timeout=600 max_connections=700 log-bin=mysql-bin binlog-format = 'ROW' -bind-address = 0.0.0.0 - </programlisting> +bind-address = 0.0.0.0 </programlisting> </listitem> <listitem> - <para>On RHEL/CentOS MySQL doesn't start after installation, start it manually.</para> + <para>Start or restart MySQL to put the new configuration into effect.</para> + <para>On RHEL/CentOS, + MySQL doesn't automatically start after installation. Start it manually.</para> <programlisting language="Bash">service mysqld start</programlisting> + <para>On Ubuntu, restart MySQL.</para> + <programlisting language="Bash">service mysqld restart</programlisting> </listitem> <listitem> + <para>(CentOS and RHEL only; not required on Ubuntu)</para> <warning> - <para>On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution. Run the following commands, and substitute your own desired root password. This step is not required on Ubuntu as it asks for a root password during installation.</para> + <para>On RHEL and CentOS, MySQL does not set a root password by default. It is very + strongly recommended that you set a root password as a security precaution. </para> </warning> - <para>Run this command to secure your installation. You can answer "Y" to all questions except to "Disallow root login remotely?". This is required to set up the databases.</para> - <programlisting>mysql_secure_installation</programlisting> + <para>Run the following command to secure your installation. You can answer "Y" to all + questions except "Disallow root login remotely?". Remote root login is required to + set up the databases.</para> + <programlisting language="Bash">mysql_secure_installation</programlisting> </listitem> <listitem><para>If a firewall is present on the system, open TCP port 3306 so external MySQL connections can be established.</para> + <para>On Ubuntu, UFW is the default firewall. Open the port with this command:</para> + <programlisting language="Bash">ufw allow mysql</programlisting> + <para>On RHEL/CentOS:</para> <orderedlist numeration="loweralpha"> <listitem> - <para>On RHEL/CentOS:</para> - <orderedlist> - <listitem> - <para>Edit the /etc/sysconfig/iptables file and add the following line at the beginning of the INPUT chain.</para> - <programlisting>-A INPUT -p tcp --dport 3306 -j ACCEPT</programlisting> - </listitem> - <listitem> - <para>Now reload the iptables rules.</para> - <programlisting language="Bash">service iptables restart</programlisting> - </listitem> - </orderedlist> + <para>Edit the /etc/sysconfig/iptables file and add the following line at the beginning of the INPUT chain.</para> + <programlisting language="Bash">-A INPUT -p tcp --dport 3306 -j ACCEPT</programlisting> </listitem> <listitem> - <para>On Ubuntu:</para> - <para>UFW is the default firewall on Ubuntu, open the port with this command:</para> - <programlisting language="Bash">ufw allow mysql</programlisting> + <para>Now reload the iptables rules.</para> + <programlisting language="Bash">service iptables restart</programlisting> </listitem> - </orderedlist> + </orderedlist> </listitem> + <listitem><para>Return to the root shell on your first Management Server.</para></listitem> <listitem> <para>Set up the database. The following command creates the cloud user on the database.</para> - <note> - <para>This command should be run on the first Management server node!</para> - </note> <itemizedlist> <listitem><para>In dbpassword, specify the password to be assigned to the cloud user. You can choose to provide no password.</para></listitem> <listitem><para>In deploy-as, specify the username and password of the user deploying the database. In the following command, it is assumed the root user is deploying the database and creating the cloud user.</para></listitem> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/1e0b8e43/docs/en-US/management-server-install-db-local.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/management-server-install-db-local.xml b/docs/en-US/management-server-install-db-local.xml index ae8cfd1..9880c54 100644 --- a/docs/en-US/management-server-install-db-local.xml +++ b/docs/en-US/management-server-install-db-local.xml @@ -36,26 +36,31 @@ <listitem> <para>Edit the MySQL configuration (/etc/my.cnf or /etc/mysql/my.cnf, depending on your OS) and insert the following lines in the [mysqld] section. You can put these lines below the datadir line. The max_connections parameter should be set to 350 multiplied by the number of Management Servers you are deploying. This example assumes one Management Server.</para> <note> - <para>On Ubuntu you can also create a file /etc/mysql/conf.d/cloudstack.cnf and add these directives there. Don't forget to add [mysqld] on the first line of the file.</para> + <para>On Ubuntu, you can also create a file /etc/mysql/conf.d/cloudstack.cnf and add these directives there. Don't forget to add [mysqld] on the first line of the file.</para> </note> - <programlisting> -innodb_rollback_on_timeout=1 + <programlisting language="Bash">innodb_rollback_on_timeout=1 innodb_lock_wait_timeout=600 max_connections=350 log-bin=mysql-bin -binlog-format = 'ROW' - </programlisting> +binlog-format = 'ROW'</programlisting> </listitem> <listitem> - <para>On RHEL/CentOS MySQL doesn't start after installation, start it manually.</para> + <para>Start or restart MySQL to put the new configuration into effect.</para> + <para>On RHEL/CentOS, + MySQL doesn't automatically start after installation. Start it manually.</para> <programlisting language="Bash">service mysqld start</programlisting> + <para>On Ubuntu, restart MySQL.</para> + <programlisting language="Bash">service mysqld restart</programlisting> </listitem> <listitem> + <para>(CentOS and RHEL only; not required on Ubuntu)</para> <warning> - <para>On RHEL and CentOS, MySQL does not set a root password by default. It is very strongly recommended that you set a root password as a security precaution. Run the following commands, and substitute your own desired root password. This step is not required on Ubuntu as it asks for a root password during installation.</para> + <para>On RHEL and CentOS, MySQL does not set a root password by default. It is very + strongly recommended that you set a root password as a security precaution. </para> </warning> - <para>Run this command to secure your installation. Since we are running MySQL locally you can answer "Y" to all questions.</para> - <programlisting>mysql_secure_installation</programlisting> + <para>Run the following command to secure your installation. You can answer "Y" to all + questions.</para> + <programlisting language="Bash">mysql_secure_installation</programlisting> </listitem> <listitem><para>Set up the database. The following command creates the "cloud" user on the database.</para> <itemizedlist> @@ -72,5 +77,13 @@ binlog-format = 'ROW' -k <database_key></programlisting> <para>When this script is finished, you should see a message like âSuccessfully initialized the database.â</para> </listitem> + <listitem><para>If you are running the KVM hypervisor on the same machine with the Management Server, edit /etc/sudoers and add the following line:</para> + <programlisting language="Bash">Defaults:cloud !requiretty</programlisting> + <note><para>This type of single-machine setup is recommended only for a trial installation.</para></note> + </listitem> + <listitem><para>Now that the database is set up, you can finish configuring the OS for the Management Server. This command will set up iptables, sudoers, and start the Management Server.</para> + <programlisting language="Bash"># cloud-setup-management</programlisting> + <para>You should see the message â&PRODUCT; Management Server setup is done.â</para> + </listitem> </orderedlist> </section> http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/1e0b8e43/docs/en-US/management-server-install-db.xml ---------------------------------------------------------------------- diff --git a/docs/en-US/management-server-install-db.xml b/docs/en-US/management-server-install-db.xml index 24e638a..9d41af2 100644 --- a/docs/en-US/management-server-install-db.xml +++ b/docs/en-US/management-server-install-db.xml @@ -24,11 +24,11 @@ <section id="management-server-install-db"> <title>Install the database server</title> - <para>The &PRODUCT; management server uses a MySQL database server to store it's data. - When you are installing the management server on a single node you can install the MySQL server locally. - When using a multi-node installation the MySQL database has to run on an external node. + <para>The &PRODUCT; management server uses a MySQL database server to store its data. + When you are installing the management server on a single node, you can install the MySQL server locally. + For an installation that has multiple management server nodes, we assume the MySQL database also runs on a separate node. </para> - <para>&PRODUCT; has been tested with MySQL 5.1 and 5.5, both should work fine. These versions are included in RHEL/CentOS and Ubuntu.</para> + <para>&PRODUCT; has been tested with MySQL 5.1 and 5.5. These versions are included in RHEL/CentOS and Ubuntu.</para> <xi:include href="management-server-install-db-local.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> <xi:include href="management-server-install-db-external.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</section> \ No newline at end of file +</section>
