Return-Path: X-Original-To: apmail-cloudstack-commits-archive@www.apache.org Delivered-To: apmail-cloudstack-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 1010D10FFE for ; Fri, 14 Feb 2014 10:14:38 +0000 (UTC) Received: (qmail 62049 invoked by uid 500); 14 Feb 2014 10:14:37 -0000 Delivered-To: apmail-cloudstack-commits-archive@cloudstack.apache.org Received: (qmail 62014 invoked by uid 500); 14 Feb 2014 10:14:35 -0000 Mailing-List: contact commits-help@cloudstack.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 61787 invoked by uid 99); 14 Feb 2014 10:14:32 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 14 Feb 2014 10:14:32 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 6AC229265BE; Fri, 14 Feb 2014 10:14:31 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Fri, 14 Feb 2014 10:14:31 -0000 Message-Id: <5ef1afe4b56d4258a3b48dbac73ffd7d@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [1/2] fix list of images and sourcecode directives Updated Branches: refs/heads/master 3d2a4e997 -> 7f2027bb3 http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/7f2027bb/source/installation.rst ---------------------------------------------------------------------- diff --git a/source/installation.rst b/source/installation.rst index b3dd5ed..482c0aa 100644 --- a/source/installation.rst +++ b/source/installation.rst @@ -179,7 +179,9 @@ requirements: At least 1 NIC -.. note:: If DHCP is used for hosts, ensure that no conflict occurs between DHCP server used for these hosts and the DHCP router created by CloudStack. +.. note:: + + If DHCP is used for hosts, ensure that no conflict occurs between DHCP server used for these hosts and the DHCP router created by CloudStack. - @@ -199,7 +201,9 @@ Hosts have additional requirements depending on the hypervisor. See the requirements listed at the top of the Installation section for your chosen hypervisor: -.. warning:: Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation. +.. warning:: + + Be sure you fulfill the additional hypervisor requirements and installation steps provided in this Guide. Hypervisor hosts must be properly prepared to work with CloudStack. For example, the requirements for XenServer are listed under Citrix XenServer Installation. Configure package repository ---------------------------- @@ -216,7 +220,9 @@ packages” <#sect-source-builddebs>`__ you may find pre-built DEB and RPM packages for your convenience linked from the `downloads `__ page. -.. note:: These repositories contain both the Management Server and KVM Hypervisor packages. +.. note:: + + These repositories contain both the Management Server and KVM Hypervisor packages. DEB package repository ~~~~~~~~~~~~~~~~~~~~~~ @@ -229,19 +235,19 @@ Use your preferred editor and open (or create) ``/etc/apt/sources.list.d/cloudstack.list``. Add the community provided repository to the file: -:: +.. sourcecode:: bash deb http://cloudstack.apt-get.eu/ubuntu precise 4.2 We now have to add the public key to the trusted keys. -:: +.. sourcecode:: bash $ wget -O - http://cloudstack.apt-get.eu/release.asc|apt-key add - Now update your local apt cache. -:: +.. sourcecode:: bash $ apt-get update @@ -264,7 +270,7 @@ To add the CloudStack repository, create ``/etc/yum.repos.d/cloudstack.repo`` and insert the following information. -:: +.. sourcecode:: bash [cloudstack] name=cloudstack @@ -296,7 +302,9 @@ Server nodes will be in your cloud: In either case, each machine must meet the system requirements described in System Requirements. -.. warning:: For the sake of security, be sure the public Internet can not access port 8096 or port 8250 on the Management Server. +.. warning:: + + For the sake of security, be sure the public Internet can not access port 8096 or port 8250 on the Management Server. The procedure for installing the Management Server is: @@ -343,7 +351,7 @@ node. Check for a fully qualified hostname. - :: + .. sourcecode:: bash hostname --fqdn @@ -355,7 +363,7 @@ node. Make sure that the machine can reach the Internet. - :: + .. sourcecode:: bash ping www.cloudstack.org @@ -363,15 +371,17 @@ node. Turn on NTP for time synchronization. - .. note:: NTP is required to synchronize the clocks of the servers in your cloud. + .. note:: + + NTP is required to synchronize the clocks of the servers in your cloud. Install NTP. - :: + .. sourcecode:: bash yum install ntp - :: + .. sourcecode:: bash apt-get install openntpd @@ -387,7 +397,9 @@ The first step in installation, whether you are installing the Management Server on one host or many, is to install the software on a single node. -.. note:: If you are planning to install the Management Server on multiple nodes for high availability, do not proceed to the additional nodes yet. That step will come later. +.. note:: + + If you are planning to install the Management Server on multiple nodes for high availability, do not proceed to the additional nodes yet. That step will come later. The CloudStack Management server can be installed using either RPM or DEB packages. These packages will depend on everything you need to run @@ -398,14 +410,14 @@ Install on CentOS/RHEL We start by installing the required packages: -:: +.. sourcecode:: bash yum install cloudstack-management Install on Ubuntu ^^^^^^^^^^^^^^^^^ -:: +.. sourcecode:: bash apt-get install cloudstack-management @@ -448,11 +460,11 @@ Node” <#management-server-install-db-external>`__. Install MySQL from the package repository of your distribution: - :: + :.. sourcecode:: bash yum install mysql-server - :: + .. sourcecode:: bash apt-get install mysql-server @@ -472,7 +484,7 @@ Node” <#management-server-install-db-external>`__. .. note:: 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. - :: + .. sourcecode:: bash innodb_rollback_on_timeout=1 innodb_lock_wait_timeout=600 @@ -487,13 +499,13 @@ Node” <#management-server-install-db-external>`__. On RHEL/CentOS, MySQL doesn't automatically start after installation. Start it manually. - :: + .. sourcecode:: bash service mysqld start On Ubuntu, restart MySQL. - :: + .. sourcecode:: bash service mysql restart @@ -501,11 +513,13 @@ Node” <#management-server-install-db-external>`__. (CentOS and RHEL only; not required on Ubuntu) - .. warning:: 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. + .. warning:: + + 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 command to secure your installation. You can answer "Y" to all questions. - :: + .. sourcecode:: bash mysql_secure_installation @@ -525,7 +539,7 @@ Node” <#management-server-install-db-external>`__. In RHEL or CentOS, SELinux is installed and enabled by default. You can verify this with: - :: + .. sourcecode:: bash $ rpm -qa | grep selinux @@ -537,19 +551,19 @@ Node” <#management-server-install-db-external>`__. In RHEL or CentOS: - :: + .. sourcecode:: bash vi /etc/selinux/config Change the following line - :: + .. sourcecode:: bash SELINUX=enforcing to this: - :: + .. sourcecode:: bash SELINUX=permissive @@ -558,7 +572,7 @@ Node” <#management-server-install-db-external>`__. Set SELinux to permissive starting immediately, without requiring a system reboot. - :: + .. sourcecode:: bash $ setenforce permissive @@ -610,7 +624,7 @@ Node” <#management-server-install-db-external>`__. cluster management server node IP. If not specified, the local IP address will be used. - :: + .. sourcecode:: bash cloudstack-setup-databases cloud:@localhost \ --deploy-as=root: \ @@ -622,14 +636,16 @@ Node” <#management-server-install-db-external>`__. When this script is finished, you should see a message like “Successfully initialized the database.” - .. note:: If the script is unable to connect to the MySQL database, check the "localhost" loopback address in ``/etc/hosts``. It should be pointing to the IPv4 loopback address "127.0.0.1" and not the IPv6 loopback address ::1. Alternatively, reconfigure MySQL to bind to the IPv6 loopback interface. + .. note:: + + If the script is unable to connect to the MySQL database, check the "localhost" loopback address in ``/etc/hosts``. It should be pointing to the IPv4 loopback address "127.0.0.1" and not the IPv6 loopback address ::1. Alternatively, reconfigure MySQL to bind to the IPv6 loopback interface. #. If you are running the KVM hypervisor on the same machine with the Management Server, edit /etc/sudoers and add the following line: - :: + .. sourcecode:: bash Defaults:cloud !requiretty @@ -639,7 +655,7 @@ Node” <#management-server-install-db-external>`__. for the Management Server. This command will set up iptables, sudoers, and start the Management Server. - :: + .. sourcecode:: bash # cloudstack-setup-management @@ -662,11 +678,11 @@ Management Server Node” <#management-server-install-db-local>`__. Install MySQL from the package repository from your distribution: - :: + .. sourcecode:: bash yum install mysql-server - :: + .. sourcecode:: bash apt-get install mysql-server @@ -679,9 +695,11 @@ Management Server Node” <#management-server-install-db-local>`__. number of Management Servers you are deploying. This example assumes two Management Servers. - .. note:: On Ubuntu, you can also create /etc/mysql/conf.d/cloudstack.cnf file and add these directives there. Don't forget to add [mysqld] on the first line of the file. + .. note:: + + On Ubuntu, you can also create /etc/mysql/conf.d/cloudstack.cnf file and add these directives there. Don't forget to add [mysqld] on the first line of the file. - :: + .. sourcecode:: bash innodb_rollback_on_timeout=1 innodb_lock_wait_timeout=600 @@ -697,13 +715,13 @@ Management Server Node” <#management-server-install-db-local>`__. On RHEL/CentOS, MySQL doesn't automatically start after installation. Start it manually. - :: + .. sourcecode:: bash service mysqld start On Ubuntu, restart MySQL. - :: + .. sourcecode:: bash service mysql restart @@ -711,9 +729,11 @@ Management Server Node” <#management-server-install-db-local>`__. (CentOS and RHEL only; not required on Ubuntu) - .. warning:: 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 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. + .. warning:: + + 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 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. - :: + .. sourcecode:: bash mysql_secure_installation @@ -725,7 +745,7 @@ Management Server Node” <#management-server-install-db-local>`__. On Ubuntu, UFW is the default firewall. Open the port with this command: - :: + .. sourcecode:: bash ufw allow mysql @@ -736,7 +756,7 @@ Management Server Node” <#management-server-install-db-local>`__. Edit the /etc/sysconfig/iptables file and add the following line at the beginning of the INPUT chain. - :: + .. sourcecode:: bash -A INPUT -p tcp --dport 3306 -j ACCEPT @@ -744,7 +764,7 @@ Management Server Node” <#management-server-install-db-local>`__. Now reload the iptables rules. - :: + .. sourcecode:: bash service iptables restart @@ -798,7 +818,7 @@ Management Server Node” <#management-server-install-db-local>`__. cluster management server node IP. If not specified, the local IP address will be used. - :: + .. sourcecode:: bash cloudstack-setup-databases cloud:@ \ --deploy-as=root: \ @@ -908,7 +928,7 @@ Modify the following list properties available in ``client/tomcatconf/componentContext.xml.in`` as applicable, to the desired order: -:: +.. sourcecode:: xml @@ -944,8 +964,9 @@ Cloud Infrastructure Overview). Both of these can be NFS shares. This section tells how to set up the NFS shares before adding the storage to CloudStack. -.. note:: NFS is not the only option for primary or secondary storage. For example, you may use Ceph RBD, GlusterFS, iSCSI, and others. The choice of storage system will depend on the choice of hypervisor and whether -you are dealing with primary or secondary storage. +.. note:: + + NFS is not the only option for primary or secondary storage. For example, you may use Ceph RBD, GlusterFS, iSCSI, and others. The choice of storage system will depend on the choice of hypervisor and whether you are dealing with primary or secondary storage. The requirements for primary and secondary storage are described in: @@ -976,8 +997,9 @@ from the Management Server. The exact commands for the following steps may vary depending on your operating system version. -.. warning:: (KVM only) Ensure that no volume is already mounted at your NFS mount -point. +.. warning:: + + (KVM only) Ensure that no volume is already mounted at your NFS mount point. #. @@ -985,7 +1007,7 @@ point. if you are using NFS for primary storage as well, create a second NFS share. For example: - :: + .. sourcecode:: bash # mkdir -p /export/primary # mkdir -p /export/secondary @@ -996,13 +1018,13 @@ point. Export the NFS share(s) with rw,async,no\_root\_squash,no\_subtree\_check. For example: - :: + .. sourcecode:: bash # vi /etc/exports Insert the following line. - :: + .. sourcecode:: bash /export *(rw,async,no_root_squash,no_subtree_check) @@ -1010,7 +1032,7 @@ point. Export the /export directory. - :: + .. sourcecode:: bash # exportfs -a @@ -1019,7 +1041,7 @@ point. On the management server, create a mount point for secondary storage. For example: - :: + .. sourcecode:: bash # mkdir -p /mnt/secondary @@ -1028,7 +1050,7 @@ point. Mount the secondary storage on your Management Server. Replace the example NFS server name and NFS share paths below with your own. - :: + .. sourcecode:: bash # mount -t nfs nfsservername:/nfs/share/secondary /mnt/secondary @@ -1048,7 +1070,7 @@ operating system version. On RHEL/CentOS systems, you'll need to install the nfs-utils package: - :: + .. sourcecode:: bash $ sudo yum install nfs-utils @@ -1057,7 +1079,7 @@ operating system version. On the Management Server host, create two directories that you will use for primary and secondary storage. For example: - :: + .. sourcecode:: bash # mkdir -p /export/primary # mkdir -p /export/secondary @@ -1068,13 +1090,13 @@ operating system version. Export the NFS share(s) with rw,async,no\_root\_squash,no\_subtree\_check. For example: - :: + .. sourcecode:: bash # vi /etc/exports Insert the following line. - :: + .. sourcecode:: bash /export *(rw,async,no_root_squash,no_subtree_check) @@ -1082,7 +1104,7 @@ operating system version. Export the /export directory. - :: + .. sourcecode:: bash # exportfs -a @@ -1090,13 +1112,13 @@ operating system version. Edit the /etc/sysconfig/nfs file. - :: + .. sourcecode:: bash # vi /etc/sysconfig/nfs Uncomment the following lines: - :: + .. sourcecode:: bash LOCKD_TCPPORT=32803 LOCKD_UDPPORT=32769 @@ -1109,14 +1131,14 @@ operating system version. Edit the /etc/sysconfig/iptables file. - :: + .. sourcecode:: bash # vi /etc/sysconfig/iptables Add the following lines at the beginning of the INPUT chain, where is the network that you'll be using: - :: + .. sourcecode:: bash -A INPUT -s -m state --state NEW -p udp --dport 111 -j ACCEPT -A INPUT -s -m state --state NEW -p tcp --dport 111 -j ACCEPT @@ -1134,7 +1156,7 @@ operating system version. Run the following commands: - :: + .. sourcecode:: bash # service iptables restart # service iptables save @@ -1145,7 +1167,7 @@ operating system version. domain to /etc/idmapd.conf on both the hypervisor host and Management Server. - :: + .. sourcecode:: bash # vi /etc/idmapd.conf @@ -1153,7 +1175,7 @@ operating system version. idmapd.conf and replace the value in the file with your own domain. In the example below, the domain is company.com. - :: + .. sourcecode:: bash Domain = company.com @@ -1178,7 +1200,7 @@ operating system version. Be sure NFS and rpcbind are running. The commands might be different depending on your OS. For example: - :: + .. sourcecode:: bash # service rpcbind start # service nfs start @@ -1192,7 +1214,7 @@ operating system version. directories. For example, substitute your own management server name: - :: + .. sourcecode:: bash # mkdir /primary # mount -t nfs :/export/primary @@ -1230,7 +1252,7 @@ OS for the Management Server. Ensure that necessary services are started and set to start on boot. - :: + .. sourcecode:: bash # service rpcbind start # service nfs start @@ -1244,7 +1266,7 @@ OS for the Management Server. command, see `Section 4.5.4.2, “Install the Database on a Separate Node” <#management-server-install-db-external>`__.) - :: + .. sourcecode:: bash # cloudstack-setup-databases cloud:dbpassword@dbhost -e encryption_type -m management_server_key -k database_key -i management_server_ip @@ -1252,7 +1274,7 @@ OS for the Management Server. Configure the OS and start the Management Server: - :: + .. sourcecode:: bash # cloudstack-setup-management @@ -1274,7 +1296,9 @@ Prepare the System VM Template Secondary storage must be seeded with a template that is used for CloudStack system VMs. -.. note:: When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. +.. note:: + + When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. #. @@ -1298,7 +1322,7 @@ CloudStack system VMs. For Hyper-V - :: + .. sourcecode:: bash # /usr/share/cloudstack-common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/4.3/systemvm64template-2013-12-23-hyperv.vhd.bz2 -h hyperv -s -F @@ -1306,7 +1330,7 @@ CloudStack system VMs. For XenServer: - :: + .. sourcecode:: bash # /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.vhd.bz2 -h xenserver -s -F @@ -1314,7 +1338,7 @@ CloudStack system VMs. For vSphere: - :: + .. sourcecode:: bash # /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/burbank/burbank-systemvm-08012012.ova -h vmware -s -F @@ -1322,7 +1346,7 @@ CloudStack system VMs. For KVM: - :: + .. sourcecode:: bash # /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.qcow2.bz2 -h kvm -s -F @@ -1330,13 +1354,13 @@ CloudStack system VMs. For LXC: - :: + .. sourcecode:: bash # /usr/lib64/cloud/common/scripts/storage/secondary/cloud-install-sys-tmplt -m /mnt/secondary -u http://download.cloud.com/templates/acton/acton-systemvm-02062012.qcow2.bz2 -h lxc -s -F On Ubuntu, use the following path instead: - :: + .. sourcecode:: bash # /usr/share/cloudstack-common/scripts/storage/secondary/cloud-install-sys-tmplt @@ -1349,7 +1373,7 @@ CloudStack system VMs. When the script has finished, unmount secondary storage and remove the created directory. - :: + .. sourcecode:: bash # umount /mnt/secondary # rmdir /mnt/secondary @@ -1382,72 +1406,4 @@ What should you do next? infrastructure. See Provision Your Cloud Infrastructure. -.. |1000-foot-view.png: Overview of CloudStack| image:: ./_static/images/1000-foot-view.png -.. |basic-deployment.png: Basic two-machine deployment| image:: ./_static/images/basic-deployment.png -.. |infrastructure_overview.png: Nested organization of a zone| image:: ./_static/images/infrastructure-overview.png -.. |region-overview.png: Nested structure of a region.| image:: ./_static/images/region-overview.png -.. |zone-overview.png: Nested structure of a simple zone.| image:: ./_static/images/zone-overview.png -.. |pod-overview.png: Nested structure of a simple pod| image:: ./_static/images/pod-overview.png -.. |cluster-overview.png: Structure of a simple cluster| image:: ./_static/images/cluster-overview.png -.. |installation-complete.png: Finished installs with single Management Server and multiple Management Servers| image:: ./_static/images/installation-complete.png -.. |change-password.png: button to change a user's password| image:: ./_static/images/change-password.png -.. |provisioning-overview.png: Conceptual overview of a basic deployment| image:: ./_static/images/provisioning-overview.png -.. |vsphereclient.png: vSphere client| image:: ./_static/images/vsphere-client.png -.. |addcluster.png: add a cluster| image:: ./_static/images/add-cluster.png -.. |ConsoleButton.png: button to launch a console| image:: ./_static/images/console-icon.png -.. |DeleteButton.png: button to delete dvSwitch| image:: ./_static/images/delete-button.png -.. |vds-name.png: Name of the dvSwitch as specified in the vCenter.| image:: ./_static/images/vds-name.png -.. |traffic-type.png: virtual switch type| image:: ./_static/images/traffic-type.png -.. |dvSwitchConfig.png: Configuring dvSwitch| image:: ./_static/images/dvSwitch-config.png -.. |Small-Scale Deployment| image:: ./_static/images/small-scale-deployment.png -.. |Large-Scale Redundant Setup| image:: ./_static/images/large-scale-redundant-setup.png -.. |Multi-Node Management Server| image:: ./_static/images/multi-node-management-server.png -.. |Example Of A Multi-Site Deployment| image:: ./_static/images/multi-site-deployment.png -.. |Separate Storage Network| image:: ./_static/images/separate-storage-network.png -.. |NIC Bonding And Multipath I/O| image:: ./_static/images/nic-bonding-and-multipath-io.png -.. |Use the GUI to set the configuration variable to true| image:: ./_static/images/ec2-s3-configuration.png -.. |Use the GUI to set the name of a compute service offering to an EC2 instance type API name.| image:: ./_static/images/compute-service-offerings.png -.. |parallel-mode.png: adding a firewall and load balancer in parallel mode.| image:: ./_static/images/parallel-mode.png -.. |guest-traffic-setup.png: Depicts a guest traffic setup| image:: ./_static/images/guest-traffic-setup.png -.. |networksinglepod.png: diagram showing logical view of network in a pod| image:: ./_static/images/network-singlepod.png -.. |networksetupzone.png: Depicts network setup in a single zone| image:: ./_static/images/network-setup-zone.png -.. |addguestnetwork.png: Add Guest network setup in a single zone| image:: ./_static/images/add-guest-network.png -.. |remove-nic.png: button to remove a NIC| image:: ./_static/images/remove-nic.png -.. |set-default-nic.png: button to set a NIC as default one.| image:: ./_static/images/set-default-nic.png -.. |EditButton.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |edit-icon.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |addAccount-icon.png: button to assign an IP range to an account.| image:: ./_static/images/addAccount-icon.png -.. |eip-ns-basiczone.png: Elastic IP in a NetScaler-enabled Basic Zone.| image:: ./_static/images/eip-ns-basiczone.png -.. |add-ip-range.png: adding an IP range to a network.| image:: ./_static/images/add-ip-range.png -.. |httpaccess.png: allows inbound HTTP access from anywhere| image:: ./_static/images/http-access.png -.. |autoscaleateconfig.png: Configuring AutoScale| image:: ./_static/images/autoscale-config.png -.. |EnableDisable.png: button to enable or disable AutoScale.| image:: ./_static/images/enable-disable-autoscale.png -.. |gslb.png: GSLB architecture| image:: ./_static/images/gslb.png -.. |gslb-add.png: adding a gslb rule| image:: ./_static/images/add-gslb.png -.. |ReleaseIPButton.png: button to release an IP| image:: ./_static/images/release-ip-icon.png -.. |EnableNATButton.png: button to enable NAT| image:: ./_static/images/enable-disable.png -.. |egress-firewall-rule.png: adding an egress firewall rule| image:: ./_static/images/egress-firewall-rule.png -.. |AttachDiskButton.png: button to attach a volume| image:: ./_static/images/vpn-icon.png -.. |vpn-icon.png: button to enable VPN| image:: ./_static/images/vpn-icon.png -.. |addvpncustomergateway.png: adding a customer gateway.| image:: ./_static/images/add-vpn-customer-gateway.png -.. |edit.png: button to edit a VPN customer gateway| image:: ./_static/images/edit-icon.png -.. |delete.png: button to remove a VPN customer gateway| image:: ./_static/images/delete-button.png -.. |createvpnconnection.png: creating a VPN connection to the customer gateway.| image:: ./_static/images/create-vpn-connection.png -.. |remove-vpn.png: button to remove a VPN connection| image:: ./_static/images/remove-vpn.png -.. |reset-vpn.png: button to reset a VPN connection| image:: ./_static/images/reset-vpn.png -.. |mutltier.png: a multi-tier setup.| image:: ./_static/images/multi-tier-app.png -.. |add-vpc.png: adding a vpc.| image:: ./_static/images/add-vpc.png -.. |add-tier.png: adding a tier to a vpc.| image:: ./_static/images/add-tier.png -.. |replace-acl-icon.png: button to replace an ACL list| image:: ./_static/images/replace-acl-icon.png -.. |add-new-gateway-vpc.png: adding a private gateway for the VPC.| image:: ./_static/images/add-new-gateway-vpc.png -.. |replace-acl-icon.png: button to replace the default ACL behaviour.| image:: ./_static/images/replace-acl-icon.png -.. |add-vm-vpc.png: adding a VM to a vpc.| image:: ./_static/images/add-vm-vpc.png -.. |addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.| image:: ./_static/images/addvm-tier-sharednw.png -.. |release-ip-icon.png: button to release an IP.| image:: ./_static/images/release-ip-icon.png -.. |enable-disable.png: button to enable Static NAT.| image:: ./_static/images/enable-disable.png -.. |select-vmstatic-nat.png: selecting a tier to apply staticNAT.| image:: ./_static/images/select-vm-staticnat-vpc.png -.. |vpc-lb.png: Configuring internal LB for VPC| image:: ./_static/images/vpc-lb.png -.. |del-tier.png: button to remove a tier| image:: ./_static/images/del-tier.png -.. |remove-vpc.png: button to remove a VPC| image:: ./_static/images/remove-vpc.png -.. |edit-icon.png: button to edit a VPC| image:: ./_static/images/edit-icon.png -.. |restart-vpc.png: button to restart a VPC| image:: ./_static/images/restart-vpc.png +.. |installation-complete.png: Finished installs with single Management Server and multiple Management Servers| image:: ./_static/images/installation-complete.png \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/7f2027bb/source/network_setup.rst ---------------------------------------------------------------------- diff --git a/source/network_setup.rst b/source/network_setup.rst index 35e6d82..2c46513 100644 --- a/source/network_setup.rst +++ b/source/network_setup.rst @@ -103,7 +103,7 @@ The Dell 62xx Series switch supports up to 1024 VLANs. Configure all the VLANs in the database. - .. code:: bash + .. sourcecode:: bash vlan database vlan 200-999 @@ -113,7 +113,7 @@ The Dell 62xx Series switch supports up to 1024 VLANs. Configure Ethernet port 1/g1. - .. code:: bash + .. sourcecode:: bash interface ethernet 1/g1 switchport mode general @@ -146,7 +146,7 @@ GigabitEthernet1/0/1. 1000. Since we only use VLANs up to 999, vtp transparent mode is not strictly required. - .. code:: bash + .. sourcecode:: bash vtp mode transparent vlan 200-999 @@ -156,7 +156,7 @@ GigabitEthernet1/0/1. Configure GigabitEthernet1/0/1. - .. code:: bash + .. sourcecode:: bash interface GigabitEthernet1/0/1 switchport trunk encapsulation dot1q @@ -205,7 +205,7 @@ layer-2 switching. Configure all the VLANs in the database. - .. code:: bash + .. sourcecode:: bash vlan database vlan 300-999 @@ -216,7 +216,7 @@ layer-2 switching. VLAN 201 is used to route untagged private IP addresses for pod 1, and pod 1 is connected to this layer-2 switch. - .. code:: bash + .. sourcecode:: bash interface range ethernet all switchport mode general @@ -246,7 +246,7 @@ layer-2 switching. 1000. Since we only use VLANs up to 999, vtp transparent mode is not strictly required. - .. code:: bash + .. sourcecode:: bash vtp mode transparent vlan 300-999 @@ -256,7 +256,7 @@ layer-2 switching. Configure all ports to dot1q and set 201 as the native VLAN. - .. code:: bash + .. sourcecode:: bash interface range GigabitEthernet 1/0/1-24 switchport trunk encapsulation dot1q @@ -303,7 +303,9 @@ NAT and site-to-site VPN can be used. External Guest Firewall Integration for Juniper SRX (Optional) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. note:: Available only for guests using advanced networking. +.. note:: + + Available only for guests using advanced networking. CloudStack provides for direct management of the Juniper SRX series of firewalls. This enables CloudStack to establish static NAT mappings from @@ -321,7 +323,9 @@ mode.| CloudStack requires the Juniper SRX firewall to be configured as follows: -.. note:: Supported SRX software version is 10.3 or higher. +.. note:: + + Supported SRX software version is 10.3 or higher. #. @@ -380,7 +384,7 @@ CloudStack requires the Juniper SRX firewall to be configured as follows: here is the configuration where the public zone is "untrust" and the private zone is "trust": - .. code:: bash + .. sourcecode:: bash root@cloud-srx# show firewall filter trust { @@ -396,7 +400,7 @@ CloudStack requires the Juniper SRX firewall to be configured as follows: sample configuration output (for public interface ge-0/0/3.0, public security zone untrust, and private security zone trust) is: - .. code:: bash + .. sourcecode:: bash ge-0/0/3 { unit 0 { @@ -632,9 +636,7 @@ Prerequisites Deploy and configure Cisco VNMC. - For more information, see `Installing Cisco Virtual Network - Management - Center `__ + For more information, see `Installing Cisco Virtual Network Management Center `__ and `Configuring Cisco Virtual Network Management Center `__. @@ -965,13 +967,13 @@ the SSH credentials by registering on VNMC. Run the following: - .. code:: bash + .. sourcecode:: bash ASA1000V(config)# reload You are prompted with the following message: - .. code:: bash + .. sourcecode:: bash System config has been modified. Save? [Y]es/[N]o:" @@ -981,7 +983,7 @@ the SSH credentials by registering on VNMC. You will get the following confirmation message: - .. code:: bash + .. sourcecode:: bash "Proceed with reload? [confirm]" @@ -993,7 +995,7 @@ the SSH credentials by registering on VNMC. Register the ASA 1000v appliance with the VNMC: - .. code:: bash + .. sourcecode:: bash ASA1000V(config)# vnmc policy-agent ASA1000V(config-vnmc-policy-agent)# registration host vnmc_ip_address @@ -1332,73 +1334,4 @@ Based on your deployment's needs, choose the appropriate value of guest.vlan.bits. Set it as described in Edit the Global Configuration Settings (Optional) section and restart the Management Server. - -.. |1000-foot-view.png: Overview of CloudStack| image:: ./_static/images/1000-foot-view.png -.. |basic-deployment.png: Basic two-machine deployment| image:: ./_static/images/basic-deployment.png -.. |infrastructure_overview.png: Nested organization of a zone| image:: ./_static/images/infrastructure-overview.png -.. |region-overview.png: Nested structure of a region.| image:: ./_static/images/region-overview.png -.. |zone-overview.png: Nested structure of a simple zone.| image:: ./_static/images/zone-overview.png -.. |pod-overview.png: Nested structure of a simple pod| image:: ./_static/images/pod-overview.png -.. |cluster-overview.png: Structure of a simple cluster| image:: ./_static/images/cluster-overview.png -.. |installation-complete.png: Finished installs with single Management Server and multiple Management Servers| image:: ./_static/images/installation-complete.png -.. |change-password.png: button to change a user's password| image:: ./_static/images/change-password.png -.. |provisioning-overview.png: Conceptual overview of a basic deployment| image:: ./_static/images/provisioning-overview.png -.. |vsphereclient.png: vSphere client| image:: ./_static/images/vsphere-client.png -.. |addcluster.png: add a cluster| image:: ./_static/images/add-cluster.png -.. |ConsoleButton.png: button to launch a console| image:: ./_static/images/console-icon.png -.. |DeleteButton.png: button to delete dvSwitch| image:: ./_static/images/delete-button.png -.. |vds-name.png: Name of the dvSwitch as specified in the vCenter.| image:: ./_static/images/vds-name.png -.. |traffic-type.png: virtual switch type| image:: ./_static/images/traffic-type.png -.. |dvSwitchConfig.png: Configuring dvSwitch| image:: ./_static/images/dvSwitch-config.png -.. |Small-Scale Deployment| image:: ./_static/images/small-scale-deployment.png -.. |Large-Scale Redundant Setup| image:: ./_static/images/large-scale-redundant-setup.png -.. |Multi-Node Management Server| image:: ./_static/images/multi-node-management-server.png -.. |Example Of A Multi-Site Deployment| image:: ./_static/images/multi-site-deployment.png -.. |Separate Storage Network| image:: ./_static/images/separate-storage-network.png -.. |NIC Bonding And Multipath I/O| image:: ./_static/images/nic-bonding-and-multipath-io.png -.. |Use the GUI to set the configuration variable to true| image:: ./_static/images/ec2-s3-configuration.png -.. |Use the GUI to set the name of a compute service offering to an EC2 instance type API name.| image:: ./_static/images/compute-service-offerings.png .. |parallel-mode.png: adding a firewall and load balancer in parallel mode.| image:: ./_static/images/parallel-mode.png -.. |guest-traffic-setup.png: Depicts a guest traffic setup| image:: ./_static/images/guest-traffic-setup.png -.. |networksinglepod.png: diagram showing logical view of network in a pod| image:: ./_static/images/network-singlepod.png -.. |networksetupzone.png: Depicts network setup in a single zone| image:: ./_static/images/network-setup-zone.png -.. |addguestnetwork.png: Add Guest network setup in a single zone| image:: ./_static/images/add-guest-network.png -.. |remove-nic.png: button to remove a NIC| image:: ./_static/images/remove-nic.png -.. |set-default-nic.png: button to set a NIC as default one.| image:: ./_static/images/set-default-nic.png -.. |EditButton.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |edit-icon.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |addAccount-icon.png: button to assign an IP range to an account.| image:: ./_static/images/addAccount-icon.png -.. |eip-ns-basiczone.png: Elastic IP in a NetScaler-enabled Basic Zone.| image:: ./_static/images/eip-ns-basiczone.png -.. |add-ip-range.png: adding an IP range to a network.| image:: ./_static/images/add-ip-range.png -.. |httpaccess.png: allows inbound HTTP access from anywhere| image:: ./_static/images/http-access.png -.. |autoscaleateconfig.png: Configuring AutoScale| image:: ./_static/images/autoscale-config.png -.. |EnableDisable.png: button to enable or disable AutoScale.| image:: ./_static/images/enable-disable-autoscale.png -.. |gslb.png: GSLB architecture| image:: ./_static/images/gslb.png -.. |gslb-add.png: adding a gslb rule| image:: ./_static/images/add-gslb.png -.. |ReleaseIPButton.png: button to release an IP| image:: ./_static/images/release-ip-icon.png -.. |EnableNATButton.png: button to enable NAT| image:: ./_static/images/enable-disable.png -.. |egress-firewall-rule.png: adding an egress firewall rule| image:: ./_static/images/egress-firewall-rule.png -.. |AttachDiskButton.png: button to attach a volume| image:: ./_static/images/vpn-icon.png -.. |vpn-icon.png: button to enable VPN| image:: ./_static/images/vpn-icon.png -.. |addvpncustomergateway.png: adding a customer gateway.| image:: ./_static/images/add-vpn-customer-gateway.png -.. |edit.png: button to edit a VPN customer gateway| image:: ./_static/images/edit-icon.png -.. |delete.png: button to remove a VPN customer gateway| image:: ./_static/images/delete-button.png -.. |createvpnconnection.png: creating a VPN connection to the customer gateway.| image:: ./_static/images/create-vpn-connection.png -.. |remove-vpn.png: button to remove a VPN connection| image:: ./_static/images/remove-vpn.png -.. |reset-vpn.png: button to reset a VPN connection| image:: ./_static/images/reset-vpn.png -.. |mutltier.png: a multi-tier setup.| image:: ./_static/images/multi-tier-app.png -.. |add-vpc.png: adding a vpc.| image:: ./_static/images/add-vpc.png -.. |add-tier.png: adding a tier to a vpc.| image:: ./_static/images/add-tier.png -.. |replace-acl-icon.png: button to replace an ACL list| image:: ./_static/images/replace-acl-icon.png -.. |add-new-gateway-vpc.png: adding a private gateway for the VPC.| image:: ./_static/images/add-new-gateway-vpc.png -.. |replace-acl-icon.png: button to replace the default ACL behaviour.| image:: ./_static/images/replace-acl-icon.png -.. |add-vm-vpc.png: adding a VM to a vpc.| image:: ./_static/images/add-vm-vpc.png -.. |addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.| image:: ./_static/images/addvm-tier-sharednw.png -.. |release-ip-icon.png: button to release an IP.| image:: ./_static/images/release-ip-icon.png -.. |enable-disable.png: button to enable Static NAT.| image:: ./_static/images/enable-disable.png -.. |select-vmstatic-nat.png: selecting a tier to apply staticNAT.| image:: ./_static/images/select-vm-staticnat-vpc.png -.. |vpc-lb.png: Configuring internal LB for VPC| image:: ./_static/images/vpc-lb.png -.. |del-tier.png: button to remove a tier| image:: ./_static/images/del-tier.png -.. |remove-vpc.png: button to remove a VPC| image:: ./_static/images/remove-vpc.png -.. |edit-icon.png: button to edit a VPC| image:: ./_static/images/edit-icon.png -.. |restart-vpc.png: button to restart a VPC| image:: ./_static/images/restart-vpc.png http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/7f2027bb/source/optional_installation.rst ---------------------------------------------------------------------- diff --git a/source/optional_installation.rst b/source/optional_installation.rst index 6d69733..f6555e7 100644 --- a/source/optional_installation.rst +++ b/source/optional_installation.rst @@ -51,7 +51,7 @@ Steps to Install the Usage Server Run ./install.sh (NOT VALID, NEED CORRECTION) - .. code:: bash + .. sourcecode:: bash # ./install.sh @@ -62,7 +62,7 @@ Steps to Install the Usage Server Choose "S" to install the Usage Server. - .. code:: bash + .. sourcecode:: bash > S @@ -70,7 +70,7 @@ Steps to Install the Usage Server Once installed, start the Usage Server with the following command. - .. code:: bash + .. sourcecode:: bash # service cloudstack-usage start @@ -102,7 +102,9 @@ standby node that receives all write operations from the master and applies them to a local, redundant copy of the database. The following steps are a guide to implementing MySQL replication. -.. note:: Creating a replica is not a backup solution. You should develop a backup procedure for the MySQL data that is distinct from replication. +.. note:: + + Creating a replica is not a backup solution. You should develop a backup procedure for the MySQL data that is distinct from replication. #. @@ -113,7 +115,7 @@ steps are a guide to implementing MySQL replication. Edit my.cnf on the master and add the following in the [mysqld] section below datadir. - .. code:: bash + .. sourcecode:: bash log_bin=mysql-bin server_id=1 @@ -127,13 +129,13 @@ steps are a guide to implementing MySQL replication. Restart the MySQL service. On RHEL/CentOS systems, use: - .. code:: bash + .. sourcecode:: bash # service mysqld restart On Debian/Ubuntu systems, use: - .. code:: bash + .. sourcecode:: bash # service mysql restart @@ -143,7 +145,7 @@ steps are a guide to implementing MySQL replication. will use the "cloud-repl" user with the password "password". This assumes that master and slave run on the 172.16.1.0/24 network. - .. code:: bash + .. sourcecode:: bash # mysql -u root mysql> create user 'cloud-repl'@'172.16.1.%' identified by 'password'; @@ -163,7 +165,7 @@ steps are a guide to implementing MySQL replication. Retrieve the current position of the database. - .. code:: bash + .. sourcecode:: bash # mysql -u root mysql> show master status; @@ -186,7 +188,7 @@ steps are a guide to implementing MySQL replication. Complete the master setup. Returning to your first session on the master, release the locks and exit MySQL. - .. code:: bash + .. sourcecode:: bash mysql> unlock tables; @@ -195,7 +197,7 @@ steps are a guide to implementing MySQL replication. Install and configure the slave. On the slave server, run the following commands. - .. code:: bash + .. sourcecode:: bash # yum install mysql-server # chkconfig mysqld on @@ -205,7 +207,7 @@ steps are a guide to implementing MySQL replication. Edit my.cnf and add the following lines in the [mysqld] section below datadir. - .. code:: bash + .. sourcecode:: bash server_id=2 innodb_rollback_on_timeout=1 @@ -215,13 +217,13 @@ steps are a guide to implementing MySQL replication. Restart MySQL. Use "mysqld" on RHEL/CentOS systems: - .. code:: bash + .. sourcecode:: bash # service mysqld restart On Ubuntu/Debian systems use "mysql." - .. code:: bash + .. sourcecode:: bash # service mysql restart @@ -231,7 +233,7 @@ steps are a guide to implementing MySQL replication. Replace the IP address, password, log file, and position with the values you have used in the previous steps. - .. code:: bash + .. sourcecode:: bash mysql> change master to -> master_host='172.16.1.217', @@ -244,7 +246,7 @@ steps are a guide to implementing MySQL replication. Then start replication on the slave. - .. code:: bash + .. sourcecode:: bash mysql> start slave; @@ -289,7 +291,7 @@ administrator. In the event of a database failure you should: Restart the Management Servers: - .. code:: bash + .. sourcecode:: bash # service cloudstack-management start @@ -308,9 +310,13 @@ CloudStack, listening on a different port. The Amazon Web Services (AWS) compatible interface provides the EC2 SOAP and Query APIs as well as the S3 REST API. -.. note:: This service was previously enabled by separate software called CloudBridge. It is now fully integrated with the CloudStack management server. +.. note:: + + This service was previously enabled by separate software called CloudBridge. It is now fully integrated with the CloudStack management server. + +.. warning:: -.. warning:: The compatible interface for the EC2 Query API and the S3 API are Work In Progress. The S3 compatible API offers a way to store data on the management server file system, it is not an implementation of the S3 backend. + The compatible interface for the EC2 Query API and the S3 API are Work In Progress. The S3 compatible API offers a way to store data on the management server file system, it is not an implementation of the S3 backend. Limitations @@ -346,7 +352,9 @@ Supported API Version tools v. 1.3.6230*, which can be downloaded at `http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip `__. -.. note:: Work is underway to support a more recent version of the EC2 API +.. note:: + + Work is underway to support a more recent version of the EC2 API Enabling the EC2 and S3 Compatible Interface ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -366,14 +374,16 @@ prior to using it. the Amazon service offerings. You can do this through the CloudStack UI as described in the Administration Guide. - .. warning:: Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use. + .. warning:: + + Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use. #. If you did not already do so when you set the configuration parameter in step `1 <#set-global-config>`__, restart the Management Server. - :: + .. sourcecode:: bash # service cloudstack-management restart @@ -397,7 +407,7 @@ integration port on which you can make unauthenticated calls. In Global Settings set the port to 8096 and subsequently call the *updateConfiguration* method. The following urls shows you how: -:: +.. sourcecode:: bash http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true @@ -421,7 +431,9 @@ instance type API name.| Modifying the AWS API Port ^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. note:: (Optional) The AWS API listens for requests on port 7080. If you prefer AWS API to listen on another port, you can change it as follows: +.. note:: + + (Optional) The AWS API listens for requests on port 7080. If you prefer AWS API to listen on another port, you can change it as follows: #. @@ -489,7 +501,7 @@ To use the EC2 command-line tools, the user must perform these steps: CloudStack management server and port. In a bash shell do the following. -.. code:: bash +.. sourcecode:: bash $ export EC2_CERT=/path/to/cert.pem $ export EC2_PRIVATE_KEY=/path/to/private_key.pem @@ -507,23 +519,25 @@ command-line parameters to any CloudStack-supported EC2 command: Specifies a connection timeout (in seconds) -.. code:: bash +.. sourcecode:: bash --connection-timeout TIMEOUT Specifies a request timeout (in seconds) -.. code:: bash +.. sourcecode:: bash --request-timeout TIMEOUT Example: -.. code:: bash +.. sourcecode:: bash ec2-run-instances 2 –z us-test1 –n 1-3 --connection-timeout 120 --request-timeout 120 -.. note:: The timeouts optional arguments are not specific to CloudStack. +.. note:: + + The timeouts optional arguments are not specific to CloudStack. Supported AWS API Calls ~~~~~~~~~~~~~~~~~~~~~~~ @@ -730,7 +744,7 @@ own and update the endpoint. Example 1. An EC2 Boto example -.. code:: python +.. sourcecode:: python #!/usr/bin/env python @@ -771,7 +785,7 @@ Second is an S3 example. The S3 interface in CloudStack is obsolete. If you need Example 2. An S3 Boto Example -.. code:: python +.. sourcecode:: python #!/usr/bin/env python http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/7f2027bb/source/storage_setup.rst ---------------------------------------------------------------------- diff --git a/source/storage_setup.rst b/source/storage_setup.rst index 39be232..1b46e25 100644 --- a/source/storage_setup.rst +++ b/source/storage_setup.rst @@ -47,7 +47,9 @@ CloudStack is designed to work with any scalable secondary storage system. The only requirement is the secondary storage system supports the NFS protocol. -.. note:: The storage server should be a machine with a large number of disks. The disks should ideally be managed by a hardware RAID controller. Modern hardware RAID controllers support hot plug functionality independent of the operating system so you can replace faulty disks without impacting the running operating system. +.. note:: + + The storage server should be a machine with a large number of disks. The disks should ideally be managed by a hardware RAID controller. Modern hardware RAID controllers support hot plug functionality independent of the operating system so you can replace faulty disks without impacting the running operating system. Example Configurations ---------------------- @@ -89,7 +91,7 @@ operating system version. After /export directory is created, run the following command to configure it as an NFS export. - .. code:: bash + .. sourcecode:: bash # echo "/export (rw,async,no_root_squash,no_subtree_check)" >> /etc/exports @@ -109,7 +111,7 @@ operating system version. The following is an example with separate CIDRs: - .. code:: bash + .. sourcecode:: bash /export 192.168.1.0/24(rw,async,no_root_squash,no_subtree_check) 10.50.1.0/24(rw,async,no_root_squash,no_subtree_check) @@ -124,7 +126,7 @@ operating system version. Run the following command to enable NFS service. - .. code:: bash + .. sourcecode:: bash # chkconfig nfs on @@ -132,7 +134,7 @@ operating system version. Edit the /etc/sysconfig/nfs file and uncomment the following lines. - .. code:: bash + .. sourcecode:: bash LOCKD_TCPPORT=32803 LOCKD_UDPPORT=32769 @@ -146,7 +148,7 @@ operating system version. Edit the /etc/sysconfig/iptables file and add the following lines at the beginning of the INPUT chain. - .. code:: bash + .. sourcecode:: bash -A INPUT -m state --state NEW -p udp --dport 111 -j ACCEPT -A INPUT -m state --state NEW -p tcp --dport 111 -j ACCEPT @@ -166,7 +168,9 @@ operating system version. An NFS share called /export is now set up. -.. note:: When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. +.. note:: + + When copying and pasting a command, be sure the command has pasted as a single line before executing. Some document viewers may introduce unwanted line breaks in copied text. Linux NFS on iSCSI ~~~~~~~~~~~~~~~~~~ @@ -178,7 +182,7 @@ volume. These steps apply to RHEL/CentOS 5 distributions. Install iscsiadm. - .. code:: bash + .. sourcecode:: bash # yum install iscsi-initiator-utils # service iscsi start @@ -189,28 +193,27 @@ volume. These steps apply to RHEL/CentOS 5 distributions. Discover the iSCSI target. - .. code:: bash + .. sourcecode:: bash # iscsiadm -m discovery -t st -p :3260 For example: - .. code:: bash + .. sourcecode:: bash - # iscsiadm -m discovery -t st -p 172.23.10.240:3260 - 172.23.10.240:3260,1 iqn.2001-05.com.equallogic:0-8a0906-83bcb3401-16e0002fd0a46f3d-rhel5-test + # iscsiadm -m discovery -t st -p 172.23.10.240:3260 172.23.10.240:3260,1 iqn.2001-05.com.equallogic:0-8a0906-83bcb3401-16e0002fd0a46f3d-rhel5-test #. Log in. - .. code:: bash + .. sourcecode:: bash # iscsiadm -m node -T -l -p :3260 For example: - .. code:: bash + .. sourcecode:: bash # iscsiadm -m node -l -T iqn.2001-05.com.equallogic:83bcb3401-16e0002fd0a46f3d-rhel5-test -p 172.23.10.240:3260 @@ -218,7 +221,7 @@ volume. These steps apply to RHEL/CentOS 5 distributions. Discover the SCSI disk. For example: - .. code:: bash + .. sourcecode:: bash # iscsiadm -m session -P3 | grep Attached Attached scsi disk sdb State: running @@ -227,7 +230,7 @@ volume. These steps apply to RHEL/CentOS 5 distributions. Format the disk as ext3 and mount the volume. - .. code:: bash + .. sourcecode:: bash # mkfs.ext3 /dev/sdb # mkdir -p /export @@ -237,7 +240,7 @@ volume. These steps apply to RHEL/CentOS 5 distributions. Add the disk to /etc/fstab to make sure it gets mounted on boot. - .. code:: bash + .. sourcecode:: bash /dev/sdb /export ext3 _netdev 0 0 @@ -258,7 +261,7 @@ Now you can set up /export as an NFS share. The following is an example with separate CIDRs: - .. code:: bash + .. sourcecode:: bash /export 192.168.1.0/24(rw,async,no_root_squash,no_subtree_check) 10.50.1.0/24(rw,async,no_root_squash,no_subtree_check) @@ -267,75 +270,4 @@ Now you can set up /export as an NFS share. **Removing the async flag.** The async flag improves performance by allowing the NFS server to respond before writes are committed to the disk. Remove the async flag in your mission critical production - deployment. - - -.. |1000-foot-view.png: Overview of CloudStack| image:: ./_static/images/1000-foot-view.png -.. |basic-deployment.png: Basic two-machine deployment| image:: ./_static/images/basic-deployment.png -.. |infrastructure_overview.png: Nested organization of a zone| image:: ./_static/images/infrastructure-overview.png -.. |region-overview.png: Nested structure of a region.| image:: ./_static/images/region-overview.png -.. |zone-overview.png: Nested structure of a simple zone.| image:: ./_static/images/zone-overview.png -.. |pod-overview.png: Nested structure of a simple pod| image:: ./_static/images/pod-overview.png -.. |cluster-overview.png: Structure of a simple cluster| image:: ./_static/images/cluster-overview.png -.. |installation-complete.png: Finished installs with single Management Server and multiple Management Servers| image:: ./_static/images/installation-complete.png -.. |change-password.png: button to change a user's password| image:: ./_static/images/change-password.png -.. |provisioning-overview.png: Conceptual overview of a basic deployment| image:: ./_static/images/provisioning-overview.png -.. |vsphereclient.png: vSphere client| image:: ./_static/images/vsphere-client.png -.. |addcluster.png: add a cluster| image:: ./_static/images/add-cluster.png -.. |ConsoleButton.png: button to launch a console| image:: ./_static/images/console-icon.png -.. |DeleteButton.png: button to delete dvSwitch| image:: ./_static/images/delete-button.png -.. |vds-name.png: Name of the dvSwitch as specified in the vCenter.| image:: ./_static/images/vds-name.png -.. |traffic-type.png: virtual switch type| image:: ./_static/images/traffic-type.png -.. |dvSwitchConfig.png: Configuring dvSwitch| image:: ./_static/images/dvSwitch-config.png -.. |Small-Scale Deployment| image:: ./_static/images/small-scale-deployment.png -.. |Large-Scale Redundant Setup| image:: ./_static/images/large-scale-redundant-setup.png -.. |Multi-Node Management Server| image:: ./_static/images/multi-node-management-server.png -.. |Example Of A Multi-Site Deployment| image:: ./_static/images/multi-site-deployment.png -.. |Separate Storage Network| image:: ./_static/images/separate-storage-network.png -.. |NIC Bonding And Multipath I/O| image:: ./_static/images/nic-bonding-and-multipath-io.png -.. |Use the GUI to set the configuration variable to true| image:: ./_static/images/ec2-s3-configuration.png -.. |Use the GUI to set the name of a compute service offering to an EC2 instance type API name.| image:: ./_static/images/compute-service-offerings.png -.. |parallel-mode.png: adding a firewall and load balancer in parallel mode.| image:: ./_static/images/parallel-mode.png -.. |guest-traffic-setup.png: Depicts a guest traffic setup| image:: ./_static/images/guest-traffic-setup.png -.. |networksinglepod.png: diagram showing logical view of network in a pod| image:: ./_static/images/network-singlepod.png -.. |networksetupzone.png: Depicts network setup in a single zone| image:: ./_static/images/network-setup-zone.png -.. |addguestnetwork.png: Add Guest network setup in a single zone| image:: ./_static/images/add-guest-network.png -.. |remove-nic.png: button to remove a NIC| image:: ./_static/images/remove-nic.png -.. |set-default-nic.png: button to set a NIC as default one.| image:: ./_static/images/set-default-nic.png -.. |EditButton.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |edit-icon.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |addAccount-icon.png: button to assign an IP range to an account.| image:: ./_static/images/addAccount-icon.png -.. |eip-ns-basiczone.png: Elastic IP in a NetScaler-enabled Basic Zone.| image:: ./_static/images/eip-ns-basiczone.png -.. |add-ip-range.png: adding an IP range to a network.| image:: ./_static/images/add-ip-range.png -.. |httpaccess.png: allows inbound HTTP access from anywhere| image:: ./_static/images/http-access.png -.. |autoscaleateconfig.png: Configuring AutoScale| image:: ./_static/images/autoscale-config.png -.. |EnableDisable.png: button to enable or disable AutoScale.| image:: ./_static/images/enable-disable-autoscale.png -.. |gslb.png: GSLB architecture| image:: ./_static/images/gslb.png -.. |gslb-add.png: adding a gslb rule| image:: ./_static/images/add-gslb.png -.. |ReleaseIPButton.png: button to release an IP| image:: ./_static/images/release-ip-icon.png -.. |EnableNATButton.png: button to enable NAT| image:: ./_static/images/enable-disable.png -.. |egress-firewall-rule.png: adding an egress firewall rule| image:: ./_static/images/egress-firewall-rule.png -.. |AttachDiskButton.png: button to attach a volume| image:: ./_static/images/vpn-icon.png -.. |vpn-icon.png: button to enable VPN| image:: ./_static/images/vpn-icon.png -.. |addvpncustomergateway.png: adding a customer gateway.| image:: ./_static/images/add-vpn-customer-gateway.png -.. |edit.png: button to edit a VPN customer gateway| image:: ./_static/images/edit-icon.png -.. |delete.png: button to remove a VPN customer gateway| image:: ./_static/images/delete-button.png -.. |createvpnconnection.png: creating a VPN connection to the customer gateway.| image:: ./_static/images/create-vpn-connection.png -.. |remove-vpn.png: button to remove a VPN connection| image:: ./_static/images/remove-vpn.png -.. |reset-vpn.png: button to reset a VPN connection| image:: ./_static/images/reset-vpn.png -.. |mutltier.png: a multi-tier setup.| image:: ./_static/images/multi-tier-app.png -.. |add-vpc.png: adding a vpc.| image:: ./_static/images/add-vpc.png -.. |add-tier.png: adding a tier to a vpc.| image:: ./_static/images/add-tier.png -.. |replace-acl-icon.png: button to replace an ACL list| image:: ./_static/images/replace-acl-icon.png -.. |add-new-gateway-vpc.png: adding a private gateway for the VPC.| image:: ./_static/images/add-new-gateway-vpc.png -.. |replace-acl-icon.png: button to replace the default ACL behaviour.| image:: ./_static/images/replace-acl-icon.png -.. |add-vm-vpc.png: adding a VM to a vpc.| image:: ./_static/images/add-vm-vpc.png -.. |addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.| image:: ./_static/images/addvm-tier-sharednw.png -.. |release-ip-icon.png: button to release an IP.| image:: ./_static/images/release-ip-icon.png -.. |enable-disable.png: button to enable Static NAT.| image:: ./_static/images/enable-disable.png -.. |select-vmstatic-nat.png: selecting a tier to apply staticNAT.| image:: ./_static/images/select-vm-staticnat-vpc.png -.. |vpc-lb.png: Configuring internal LB for VPC| image:: ./_static/images/vpc-lb.png -.. |del-tier.png: button to remove a tier| image:: ./_static/images/del-tier.png -.. |remove-vpc.png: button to remove a VPC| image:: ./_static/images/remove-vpc.png -.. |edit-icon.png: button to edit a VPC| image:: ./_static/images/edit-icon.png -.. |restart-vpc.png: button to restart a VPC| image:: ./_static/images/restart-vpc.png + deployment. \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack-docs-install/blob/7f2027bb/source/ui.rst ---------------------------------------------------------------------- diff --git a/source/ui.rst b/source/ui.rst index d2c8abe..49354db 100644 --- a/source/ui.rst +++ b/source/ui.rst @@ -26,7 +26,7 @@ available in popular browsers including IE7, IE8, IE9, Firefox 3.5+, Firefox 4, Safari 4, and Safari 5. The URL is: (substitute your own management server IP address) -:: +.. sourcecode:: bash http://:8080/client @@ -86,7 +86,7 @@ provision, view, and manage your cloud infrastructure. Open your favorite Web browser and go to this URL. Substitute the IP address of your own Management Server: - :: + .. sourcecode:: bash http://:8080/client @@ -133,7 +133,9 @@ provision, view, and manage your cloud infrastructure. chose experienced user, use the steps in `Section 5.1.4, “Changing the Root Password” <#changing-root-password>`__. -.. warning:: You are logging in as the root administrator. This account manages the CloudStack deployment, including physical infrastructure. The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. Please change the default password to a new, unique password. +.. warning:: + + You are logging in as the root administrator. This account manages the CloudStack deployment, including physical infrastructure. The root administrator can modify configuration settings to change basic functionality, create or delete user accounts, and take many actions that should be performed only by an authorized person. Please change the default password to a new, unique password. Changing the Root Password ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -152,7 +154,7 @@ new, unique value. Open your favorite Web browser and go to this URL. Substitute the IP address of your own Management Server: - :: + .. sourcecode:: bash http://:8080/client @@ -215,7 +217,7 @@ Create an instance template that supports SSH Keys. Script `__\ to the instance you have created. - :: + .. sourcecode:: bash wget http://downloads.sourceforge.net/project/cloudstack/SSH%20Key%20Gen%20Script/cloud-set-guest-sshkey.in?r=http%3A%2F%2Fsourceforge.net%2Fprojects%2Fcloudstack%2Ffiles%2FSSH%2520Key%2520Gen%2520Script%2F&ts=1331225219&use_mirror=iweb @@ -223,7 +225,7 @@ Create an instance template that supports SSH Keys. Copy the file to /etc/init.d. - :: + .. sourcecode:: bash cp cloud-set-guest-sshkey.in /etc/init.d/ @@ -231,7 +233,7 @@ Create an instance template that supports SSH Keys. Give the necessary permissions on the script: - :: + .. sourcecode:: bash chmod +x /etc/init.d/cloud-set-guest-sshkey.in @@ -239,7 +241,7 @@ Create an instance template that supports SSH Keys. Run the script while starting up the operating system: - :: + .. sourcecode:: bash chkconfig --add cloud-set-guest-sshkey.in @@ -263,13 +265,13 @@ keypair called "keypair-doc" for the admin account in the root domain: Run the following curl command: - :: + .. sourcecode:: bash curl --globoff "http://localhost:8096/?command=createSSHKeyPair&name=keypair-doc&account=admin&domainid=5163440e-c44b-42b5-9109-ad75cae8e8a2" The output is something similar to what is given below: - :: + .. sourcecode:: bash keypair-docf6:77:39:d5:5e:77:02:22:6a:d8:7f:ce:ab:cd:b3:56-----BEGIN RSA PRIVATE KEY----- MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci @@ -289,7 +291,7 @@ keypair called "keypair-doc" for the admin account in the root domain: Copy the key data into a file. The file looks like this: - :: + .. sourcecode:: bash -----BEGIN RSA PRIVATE KEY----- MIICXQIBAAKBgQCSydmnQ67jP6lNoXdX3noZjQdrMAWNQZ7y5SrEu4wDxplvhYci @@ -317,11 +319,13 @@ Instance Template that Supports SSH Keys” <#create-ssh-template>`__. Ensure that you use the same SSH key name that you created at `Section 5.2.2, “Creating the SSH Keypair” <#create-ssh-keypair>`__. -.. note:: You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair. +.. note:: + + You cannot create the instance by using the GUI at this time and associate the instance with the newly created SSH keypair. A sample curl command to create a new instance is: -:: +.. sourcecode:: bash curl --globoff http://localhost:/?command=deployVirtualMachine\&zoneId=1\&serviceOfferingId=18727021-7556-4110-9322-d625b52e0813\&templateId=e899c18a-ce13-4bbf-98a9-625c5026e0b5\&securitygroupids=ff03f02f-9e3b-48f8-834d-91b822da40c5\&account=admin\&domainid=1\&keypair=keypair-doc @@ -337,7 +341,7 @@ in to the cloud setup. For example, from a Linux OS, run: -:: +.. sourcecode:: bash ssh -i ~/.ssh/keypair-doc @@ -351,75 +355,4 @@ With the API command resetSSHKeyForVirtualMachine, a user can set or reset the SSH keypair assigned to a virtual machine. A lost or compromised SSH keypair can be changed, and the user can access the VM by using the new keypair. Just create or register a new keypair, then -call resetSSHKeyForVirtualMachine. - - -.. |1000-foot-view.png: Overview of CloudStack| image:: ./_static/images/1000-foot-view.png -.. |basic-deployment.png: Basic two-machine deployment| image:: ./_static/images/basic-deployment.png -.. |infrastructure_overview.png: Nested organization of a zone| image:: ./_static/images/infrastructure-overview.png -.. |region-overview.png: Nested structure of a region.| image:: ./_static/images/region-overview.png -.. |zone-overview.png: Nested structure of a simple zone.| image:: ./_static/images/zone-overview.png -.. |pod-overview.png: Nested structure of a simple pod| image:: ./_static/images/pod-overview.png -.. |cluster-overview.png: Structure of a simple cluster| image:: ./_static/images/cluster-overview.png -.. |installation-complete.png: Finished installs with single Management Server and multiple Management Servers| image:: ./_static/images/installation-complete.png -.. |change-password.png: button to change a user's password| image:: ./_static/images/change-password.png -.. |provisioning-overview.png: Conceptual overview of a basic deployment| image:: ./_static/images/provisioning-overview.png -.. |vsphereclient.png: vSphere client| image:: ./_static/images/vsphere-client.png -.. |addcluster.png: add a cluster| image:: ./_static/images/add-cluster.png -.. |ConsoleButton.png: button to launch a console| image:: ./_static/images/console-icon.png -.. |DeleteButton.png: button to delete dvSwitch| image:: ./_static/images/delete-button.png -.. |vds-name.png: Name of the dvSwitch as specified in the vCenter.| image:: ./_static/images/vds-name.png -.. |traffic-type.png: virtual switch type| image:: ./_static/images/traffic-type.png -.. |dvSwitchConfig.png: Configuring dvSwitch| image:: ./_static/images/dvSwitch-config.png -.. |Small-Scale Deployment| image:: ./_static/images/small-scale-deployment.png -.. |Large-Scale Redundant Setup| image:: ./_static/images/large-scale-redundant-setup.png -.. |Multi-Node Management Server| image:: ./_static/images/multi-node-management-server.png -.. |Example Of A Multi-Site Deployment| image:: ./_static/images/multi-site-deployment.png -.. |Separate Storage Network| image:: ./_static/images/separate-storage-network.png -.. |NIC Bonding And Multipath I/O| image:: ./_static/images/nic-bonding-and-multipath-io.png -.. |Use the GUI to set the configuration variable to true| image:: ./_static/images/ec2-s3-configuration.png -.. |Use the GUI to set the name of a compute service offering to an EC2 instance type API name.| image:: ./_static/images/compute-service-offerings.png -.. |parallel-mode.png: adding a firewall and load balancer in parallel mode.| image:: ./_static/images/parallel-mode.png -.. |guest-traffic-setup.png: Depicts a guest traffic setup| image:: ./_static/images/guest-traffic-setup.png -.. |networksinglepod.png: diagram showing logical view of network in a pod| image:: ./_static/images/network-singlepod.png -.. |networksetupzone.png: Depicts network setup in a single zone| image:: ./_static/images/network-setup-zone.png -.. |addguestnetwork.png: Add Guest network setup in a single zone| image:: ./_static/images/add-guest-network.png -.. |remove-nic.png: button to remove a NIC| image:: ./_static/images/remove-nic.png -.. |set-default-nic.png: button to set a NIC as default one.| image:: ./_static/images/set-default-nic.png -.. |EditButton.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |edit-icon.png: button to edit a network| image:: ./_static/images/edit-icon.png -.. |addAccount-icon.png: button to assign an IP range to an account.| image:: ./_static/images/addAccount-icon.png -.. |eip-ns-basiczone.png: Elastic IP in a NetScaler-enabled Basic Zone.| image:: ./_static/images/eip-ns-basiczone.png -.. |add-ip-range.png: adding an IP range to a network.| image:: ./_static/images/add-ip-range.png -.. |httpaccess.png: allows inbound HTTP access from anywhere| image:: ./_static/images/http-access.png -.. |autoscaleateconfig.png: Configuring AutoScale| image:: ./_static/images/autoscale-config.png -.. |EnableDisable.png: button to enable or disable AutoScale.| image:: ./_static/images/enable-disable-autoscale.png -.. |gslb.png: GSLB architecture| image:: ./_static/images/gslb.png -.. |gslb-add.png: adding a gslb rule| image:: ./_static/images/add-gslb.png -.. |ReleaseIPButton.png: button to release an IP| image:: ./_static/images/release-ip-icon.png -.. |EnableNATButton.png: button to enable NAT| image:: ./_static/images/enable-disable.png -.. |egress-firewall-rule.png: adding an egress firewall rule| image:: ./_static/images/egress-firewall-rule.png -.. |AttachDiskButton.png: button to attach a volume| image:: ./_static/images/vpn-icon.png -.. |vpn-icon.png: button to enable VPN| image:: ./_static/images/vpn-icon.png -.. |addvpncustomergateway.png: adding a customer gateway.| image:: ./_static/images/add-vpn-customer-gateway.png -.. |edit.png: button to edit a VPN customer gateway| image:: ./_static/images/edit-icon.png -.. |delete.png: button to remove a VPN customer gateway| image:: ./_static/images/delete-button.png -.. |createvpnconnection.png: creating a VPN connection to the customer gateway.| image:: ./_static/images/create-vpn-connection.png -.. |remove-vpn.png: button to remove a VPN connection| image:: ./_static/images/remove-vpn.png -.. |reset-vpn.png: button to reset a VPN connection| image:: ./_static/images/reset-vpn.png -.. |mutltier.png: a multi-tier setup.| image:: ./_static/images/multi-tier-app.png -.. |add-vpc.png: adding a vpc.| image:: ./_static/images/add-vpc.png -.. |add-tier.png: adding a tier to a vpc.| image:: ./_static/images/add-tier.png -.. |replace-acl-icon.png: button to replace an ACL list| image:: ./_static/images/replace-acl-icon.png -.. |add-new-gateway-vpc.png: adding a private gateway for the VPC.| image:: ./_static/images/add-new-gateway-vpc.png -.. |replace-acl-icon.png: button to replace the default ACL behaviour.| image:: ./_static/images/replace-acl-icon.png -.. |add-vm-vpc.png: adding a VM to a vpc.| image:: ./_static/images/add-vm-vpc.png -.. |addvm-tier-sharednw.png: adding a VM to a VPC tier and shared network.| image:: ./_static/images/addvm-tier-sharednw.png -.. |release-ip-icon.png: button to release an IP.| image:: ./_static/images/release-ip-icon.png -.. |enable-disable.png: button to enable Static NAT.| image:: ./_static/images/enable-disable.png -.. |select-vmstatic-nat.png: selecting a tier to apply staticNAT.| image:: ./_static/images/select-vm-staticnat-vpc.png -.. |vpc-lb.png: Configuring internal LB for VPC| image:: ./_static/images/vpc-lb.png -.. |del-tier.png: button to remove a tier| image:: ./_static/images/del-tier.png -.. |remove-vpc.png: button to remove a VPC| image:: ./_static/images/remove-vpc.png -.. |edit-icon.png: button to edit a VPC| image:: ./_static/images/edit-icon.png -.. |restart-vpc.png: button to restart a VPC| image:: ./_static/images/restart-vpc.png +call resetSSHKeyForVirtualMachine. \ No newline at end of file