http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/basic-zone-configuration.xml ---------------------------------------------------------------------- diff --git a/en-US/basic-zone-configuration.xml b/en-US/basic-zone-configuration.xml deleted file mode 100644 index 79d4ab8..0000000 --- a/en-US/basic-zone-configuration.xml +++ /dev/null @@ -1,319 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="basic-zone-configuration"> - <title>Basic Zone Configuration</title> - <orderedlist> - <listitem> - <para>After you select Basic in the Add Zone wizard and click Next, you will be asked to enter - the following details. Then click Next.</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name.</emphasis> A name for the zone.</para> - </listitem> - <listitem> - <para><emphasis role="bold">DNS 1 and 2.</emphasis> These are DNS servers for use by guest - VMs in the zone. These DNS servers will be accessed via the public network you will add - later. The public IP addresses for the zone must have a route to the DNS server named - here.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Internal DNS 1 and Internal DNS 2.</emphasis> These are DNS - servers for use by system VMs in the zone (these are VMs used by &PRODUCT; itself, such - as virtual routers, console proxies, and Secondary Storage VMs.) These DNS servers will - be accessed via the management traffic network interface of the System VMs. The private - IP address you provide for the pods must have a route to the internal DNS server named - here.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Hypervisor.</emphasis> (Introduced in version 3.0.1) Choose - the hypervisor for the first cluster in the zone. You can add clusters with different - hypervisors later, after you finish adding the zone.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Network Offering.</emphasis> Your choice here determines what - network services will be available on the network for guest VMs.</para> - <informaltable frame="all"> - <tgroup cols="2" align="left" colsep="1" rowsep="1"> - <colspec colname="c1"/> - <colspec colname="c2"/> - <thead> - <row> - <entry><para>Network Offering</para></entry> - <entry><para>Description</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>DefaultSharedNetworkOfferingWithSGService</para></entry> - <entry><para>If you want to enable security groups for guest traffic isolation, - choose this. (See Using Security Groups to Control Traffic to - VMs.)</para></entry> - </row> - <row> - <entry><para>DefaultSharedNetworkOffering</para></entry> - <entry><para>If you do not need security groups, choose this.</para></entry> - </row> - <row> - <entry><para>DefaultSharedNetscalerEIPandELBNetworkOffering</para></entry> - <entry><para>If you have installed a Citrix NetScaler appliance as part of your - zone network, and you will be using its Elastic IP and Elastic Load Balancing - features, choose this. With the EIP and ELB features, a basic zone with - security groups enabled can offer 1:1 static NAT and load - balancing.</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - <listitem> - <para><emphasis role="bold">Network Domain.</emphasis> (Optional) If you want to assign a - special domain name to the guest VM network, specify the DNS suffix.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Public.</emphasis> A public zone is available to all users. A - zone that is not public will be assigned to a particular domain. Only users in that - domain will be allowed to create guest VMs in this zone.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Choose which traffic types will be carried by the physical network.</para> - <para>The traffic types are management, public, guest, and storage traffic. For more - information about the types, roll over the icons to display their tool tips, or see Basic - Zone Network Traffic Types. This screen starts out with some traffic types already assigned. - To add more, drag and drop traffic types onto the network. You can also change the network - name if desired.</para> - </listitem> - <listitem> - <para>Assign a network traffic label to each traffic type on the physical network. These - labels must match the labels you have already defined on the hypervisor host. To assign each - label, click the Edit button under the traffic type icon. A popup dialog appears where you - can type the label, then click OK.</para> - <para>These traffic labels will be defined only for the hypervisor selected for the first - cluster. For all other hypervisors, the labels can be configured after the zone is - created.</para> - </listitem> - <listitem> - <para>Click Next.</para> - </listitem> - <listitem> - <para>(NetScaler only) If you chose the network offering for NetScaler, you have an additional - screen to fill out. Provide the requested details to set up the NetScaler, then click - Next.</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">IP address.</emphasis> The NSIP (NetScaler IP) address of the - NetScaler device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Username/Password.</emphasis> The authentication credentials - to access the device. &PRODUCT; uses these credentials to access the device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Type.</emphasis> NetScaler device type that is being added. It - could be NetScaler VPX, NetScaler MPX, or NetScaler SDX. For a comparison of the types, - see About Using a NetScaler Load Balancer.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Public interface.</emphasis> Interface of NetScaler that is - configured to be part of the public network.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Private interface.</emphasis> Interface of NetScaler that is - configured to be part of the private network.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Number of retries.</emphasis> Number of times to attempt a - command on the device before considering the operation failed. Default is 2.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Capacity.</emphasis> Number of guest networks/accounts that - will share this NetScaler device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Dedicated.</emphasis> When marked as dedicated, this device - will be dedicated to a single account. When Dedicated is checked, the value in the - Capacity field has no significance â implicitly, its value is 1.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>(NetScaler only) Configure the IP range for public traffic. The IPs in this range will - be used for the static NAT capability which you enabled by selecting the network offering - for NetScaler with EIP and ELB. Enter the following details, then click Add. If desired, you - can repeat this step to add more IP ranges. When done, click Next.</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Gateway.</emphasis> The gateway in use for these IP - addresses.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Netmask.</emphasis> The netmask associated with this IP - range.</para> - </listitem> - <listitem> - <para><emphasis role="bold">VLAN.</emphasis> The VLAN that will be used for public - traffic.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Start IP/End IP.</emphasis> A range of IP addresses that are - assumed to be accessible from the Internet and will be allocated for access to guest - VMs.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new zone, &PRODUCT; adds the first pod for you. You can always add more pods later. - For an overview of what a pod is, see <xref linkend="about-pods"/>.</para> - <para>To configure the first pod, enter the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Pod Name.</emphasis> A name for the pod.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Reserved system gateway.</emphasis> The gateway for the hosts - in that pod.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Reserved system netmask.</emphasis> The network prefix that - defines the pod's subnet. Use CIDR notation.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Start/End Reserved System IP.</emphasis> The IP range in the - management network that &PRODUCT; uses to manage various system VMs, such as Secondary - Storage VMs, Console Proxy VMs, and DHCP. For more information, see System Reserved IP - Addresses.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Configure the network for guest traffic. Provide the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Guest gateway.</emphasis> The gateway that the guests should - use.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Guest netmask.</emphasis> The netmask in use on the subnet the - guests will use.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Guest start IP/End IP.</emphasis> Enter the first and last IP - addresses that define a range that &PRODUCT; can assign to guests.</para> - <itemizedlist> - <listitem> - <para>We strongly recommend the use of multiple NICs. If multiple NICs are used, they - may be in a different subnet.</para> - </listitem> - <listitem> - <para>If one NIC is used, these IPs should be in the same CIDR as the pod CIDR.</para> - </listitem> - </itemizedlist> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new pod, &PRODUCT; adds the first cluster for you. You can always add more clusters - later. For an overview of what a cluster is, see About Clusters.</para> - <para>To configure the first cluster, enter the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Hypervisor.</emphasis> (Version 3.0.0 only; in 3.0.1, this - field is read only) Choose the type of hypervisor software that all hosts in this - cluster will run. If you choose VMware, additional fields appear so you can give - information about a vSphere cluster. For vSphere servers, we recommend creating the - cluster of hosts in vCenter and then adding the entire cluster to &PRODUCT;. See Add - Cluster: vSphere.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Cluster name.</emphasis> Enter a name for the cluster. This - can be text of your choosing and is not used by &PRODUCT;.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new cluster, &PRODUCT; adds the first host for you. You can always add more hosts - later. For an overview of what a host is, see About Hosts.</para> - <note> - <para>When you add a hypervisor host to &PRODUCT;, the host must not have any VMs already - running.</para> - </note> - <para>Before you can configure the host, you need to install the hypervisor software on the - host. You will need to know which version of the hypervisor software version is supported by - &PRODUCT; and what additional configuration is required to ensure the host will work with - &PRODUCT;. To find these installation details, see:</para> - <itemizedlist> - <listitem> - <para>Citrix XenServer Installation and Configuration</para> - </listitem> - <listitem> - <para>VMware vSphere Installation and Configuration</para> - </listitem> - <listitem> - <para>KVM vSphere Installation and Configuration</para> - </listitem> - <!-- <listitem><para>Oracle VM (OVM) Installation and Configuration</para></listitem> --> - </itemizedlist> - <para>To configure the first host, enter the following, then click Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Host Name.</emphasis> The DNS name or IP address of the - host.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Username.</emphasis> The username is root.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Password.</emphasis> This is the password for the user named - above (from your XenServer or KVM install).</para> - </listitem> - <listitem> - <para><emphasis role="bold">Host Tags.</emphasis> (Optional) Any labels that you use to - categorize hosts for ease of maintenance. For example, you can set this to the cloud's - HA tag (set in the ha.tag global configuration parameter) if you want this host to be - used only for VMs with the "high availability" feature enabled. For more information, - see HA-Enabled Virtual Machines as well as HA for Hosts.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>In a new cluster, &PRODUCT; adds the first primary storage server for you. You can - always add more servers later. For an overview of what primary storage is, see About Primary - Storage.</para> - <para>To configure the first primary storage server, enter the following, then click - Next:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name.</emphasis> The name of the storage device.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Protocol.</emphasis> For XenServer, choose either NFS, iSCSI, - or PreSetup. For KVM, choose NFS, SharedMountPoint,CLVM, or RBD. For vSphere choose - either VMFS (iSCSI or FiberChannel) or NFS. The remaining fields in the screen vary - depending on what you choose here.</para> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> -</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/basic-zone-guest-ip-addresses.xml ---------------------------------------------------------------------- diff --git a/en-US/basic-zone-guest-ip-addresses.xml b/en-US/basic-zone-guest-ip-addresses.xml deleted file mode 100644 index 5143f71..0000000 --- a/en-US/basic-zone-guest-ip-addresses.xml +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="basic-zone-guest-ip-addresses"> - <title>Basic Zone Guest IP Addresses</title> - <para>When basic networking is used, &PRODUCT; will assign IP addresses in the CIDR of the pod to the guests in that pod. The administrator must add a Direct IP range on the pod for this purpose. These IPs are in the same VLAN as the hosts.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/basic-zone-network-traffic-types.xml ---------------------------------------------------------------------- diff --git a/en-US/basic-zone-network-traffic-types.xml b/en-US/basic-zone-network-traffic-types.xml deleted file mode 100644 index 8503736..0000000 --- a/en-US/basic-zone-network-traffic-types.xml +++ /dev/null @@ -1,35 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="basic-zone-network-traffic-types"> - <title>Basic Zone Network Traffic Types</title> - <para>When basic networking is used, there can be only one physical network in the zone. That physical network carries the following traffic types:</para> - <itemizedlist> - <listitem><para>Guest. When end users run VMs, they generate guest traffic. The guest VMs communicate with each other over a network that can be referred to as the guest network. Each pod in a basic zone is a broadcast domain, and therefore each pod has a different IP range for the guest network. The administrator must configure the IP range for each pod.</para></listitem> - <listitem><para>Management. When &PRODUCT;'s internal resources communicate with each other, they generate management traffic. This includes communication between hosts, system VMs (VMs used by &PRODUCT; to perform various tasks in the cloud), and any other component that communicates directly with the &PRODUCT; Management Server. You must configure the IP range for the system VMs to use.</para> - <note><para>We strongly recommend the use of separate NICs for management traffic and guest traffic.</para></note></listitem> - <listitem><para>Public. Public traffic is generated when VMs in the cloud access the Internet. Publicly accessible IPs must be allocated for this purpose. End users can use the &PRODUCT; UI to acquire these IPs to implement NAT between their guest network and the public network, as described in Acquiring a New IP Address.</para></listitem> - <listitem><para>Storage. While labeled "storage" this is specifically about secondary storage, and doesn't affect traffic for primary storage. This includes traffic such as VM templates and snapshots, which is sent between the secondary storage VM and secondary storage servers. &PRODUCT; uses a separate Network Interface Controller (NIC) named storage NIC for storage network traffic. Use of a storage NIC that always operates on a high bandwidth network allows fast template and snapshot copying. You must configure the IP range to use for the storage network.</para></listitem> - </itemizedlist> - <para>In a basic network, configuring the physical network is fairly straightforward. In most cases, you only need to configure one guest network to carry traffic that is generated by guest VMs. If you use a NetScaler load balancer and enable its elastic IP and elastic load balancing (EIP and ELB) features, you must also configure a network to carry public traffic. &PRODUCT; takes care of presenting the necessary network configuration steps to you in the UI when you add a new zone.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/basic-zone-physical-network-configuration.xml ---------------------------------------------------------------------- diff --git a/en-US/basic-zone-physical-network-configuration.xml b/en-US/basic-zone-physical-network-configuration.xml deleted file mode 100644 index 4b1d24f..0000000 --- a/en-US/basic-zone-physical-network-configuration.xml +++ /dev/null @@ -1,28 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> -<section id="basic-zone-physical-network-configuration"> - <title>Basic Zone Physical Network Configuration</title> - <para>In a basic network, configuring the physical network is fairly straightforward. You only need to configure one guest network to carry traffic that is generated by guest VMs. When you first add a zone to &PRODUCT;, you set up the guest network through the Add Zone screens.</para> - - </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/best-practices-for-vms.xml ---------------------------------------------------------------------- diff --git a/en-US/best-practices-for-vms.xml b/en-US/best-practices-for-vms.xml deleted file mode 100644 index f2656a0..0000000 --- a/en-US/best-practices-for-vms.xml +++ /dev/null @@ -1,67 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="best-practices-vm"> - <title>Best Practices for Virtual Machines</title> - <para>For VMs to work as expected and provide excellent service, follow these guidelines.</para> - <section id="best-practices-vm-monitoring"> - <title>Monitor VMs for Max Capacity</title> - <para>The &PRODUCT; administrator should monitor the total number of VM instances in each - cluster, and disable allocation to the cluster if the total is approaching the maximum that - the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of - one or more hosts failing, which would increase the VM load on the other hosts as the VMs - are automatically redeployed. Consult the documentation for your chosen hypervisor to find - the maximum permitted number of VMs per host, then use &PRODUCT; global configuration - settings to set this as the default limit. Monitor the VM activity in each cluster at all - times. Keep the total number of VMs below a safe level that allows for the occasional host - failure. For example, if there are N hosts in the cluster, and you want to allow for one - host in the cluster to be down at any given time, the total number of VM instances you can - permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this - number of VMs, use the &PRODUCT; UI to disable allocation of more VMs to the - cluster.</para> - </section> - <section id="best-practices-vm-tools"> - <title>Install Required Tools and Drivers</title> - <para>Be sure the following are installed on each VM:</para> - <itemizedlist> - <listitem><para>For XenServer, install PV drivers and Xen tools on each VM. - This will enable live migration and clean guest shutdown. - Xen tools are required in order for dynamic CPU and RAM scaling to work.</para></listitem> - <listitem><para>For vSphere, install VMware Tools on each VM. - This will enable console view to work properly. - VMware Tools are required in order for dynamic CPU and RAM scaling to work.</para></listitem> - </itemizedlist> - <para>To be sure that Xen tools or VMware Tools is installed, use one of the following techniques:</para> - <itemizedlist> - <listitem><para>Create each VM from a template that already has the tools installed; or,</para></listitem> - <listitem><para>When registering a new template, the administrator or user can indicate whether tools are - installed on the template. This can be done through the UI - or using the updateTemplate API; or,</para></listitem> - <listitem><para>If a user deploys a virtual machine with a template that does not have - Xen tools or VMware Tools, and later installs the tools on the VM, - then the user can inform &PRODUCT; using the updateVirtualMachine API. - After installing the tools and updating the virtual machine, stop - and start the VM.</para></listitem> - </itemizedlist> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/best-practices-primary-storage.xml ---------------------------------------------------------------------- diff --git a/en-US/best-practices-primary-storage.xml b/en-US/best-practices-primary-storage.xml deleted file mode 100644 index 279b95c..0000000 --- a/en-US/best-practices-primary-storage.xml +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="best-practices-primary-storage"> - <title>Best Practices for Primary Storage</title> - <itemizedlist> - <listitem><para>The speed of primary storage will impact guest performance. If possible, choose smaller, higher RPM drives or SSDs for primary storage.</para></listitem> - <listitem><para>There are two ways CloudStack can leverage primary storage:</para> - <para>Static: This is CloudStack's traditional way of handling storage. In this model, a preallocated amount of storage (ex. a volume from a SAN) is given to CloudStack. CloudStack then permits many of its volumes to be created on this storage (can be root and/or data disks). If using this technique, ensure that nothing is stored on the storage. Adding the storage to &PRODUCT; will destroy any existing data.</para> - <para>Dynamic: This is a newer way for CloudStack to manage storage. In this model, a storage system (rather than a preallocated amount of storage) is given to CloudStack. CloudStack, working in concert with a storage plug-in, dynamically creates volumes on the storage system and each volume on the storage system maps to a single CloudStack volume. This is highly useful for features such as storage Quality of Service. Currently this feature is supported for data disks (Disk Offerings).</para></listitem> - </itemizedlist> - </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/best-practices-secondary-storage.xml ---------------------------------------------------------------------- diff --git a/en-US/best-practices-secondary-storage.xml b/en-US/best-practices-secondary-storage.xml deleted file mode 100644 index 3d535c3..0000000 --- a/en-US/best-practices-secondary-storage.xml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="best-practices-secondary-storage"> - <title>Best Practices for Secondary Storage</title> - <itemizedlist> - <listitem><para>Each Zone can have one or more secondary storage servers. Multiple secondary storage servers provide increased scalability to the system.</para></listitem> - <listitem><para>Secondary storage has a high read:write ratio and is expected to consist of larger drives with lower IOPS than primary storage.</para></listitem> - <listitem><para>Ensure that nothing is stored on the server. Adding the server to &PRODUCT; will destroy any existing data.</para></listitem> - </itemizedlist> - </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/best-practices-templates.xml ---------------------------------------------------------------------- diff --git a/en-US/best-practices-templates.xml b/en-US/best-practices-templates.xml deleted file mode 100644 index 4e2992c..0000000 --- a/en-US/best-practices-templates.xml +++ /dev/null @@ -1,28 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="best-practices-templates"> - <title>Best Practices for Templates</title> - <para>If you plan to use large templates (100 GB or larger), be sure you have a 10-gigabit network to support the large templates. A slower network can lead to timeouts and other errors when large templates are used.</para> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/best-practices-virtual-router.xml ---------------------------------------------------------------------- diff --git a/en-US/best-practices-virtual-router.xml b/en-US/best-practices-virtual-router.xml deleted file mode 100644 index 060d868..0000000 --- a/en-US/best-practices-virtual-router.xml +++ /dev/null @@ -1,34 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="best-practices-virtual-router"> - <title>Best Practices for Virtual Routers</title> - <itemizedlist> - <listitem><para>WARNING: Restarting a virtual router from a hypervisor console deletes all the iptables rules. To work around this issue, stop the virtual router and start it from the &PRODUCT; UI.</para></listitem> - <listitem><para>WARNING: Do not use the destroyRouter API when only one router is available in the network, because restartNetwork API with the cleanup=false parameter can't recreate it later. If you want to destroy and recreate the single router available in the network, use the restartNetwork API with the cleanup=true parameter.</para></listitem> - </itemizedlist> - - - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/best-practices.xml ---------------------------------------------------------------------- diff --git a/en-US/best-practices.xml b/en-US/best-practices.xml deleted file mode 100644 index 41d7cde..0000000 --- a/en-US/best-practices.xml +++ /dev/null @@ -1,82 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<chapter id="best-practices"> - <title>Best Practices</title> - <para>Deploying a cloud is challenging. There are many different technology choices to make, and &PRODUCT; is flexible enough in its configuration that there are many possible ways to combine and configure the chosen technology. This section contains suggestions and requirements about cloud deployments.</para> - <para>These should be treated as suggestions and not absolutes. However, we do encourage anyone planning to build a cloud outside of these guidelines to seek guidance and advice on the project mailing lists.</para> - <section id="process-best-practices"> - <title>Process Best Practices</title> - <itemizedlist> - <listitem> - <para>A staging system that models the production environment is strongly advised. It is critical if customizations have been applied to &PRODUCT;.</para> - </listitem> - <listitem> - <para>Allow adequate time for installation, a beta, and learning the system. Installs with basic networking can be done in hours. Installs with advanced networking usually take several days for the first attempt, with complicated installations taking longer. For a full production system, allow at least 4-8 weeks for a beta to work through all of the integration issues. You can get help from fellow users on the cloudstack-users mailing list.</para> - </listitem> - </itemizedlist> - </section> - <section id="setup-best-practices"> - <title>Setup Best Practices</title> - <itemizedlist> - <listitem> - <para>Each host should be configured to accept connections only from well-known entities such as the &PRODUCT; Management Server or your network monitoring software.</para> - </listitem> - <listitem> - <para>Use multiple clusters per pod if you need to achieve a certain switch density.</para> - </listitem> - <listitem> - <para>Primary storage mountpoints or LUNs should not exceed 6 TB in size. It is better to have multiple smaller primary storage elements per cluster than one large one.</para> - </listitem> - <listitem> - <para>When exporting shares on primary storage, avoid data loss by restricting the range of IP addresses that can access the storage. See "Linux NFS on Local Disks and DAS" or "Linux NFS on iSCSI".</para> - </listitem> - <listitem> - <para>NIC bonding is straightforward to implement and provides increased reliability.</para> - </listitem> - <listitem> - <para>10G networks are generally recommended for storage access when larger servers that can support relatively more VMs are used.</para> - </listitem> - <listitem> - <para>Host capacity should generally be modeled in terms of RAM for the guests. Storage and CPU may be overprovisioned. RAM may not. RAM is usually the limiting factor in capacity designs.</para> - </listitem> - <listitem> - <para>(XenServer) Configure the XenServer dom0 settings to allocate more memory to dom0. This can enable XenServer to handle larger numbers of virtual machines. We recommend 2940 MB of RAM for XenServer dom0. For instructions on how to do this, see <ulink url="http://support.citrix.com/article/CTX126531";>http://support.citrix.com/article/CTX126531</ulink>. The article refers to XenServer 5.6, but the same information applies to XenServer 6.0.</para> - </listitem> - </itemizedlist> - </section> - <section id="maintenance-best-practices"> - <title>Maintenance Best Practices</title> - <itemizedlist> - <listitem> - <para>Monitor host disk space. Many host failures occur because the host's root disk fills up from logs that were not rotated adequately.</para> - </listitem> - <listitem> - <para>Monitor the total number of VM instances in each cluster, and disable allocation to the cluster if the total is approaching the maximum that the hypervisor can handle. Be sure to leave a safety margin to allow for the possibility of one or more hosts failing, which would increase the VM load on the other hosts as the VMs are redeployed. Consult the documentation for your chosen hypervisor to find the maximum permitted number of VMs per host, then use &PRODUCT; global configuration settings to set this as the default limit. Monitor the VM activity in each cluster and keep the total number of VMs below a safe level that allows for the occasional host failure. For example, if there are N hosts in the cluster, and you want to allow for one host in the cluster to be down at any given time, the total number of VM instances you can permit in the cluster is at most (N-1) * (per-host-limit). Once a cluster reaches this number of VMs, use the &PRODUCT; UI to disable allocation t o the cluster.</para> - </listitem> - </itemizedlist> - <warning><para>The lack of up-do-date hotfixes can lead to data corruption and lost VMs.</para></warning> - <para>Be sure all the hotfixes provided by the hypervisor vendor are applied. Track the release of hypervisor patches through your hypervisor vendorâs support channel, and apply patches as soon as possible after they are released. &PRODUCT; will not track or notify you of required hypervisor patches. It is essential that your hosts are completely up to date with the provided hypervisor patches. The hypervisor vendor is likely to refuse to support any system that is not up to date with patches.</para> - </section> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/build-deb.xml ---------------------------------------------------------------------- diff --git a/en-US/build-deb.xml b/en-US/build-deb.xml deleted file mode 100644 index 842554c..0000000 --- a/en-US/build-deb.xml +++ /dev/null @@ -1,114 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="sect-source-builddebs"> - <title>Building DEB packages</title> - <para> - In addition to the bootstrap dependencies, you'll also need to install - several other dependencies. Note that we recommend using Maven 3, which - is not currently available in 12.04.1 LTS. So, you'll also need to add a - PPA repository that includes Maven 3. After running the command - <command>add-apt-repository</command>, you will be prompted to continue and - a GPG key will be added. - </para> -<screen> -<command>$ sudo apt-get update</command> -<command>$ sudo apt-get install python-software-properties</command> -<command>$ sudo add-apt-repository ppa:natecarlson/maven3</command> -<command>$ sudo apt-get update</command> -<command>$ sudo apt-get install ant debhelper openjdk-6-jdk tomcat6 libws-commons-util-java genisoimage python-mysqldb libcommons-codec-java libcommons-httpclient-java liblog4j1.2-java maven3</command> -</screen> - <para> - While we have defined, and you have presumably already installed the - bootstrap prerequisites, there are a number of build time prerequisites - that need to be resolved. &PRODUCT; uses maven for dependency resolution. - You can resolve the buildtime depdencies for CloudStack by running:</para> - -<screen><command>$ mvn3 -P deps</command></screen> - <para> - Now that we have resolved the dependencies we can move on to building &PRODUCT; - and packaging them into DEBs by issuing the following command. - </para> -<screen> -<command>$ dpkg-buildpackage -uc -us</command> -</screen> - -<para> - This command will build the following debian packages. You should have all of the following: -</para> -<programlisting> -cloudstack-common-4.2.0.amd64.deb -cloudstack-management-4.2.0.amd64.deb -cloudstack-agent-4.2.0.amd64.deb -cloudstack-usage-4.2.0.amd64.deb -cloudstack-awsapi-4.2.0.amd64.deb -cloudstack-cli-4.2.0.amd64.deb -cloudstack-docs-4.2.0.amd64.deb -</programlisting> - - <section id="sect-source-builddebs-repo"> - <title>Setting up an APT repo</title> - - <para>After you've created the packages, you'll want to copy them to a system where you can serve the packages over HTTP. You'll create a directory for the packages and then use <code>dpkg-scanpackages</code> to create <filename>Packages.gz</filename>, which holds information about the archive structure. Finally, you'll add the repository to your system(s) so you can install the packages using APT.</para> - - <para>The first step is to make sure that you have the <application>dpkg-dev</application> package installed. This should have been installed when you pulled in the <application>debhelper</application> application previously, but if you're generating <filename>Packages.gz</filename> on a different system, be sure that it's installed there as well.</para> - -<screen><command>$ sudo apt-get install dpkg-dev</command></screen> - -<para>The next step is to copy the DEBs to the directory where they can be served over HTTP. We'll use <filename>/var/www/cloudstack/repo</filename> in the examples, but change the directory to whatever works for you.</para> - -<screen> -<command>sudo mkdir -p /var/www/cloudstack/repo/binary</command> -<command>sudo cp *.deb /var/www/cloudstack/repo/binary</command> -<command>sudo cd /var/www/cloudstack/repo/binary</command> -<command>sudo dpkg-scanpackages . /dev/null | tee Packages | gzip -9 > Packages.gz</command> -</screen> - -<note><title>Note: Override Files</title> - <para>You can safely ignore the warning about a missing override file.</para> -</note> - -<para>Now you should have all of the DEB packages and <filename>Packages.gz</filename> in the <filename>binary</filename> directory and available over HTTP. (You may want to use <command>wget</command> or <command>curl</command> to test this before moving on to the next step.)</para> - - </section> - <section id="sect-source-builddebs-repo2"> - <title>Configuring your machines to use the APT repository</title> - <para> - Now that we have created the repository, you need to configure your machine - to make use of the APT repository. You can do this by adding a repository file - under <filename>/etc/apt/sources.list.d</filename>. Use your preferred editor to - create <filename>/etc/apt/sources.list.d/cloudstack.list</filename> with this - line:</para> - - <programlisting>deb http://<replaceable>server.url</replaceable>/cloudstack/repo binary ./</programlisting> - - <para>Now that you have the repository info in place, you'll want to run another - update so that APT knows where to find the &PRODUCT; packages.</para> - -<screen><command>$ sudo apt-get update</command></screen> - -<para>You can now move on to the instructions under Install on Ubuntu.</para> - - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/build-nonoss.xml ---------------------------------------------------------------------- diff --git a/en-US/build-nonoss.xml b/en-US/build-nonoss.xml deleted file mode 100644 index fceca60..0000000 --- a/en-US/build-nonoss.xml +++ /dev/null @@ -1,49 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<section id="sect-source-nonoss"> - <title>Building Non-OSS</title> - <para>If you need support for the VMware, NetApp, F5, NetScaler, SRX, or any other non-Open Source Software (nonoss) plugins, you'll need to download a few components on your own and follow a slightly different procedure to build from source.</para> - <note><title>Why Non-OSS?</title> - <para>Some of the plugins supported by &PRODUCT; cannot be distributed with &PRODUCT; for licensing reasons. In some cases, some of the required libraries/JARs are under a proprietary license. In other cases, the required libraries may be under a license that's not compatible with <ulink url="http://www.apache.org/legal/resolved.html#category-x";>Apache's licensing guidelines for third-party products</ulink>.</para> - </note> - <orderedlist> - <listitem> - <para>To build the Non-OSS plugins, you'll need to have the requisite JARs installed under the <filename>deps</filename> directory.</para> - <para>Because these modules require dependencies that can't be distributed with &PRODUCT; you'll need to download them yourself. Links to the most recent dependencies are listed on the <ulink url="https://cwiki.apache.org/CLOUDSTACK/how-to-build-on-master-branch.html";><emphasis>How to build on master branch</emphasis></ulink> page on the wiki.</para></listitem> - <listitem> - <para>You may also need to download <ulink url="http://download.cloud.com.s3.amazonaws.com/tools/vhd-util";>vhd-util</ulink>, which was removed due to licensing issues. You'll copy vhd-util to the <filename>scripts/vm/hypervisor/xenserver/</filename> directory.</para> - </listitem> - <listitem> - <para>Once you have all the dependencies copied over, you'll be able to build &PRODUCT; with the <command>nonoss</command> option:</para> - <programlisting language="Bash"> - <prompt>$</prompt> mvn clean - <prompt>$</prompt> mvn install -Dnonoss - </programlisting> - </listitem> - <listitem> - <para>Once you've built &PRODUCT; with the <command>nonoss</command> profile, you can package it using the <xref linkend="sect-source-buildrpm" /> or <xref linkend="sect-source-builddebs" /> instructions.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/build-rpm.xml ---------------------------------------------------------------------- diff --git a/en-US/build-rpm.xml b/en-US/build-rpm.xml deleted file mode 100644 index 86cff1b..0000000 --- a/en-US/build-rpm.xml +++ /dev/null @@ -1,96 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - -http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -<section id="sect-source-buildrpm"> - <title>Building RPMs from Source</title> - <para>As mentioned previously in <xref linkend="sect-source-prereq" />, you will need to install several prerequisites before you can build packages for &PRODUCT;. Here we'll assume you're working with a 64-bit build of CentOS or Red Hat Enterprise Linux.</para> - <para><programlisting># yum groupinstall "Development Tools"</programlisting></para> - <para><programlisting># yum install java-1.6.0-openjdk-devel.x86_64 genisoimage mysql mysql-server ws-commons-util MySQL-python tomcat6 createrepo</programlisting></para> - <para>Next, you'll need to install build-time dependencies for CloudStack with - Maven. We're using Maven 3, so you'll want to - <ulink url="http://maven.apache.org/download.cgi";>grab a Maven 3 tarball</ulink> - and uncompress it in your home directory (or whatever location you prefer):</para> - <para><programlisting>$ tar zxvf apache-maven-3.0.4-bin.tar.gz</programlisting></para> - <para><programlisting>$ export PATH=/usr/local/apache-maven-3.0.4//bin:$PATH</programlisting></para> - <para>Maven also needs to know where Java is, and expects the JAVA_HOME environment - variable to be set:</para> - <para><programlisting>$ export JAVA_HOME=/usr/lib/jvm/jre-1.6.0-openjdk.x86_64/</programlisting></para> - <para>Verify that Maven is installed correctly:</para> - <para><programlisting>$ mvn --version</programlisting></para> - <para>You probably want to ensure that your environment variables will survive a logout/reboot. - Be sure to update <filename>~/.bashrc</filename> with the PATH and JAVA_HOME variables.</para> - - <para>Building RPMs for &PRODUCT; is fairly simple. Assuming you already have the source downloaded and have uncompressed the tarball into a local directory, you're going to be able to generate packages in just a few minutes.</para> - <note><title>Packaging has Changed</title> - <para>If you've created packages for &PRODUCT; previously, you should be aware that the process has changed considerably since the project has moved to using Apache Maven. Please be sure to follow the steps in this section closely.</para> - </note> - <section id="generating-rpms"> - <title>Generating RPMS</title> - <para>Now that we have the prerequisites and source, you will cd to the <filename>packaging/centos63/</filename> directory.</para> - <programlisting><prompt>$</prompt> cd packaging/centos63</programlisting> - <para>Generating RPMs is done using the <filename>package.sh</filename> script: - <programlisting><prompt>$</prompt>./package.sh</programlisting> - </para> - <para>That will run for a bit and then place the finished packages in <filename>dist/rpmbuild/RPMS/x86_64/</filename>.</para> - <para>You should see the following RPMs in that directory: </para> - <programlisting> - cloudstack-agent-4.2.0.el6.x86_64.rpm - cloudstack-awsapi-4.2.0.el6.x86_64.rpm - cloudstack-cli-4.2.0.el6.x86_64.rpm - cloudstack-common-4.2.0.el6.x86_64.rpm - cloudstack-docs-4.2.0.el6.x86_64.rpm - cloudstack-management-4.2.0.el6.x86_64.rpm - cloudstack-usage-4.2.0.el6.x86_64.rpm - </programlisting> - <section id="sect-source-buildrpm-repo"> - <title>Creating a yum repo</title> - <para> - While RPMs is a useful packaging format - it's most easily consumed from Yum repositories over a network. The next step is to create a Yum Repo with the finished packages: - <programlisting><prompt>$</prompt> mkdir -p ~/tmp/repo</programlisting> - <programlisting><prompt>$</prompt> cp dist/rpmbuild/RPMS/x86_64/*rpm ~/tmp/repo/</programlisting> - <programlisting><prompt>$</prompt> createrepo ~/tmp/repo</programlisting> - </para> - <para> - The files and directories within <filename>~/tmp/repo</filename> can now be uploaded to a web server and serve as a yum repository. - </para> - </section> - <section id="sect-source-buildrpm-repo2"> - <title>Configuring your systems to use your new yum repository</title> - <para> - Now that your yum repository is populated with RPMs and metadata - we need to configure the machines that need to install &PRODUCT;. - Create a file named <filename>/etc/yum.repos.d/cloudstack.repo</filename> with this information: - <programlisting> - [apache-cloudstack] - name=Apache CloudStack - baseurl=http://<replaceable>webserver.tld/path/to/repo</replaceable> - enabled=1 - gpgcheck=0 - </programlisting> - </para> - <para> Completing this step will allow you to easily install &PRODUCT; on a number of machines across the network. - </para> - </section> - </section> - </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-devcloud.xml ---------------------------------------------------------------------- diff --git a/en-US/building-devcloud.xml b/en-US/building-devcloud.xml deleted file mode 100644 index f3c4d19..0000000 --- a/en-US/building-devcloud.xml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="building-devcloud"> - <title>Building DevCloud</title> - <para>The DevCloud appliance can be downloaded from the wiki at <ulink url="https://cwiki.apache.org/confluence/display/CLOUDSTACK/DevCloud";></ulink>. It can also be built from scratch. Code is being developed to provide this alternative build. It is based on <emphasis>veewee</emphasis>, <emphasis>Vagrant</emphasis> and <emphasis>Puppet</emphasis>.</para> - <para>The goal is to automate the DevCloud build and make this automation capability available to all within the source release of &PRODUCT;</para> - <warning><para>This is under heavy development. The code is located in the source tree under <emphasis>tools/devcloud</emphasis> </para> - <para>A preliminary wiki page describes the build at <ulink url="https://cwiki.apache.org/confluence/display/CLOUDSTACK/Building+DevCloud";>https://cwiki.apache.org/confluence/display/CLOUDSTACK/Building+DevCloud</ulink></para> - </warning> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-documentation.xml ---------------------------------------------------------------------- diff --git a/en-US/building-documentation.xml b/en-US/building-documentation.xml deleted file mode 100644 index 8ee63b0..0000000 --- a/en-US/building-documentation.xml +++ /dev/null @@ -1,40 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="building-documentation"> - <title>Building &PRODUCT; Documentation</title> - <para>To build a specific guide, go to the source tree of the documentation in /docs and identify the guide you want to build.</para> - <para>Currently there are four guides plus the release notes, all defined in publican configuration files:</para> - <programlisting> - publican-adminguide.cfg - publican-devguide.cfg - publican-installation.cfg - publican-plugin-niciranvp.cfg - publican-release-notes.cfg - </programlisting> - <para>To build the Developer guide for example, do the following:</para> - <programlisting>publican build --config=publican-devguide.cfg --formats=pdf --langs=en-US</programlisting> - <para>A pdf file will be created in tmp/en-US/pdf, you may choose to build the guide in a different format like html. In that case just replace the format value.</para> - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-marvin.xml ---------------------------------------------------------------------- diff --git a/en-US/building-marvin.xml b/en-US/building-marvin.xml deleted file mode 100644 index e33c4cb..0000000 --- a/en-US/building-marvin.xml +++ /dev/null @@ -1,46 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="building-marvin"> - <title>Building and Installing Marvin</title> - <para>Marvin is built with Maven and is dependent on APIdoc. To build it do the following in the root tree of &PRODUCT;:</para> - <programlisting>mvn -P developer -pl :cloud-apidoc</programlisting> - <programlisting>mvn -P developer -pl :cloud-marvin</programlisting> - <para>If successful the build will have created the cloudstackAPI Python package under tools/marvin/marvin/cloudstackAPI as well as a gziped Marvin package under tools/marvin dist. To install the Python Marvin module do the following in tools/marvin:</para> - <programlisting>sudo python ./setup.py install</programlisting> - <para>The dependencies will be downloaded the Python module installed and you should be able to use Marvin in Python. Check that you can import the module before starting to use it.</para> - <programlisting>$ python -Python 2.7.3 (default, Nov 17 2012, 19:54:34) -[GCC 4.2.1 Compatible Apple Clang 4.1 ((tags/Apple/clang-421.11.66))] on darwin -Type "help", "copyright", "credits" or "license" for more information. ->>> import marvin ->>> from marvin.cloudstackAPI import * ->>> </programlisting> - - <para>You could also install it using <emphasis>pip</emphasis> or <emphasis>easy_install</emphasis> using the local distribution package in tools/marvin/dist :</para> - <programlisting>pip install tools/marvin/dist/Marvin-0.1.0.tar.gz</programlisting> - <para>Or:</para> - <programlisting>easy_install tools/marvin/dist/Marvin-0.1.0.tar.gz</programlisting> - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-prerequisites.xml ---------------------------------------------------------------------- diff --git a/en-US/building-prerequisites.xml b/en-US/building-prerequisites.xml deleted file mode 100644 index d97ca40..0000000 --- a/en-US/building-prerequisites.xml +++ /dev/null @@ -1,66 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - - -<section id="build-prerequisites"> - <title>Build Procedure Prerequisites</title> - <para>In this section we will assume that you are using the Ubuntu Linux distribution with the Advanced Packaging Tool (APT). If you are using a different distribution or OS and a different packaging tool, adapt the following instructions to your environment. To build &PRODUCT; you will need:</para> - <itemizedlist> - <listitem> - <para>git, <ulink url="http://git-scm.com";>http://git-scm.com</ulink></para> - <para><programlisting>sudo apt-get install git-core</programlisting></para> - </listitem> - <listitem> - <para>maven, <ulink url="http://maven.apache.org";>http://maven.apache.org</ulink></para> - <para><programlisting>sudo apt-get install maven</programlisting></para> - <para>Make sure that you installed maven 3</para> - <para><programlisting>$ mvn --version -Apache Maven 3.0.4 -Maven home: /usr/share/maven -Java version: 1.6.0_24, vendor: Sun Microsystems Inc. -Java home: /usr/lib/jvm/java-6-openjdk-amd64/jre -Default locale: en_US, platform encoding: UTF-8 -OS name: "linux", version: "3.2.0-33-generic", arch: "amd64", family: "unix"</programlisting></para> - </listitem> - <listitem> - <para>java</para> - <para>set the JAVA_HOME environment variable</para> - <para><programlisting>$ export JAVA_HOME=/usr/lib/jvm/java-6-openjdk</programlisting></para> - </listitem> - </itemizedlist> - - <para>In addition, to deploy and run &PRODUCT; in a development environment you will need:</para> - <itemizedlist> - <listitem> - <para>Mysql</para> - <para><programlisting>sudo apt-get install mysql-server-5.5</programlisting></para> - <para>Start the mysqld service and create a cloud user with cloud as a password</para> - </listitem> - <listitem> - <para>Tomcat 6</para> - <para><programlisting>sudo apt-get install tomcat6</programlisting></para> - </listitem> - </itemizedlist> - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-translation.xml ---------------------------------------------------------------------- diff --git a/en-US/building-translation.xml b/en-US/building-translation.xml deleted file mode 100644 index dd66365..0000000 --- a/en-US/building-translation.xml +++ /dev/null @@ -1,75 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="building-translation"> - <title>Translating &PRODUCT; Documentation</title> - <para>Now that you know how to build the documentation with Publican, let's move on to building it in different languages. Publican helps us - build the documentation in various languages by using Portable Object Template (POT) files and Portable Objects (PO) files for each language. - </para> - <para>The POT files are generated by parsing all the DocBook files in the language of origin, en-US for us, and creating a long list of strings - for each file that needs to be translated. The translation can be done by hand directly in the PO files of each target language or via the - transifex service. - </para> - <note> - <para><ulink url="http://www.transifex.com";>Transifex</ulink> is a free service to help translate documents and organize distributed teams - of translators. Anyone interested in helping with the translation should get an account on Transifex - </para> - <para> - Three &PRODUCT; projects exist on Transifex. It is recommended to tour those projects to become familiar with Transifex: - <itemizedlist> - <listitem><para><ulink url="https://www.transifex.com/projects/p/ACS_DOCS/";>https://www.transifex.com/projects/p/ACS_DOCS/</ulink></para></listitem> - <listitem><para><ulink url="https://www.transifex.com/projects/p/ACS_Runbook/";>https://www.transifex.com/projects/p/ACS_Runbook/</ulink></para></listitem> - <listitem><para><ulink url="https://www.transifex.com/projects/p/CloudStack_UI/";>https://www.transifex.com/projects/p/CloudStackUI/</ulink></para></listitem> - </itemizedlist> - </para> - </note> - <warning> - <para>The pot directory should already exist in the source tree. If you want to build an up to date translation, you might have to update it to include any pot file that was not previously generated.</para> - <para>To register new resources on transifex, you will need to be an admin of the transifex &PRODUCT; site. Send an email to the developer list if you want access.</para> - </warning> - <para>First we need to generate the .pot files for all the DocBook xml files needed for a particular guide. This is well explained at the publican website in a section on - how to <ulink url="http://rlandmann.fedorapeople.org/pug/sect-Users_Guide-Preparing_a_document_for_translation.html";>prepare</ulink> a document for translation.</para> - <para>The basic command to execute to build the pot files for the developer guide is:</para> - <programlisting>publican update_pot --config=publican-devguide.cfg</programlisting> - <para>This will create a pot directory with pot files in it, one for each corresponding xml files needed to build the guide. Once generated, all pots files need to be configured for translation using transifex this is best done by using the transifex client that you can install with the following command (For RHEL and its derivatives):</para> - <programlisting>yum install transifex-client</programlisting> - <para>The transifex client is also available via PyPi and you can install it like this:</para> - <programlisting>easy_install transifex-client</programlisting> - <para>Once you have installed the transifex client you can run the <emphasis>settx.sh</emphasis> script in the <emphasis>docs</emphasis> directory. This will create the <emphasis>.tx/config</emphasis> file used by transifex to push and pull all translation strings.</para> - <para>All the resource files need to be uploaded to transifex, this is done with the transifex client like so:</para> - <programlisting>tx push -s</programlisting> - <para>Once the translators have completed translation of the documentation, the translated strings can be pulled from transifex like so:</para> - <programlisting>tx pull -a</programlisting> - <para>If you wish to push specific resource files or pull specific languages translation strings, you can do so with the transifex client. A complete documentation of - the client is available on the <ulink url="http://help.transifex.com/features/client/";>client</ulink> website</para> - <para>When you pull new translation strings a directory will be created corresponding to the language of the translation. This directory will contain PO files that will be used by Publican to create the documentation in that specific language. For example assuming that you pull the French translation whose language code is fr-FR, you will build the documentation with publican:</para> - <programlisting>publican build --config=publican-devguide.cfg --formats=html --langs=fr-FR</programlisting> - <warning> - <para> - Some languages like Chinese or Japanese will not render well in pdf format and html should be used. - </para> - </warning> - <xi:include href="translating-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-with-maven-deploy.xml ---------------------------------------------------------------------- diff --git a/en-US/building-with-maven-deploy.xml b/en-US/building-with-maven-deploy.xml deleted file mode 100644 index e4b9801..0000000 --- a/en-US/building-with-maven-deploy.xml +++ /dev/null @@ -1,39 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="building-with-maven-deploy"> - <title>Deployment and Testing Steps</title> - <para>Deploying the &PRODUCT; code that you compiled is a two step process:</para> - <orderedlist> - <listitem><para>If you have not configured the database or modified its properties do:</para> - <para><programlisting>mvn -P developer -pl developer -Ddeploydb</programlisting></para> - </listitem> - <listitem><para>Then you need to run the &PRODUCT; management server. To attach a debugger to it, do:</para> - <para><programlisting>export MAVEN_OPTS="-Xmx1024 -Xdebug -Xrunjdwp:transport=dt_socket,address=8787,server=y,suspend=n"</programlisting></para> - <para><programlisting>mvn -pl :cloud-client-ui jetty:run</programlisting></para> - </listitem> - </orderedlist> - <warning><para>When dealing with the database, remember that you may wipe it entirely and lose any data center configuration that you may have set previously.</para></warning> -</section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-with-maven-steps.xml ---------------------------------------------------------------------- diff --git a/en-US/building-with-maven-steps.xml b/en-US/building-with-maven-steps.xml deleted file mode 100644 index 1c15bfa..0000000 --- a/en-US/building-with-maven-steps.xml +++ /dev/null @@ -1,33 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<section id="building-with-maven-steps"> - <title>Building Steps</title> - <para>&PRODUCT; uses git for source version control, first make sure you have the source code by pulling it:</para> - <programlisting>git clone https://git-wip-us.apache.org/repos/asf/cloudstack.git</programlisting> - <para>Several Project Object Models (POM) are defined to deal with the various build targets of &PRODUCT;. Certain features require some packages that are not compatible with the Apache license and therefore need to be downloaded on your own. Check the wiki for additional information <ulink url="https://cwiki.apache.org/CLOUDSTACK/building-with-maven.html";>https://cwiki.apache.org/CLOUDSTACK/building-with-maven.html</ulink>. In order to build all the open source targets of &PRODUCT; do:</para> - <para><programlisting>mvn clean install</programlisting></para> - <para>The resulting jar files will be in the target directory of the subdirectory of the compiled module.</para> -</section> - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/building-with-maven.xml ---------------------------------------------------------------------- diff --git a/en-US/building-with-maven.xml b/en-US/building-with-maven.xml deleted file mode 100644 index 5363b1d..0000000 --- a/en-US/building-with-maven.xml +++ /dev/null @@ -1,32 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ -<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent"> -%BOOK_ENTITIES; -]> - -<!-- Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -<chapter id="building-with-maven"> - <title>Using Maven to Build &PRODUCT;</title> - <xi:include href="source-build.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="building-prerequisites.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="building-with-maven-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="building-with-maven-deploy.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</chapter> -
