http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/create-vpn-connection-vpc.xml ---------------------------------------------------------------------- diff --git a/en-US/create-vpn-connection-vpc.xml b/en-US/create-vpn-connection-vpc.xml deleted file mode 100644 index 521b8b8..0000000 --- a/en-US/create-vpn-connection-vpc.xml +++ /dev/null @@ -1,136 +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="create-vpn-connection-vpc"> - <title>Creating a VPN Connection</title> - <note> - <para>&PRODUCT; supports creating up to 8 VPN connections.</para> - </note> - <para/> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user.</para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPC.</para> - <para>All the VPCs that you create for the account are listed in the page.</para> - </listitem> - <listitem> - <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para> - <para>The VPC page is displayed where all the tiers you created are listed in a - diagram.</para> - </listitem> - <listitem> - <para>Click the Settings icon.</para> - <para>For each tier, the following options are displayed:</para> - <itemizedlist> - <listitem> - <para>Internal LB</para> - </listitem> - <listitem> - <para>Public LB IP</para> - </listitem> - <listitem> - <para>Static NAT</para> - </listitem> - <listitem> - <para>Virtual Machines</para> - </listitem> - <listitem> - <para>CIDR</para> - </listitem> - </itemizedlist> - <para>The following router information is displayed:</para> - <itemizedlist> - <listitem> - <para>Private Gateways</para> - </listitem> - <listitem> - <para>Public IP Addresses</para> - </listitem> - <listitem> - <para>Site-to-Site VPNs</para> - </listitem> - <listitem> - <para>Network ACL Lists</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Select Site-to-Site VPN.</para> - <para>The Site-to-Site VPN page is displayed.</para> - </listitem> - <listitem> - <para>From the Select View drop-down, ensure that VPN Connection is selected.</para> - </listitem> - <listitem> - <para>Click Create VPN Connection.</para> - <para> The Create VPN Connection dialog is displayed:</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/create-vpn-connection.png"/> - </imageobject> - <textobject> - <phrase>createvpnconnection.png: creating a VPN connection to the customer - gateway.</phrase> - </textobject> - </mediaobject> - </listitem> - <listitem> - <para>Select the desired customer gateway.</para> - </listitem> - <listitem> - <para>Select Passive if you want to establish a connection between two VPC virtual - routers.</para> - <para>If you want to establish a connection between two VPC virtual routers, select Passive - only on one of the VPC virtual routers, which waits for the other VPC virtual router to initiate - the connection. Do not select Passive on the VPC virtual router that initiates the - connection.</para> - </listitem> - <listitem> - <para>Click OK to confirm.</para> - <para>Within a few moments, the VPN Connection is displayed.</para> - <para>The following information on the VPN connection is displayed:</para> - <itemizedlist> - <listitem> - <para>IP Address</para> - </listitem> - <listitem> - <para>Gateway</para> - </listitem> - <listitem> - <para>State</para> - </listitem> - <listitem> - <para>IPSec Preshared Key</para> - </listitem> - <listitem> - <para>IKE Policy</para> - </listitem> - <listitem> - <para>ESP Policy</para> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> -</section>
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/create-vpn-customer-gateway.xml ---------------------------------------------------------------------- diff --git a/en-US/create-vpn-customer-gateway.xml b/en-US/create-vpn-customer-gateway.xml deleted file mode 100644 index e4df6e2..0000000 --- a/en-US/create-vpn-customer-gateway.xml +++ /dev/null @@ -1,191 +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="create-vpn-customer-gateway"> - <title>Creating and Updating a VPN Customer Gateway</title> - <note> - <para>A VPN customer gateway can be connected to only one VPN gateway at a time.</para> - </note> - <para>To add a VPN Customer Gateway:</para> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user. </para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPN Customer Gateway.</para> - </listitem> - <listitem> - <para>Click Add VPN Customer Gateway.</para> - <mediaobject> - <imageobject> - <imagedata fileref="./images/add-vpn-customer-gateway.png"/> - </imageobject> - <textobject> - <phrase>addvpncustomergateway.png: adding a customer gateway.</phrase> - </textobject> - </mediaobject> - <para>Provide the following information:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name</emphasis>: A unique name for the VPN customer gateway - you create.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Gateway</emphasis>: The IP address for the remote - gateway.</para> - </listitem> - <listitem> - <para><emphasis role="bold">CIDR list</emphasis>: The guest CIDR list of the remote - subnets. Enter a CIDR or a comma-separated list of CIDRs. Ensure that a guest CIDR list - is not overlapped with the VPCâs CIDR, or another guest CIDR. The CIDR must be - RFC1918-compliant.</para> - </listitem> - <listitem> - <para><emphasis role="bold">IPsec Preshared Key</emphasis>: Preshared keying is a method - where the endpoints of the VPN share a secret key. This key value is used to - authenticate the customer gateway and the VPC VPN gateway to each other. </para> - <note> - <para>The IKE peers (VPN end points) authenticate each other by computing and sending a - keyed hash of data that includes the Preshared key. If the receiving peer is able to - create the same hash independently by using its Preshared key, it knows that both - peers must share the same secret, thus authenticating the customer gateway.</para> - </note> - </listitem> - <listitem> - <para><emphasis role="bold">IKE Encryption</emphasis>: The Internet Key Exchange (IKE) - policy for phase-1. The supported encryption algorithms are AES128, AES192, AES256, and - 3DES. Authentication is accomplished through the Preshared Keys.</para> - <note> - <para>The phase-1 is the first phase in the IKE process. In this initial negotiation - phase, the two VPN endpoints agree on the methods to be used to provide security for - the underlying IP traffic. The phase-1 authenticates the two VPN gateways to each - other, by confirming that the remote gateway has a matching Preshared Key.</para> - </note> - </listitem> - <listitem> - <para><emphasis role="bold">IKE Hash</emphasis>: The IKE hash for phase-1. The supported - hash algorithms are SHA1 and MD5.</para> - </listitem> - <listitem> - <para><emphasis role="bold">IKE DH</emphasis>: A public-key cryptography protocol which - allows two parties to establish a shared secret over an insecure communications channel. - The 1536-bit Diffie-Hellman group is used within IKE to establish session keys. The - supported options are None, Group-5 (1536-bit) and Group-2 (1024-bit).</para> - </listitem> - <listitem> - <para><emphasis role="bold">ESP Encryption</emphasis>: Encapsulating Security Payload - (ESP) algorithm within phase-2. The supported encryption algorithms are AES128, AES192, - AES256, and 3DES.</para> - <note> - <para>The phase-2 is the second phase in the IKE process. The purpose of IKE phase-2 is - to negotiate IPSec security associations (SA) to set up the IPSec tunnel. In phase-2, - new keying material is extracted from the Diffie-Hellman key exchange in phase-1, to - provide session keys to use in protecting the VPN data flow.</para> - </note> - </listitem> - <listitem> - <para><emphasis role="bold">ESP Hash</emphasis>: Encapsulating Security Payload (ESP) hash - for phase-2. Supported hash algorithms are SHA1 and MD5.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Perfect Forward Secrecy</emphasis>: Perfect Forward Secrecy - (or PFS) is the property that ensures that a session key derived from a set of long-term - public and private keys will not be compromised. This property enforces a new - Diffie-Hellman key exchange. It provides the keying material that has greater key - material life and thereby greater resistance to cryptographic attacks. The available - options are None, Group-5 (1536-bit) and Group-2 (1024-bit). The security of the key - exchanges increase as the DH groups grow larger, as does the time of the - exchanges.</para> - <note> - <para>When PFS is turned on, for every negotiation of a new phase-2 SA the two gateways - must generate a new set of phase-1 keys. This adds an extra layer of protection that - PFS adds, which ensures if the phase-2 SAâs have expired, the keys used for new - phase-2 SAâs have not been generated from the current phase-1 keying material.</para> - </note> - </listitem> - <listitem> - <para><emphasis role="bold">IKE Lifetime (seconds)</emphasis>: The phase-1 lifetime of the - security association in seconds. Default is 86400 seconds (1 day). Whenever the time - expires, a new phase-1 exchange is performed.</para> - </listitem> - <listitem> - <para><emphasis role="bold">ESP Lifetime (seconds)</emphasis>: The phase-2 lifetime of the - security association in seconds. Default is 3600 seconds (1 hour). Whenever the value is - exceeded, a re-key is initiated to provide a new IPsec encryption and authentication - session keys.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Dead Peer Detection</emphasis>: A method to detect an - unavailable Internet Key Exchange (IKE) peer. Select this option if you want the virtual - router to query the liveliness of its IKE peer at regular intervals. Itâs recommended to - have the same configuration of DPD on both side of VPN connection.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click OK.</para> - </listitem> - </orderedlist> - <formalpara> - <title>Updating and Removing a VPN Customer Gateway</title> - <para>You can update a customer gateway either with no VPN connection, or related VPN connection - is in error state.</para> - </formalpara> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user. </para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPN Customer Gateway.</para> - </listitem> - <listitem> - <para>Select the VPN customer gateway you want to work with.</para> - </listitem> - <listitem> - <para>To modify the required parameters, click the Edit VPN Customer Gateway button<inlinemediaobject> - <imageobject> - <imagedata fileref="./images/edit-icon.png"/> - </imageobject> - <textobject> - <phrase>edit.png: button to edit a VPN customer gateway</phrase> - </textobject> - </inlinemediaobject></para> - </listitem> - <listitem> - <para>To remove the VPN customer gateway, click the Delete VPN Customer Gateway button<inlinemediaobject> - <imageobject> - <imagedata fileref="./images/delete-button.png"/> - </imageobject> - <textobject> - <phrase>delete.png: button to remove a VPN customer gateway</phrase> - </textobject> - </inlinemediaobject></para> - </listitem> - <listitem> - <para>Click OK.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/create-vpn-gateway-for-vpc.xml ---------------------------------------------------------------------- diff --git a/en-US/create-vpn-gateway-for-vpc.xml b/en-US/create-vpn-gateway-for-vpc.xml deleted file mode 100644 index 1104d69..0000000 --- a/en-US/create-vpn-gateway-for-vpc.xml +++ /dev/null @@ -1,94 +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="create-vpn-gateway-for-vpc"> - <title>Creating a VPN gateway for the VPC</title> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as an administrator or end user.</para> - </listitem> - <listitem> - <para>In the left navigation, choose Network.</para> - </listitem> - <listitem> - <para>In the Select view, select VPC.</para> - <para>All the VPCs that you have created for the account is listed in the page.</para> - </listitem> - <listitem> - <para>Click the Configure button of the VPC to which you want to deploy the VMs.</para> - <para>The VPC page is displayed where all the tiers you created are listed in a diagram. </para> - <para>For each tier, the following options are displayed:</para> - <itemizedlist> - <listitem> - <para>Internal LB</para> - </listitem> - <listitem> - <para>Public LB IP</para> - </listitem> - <listitem> - <para>Static NAT</para> - </listitem> - <listitem> - <para>Virtual Machines</para> - </listitem> - <listitem> - <para>CIDR</para> - </listitem> - </itemizedlist> - <para>The following router information is displayed:</para> - <itemizedlist> - <listitem> - <para>Private Gateways</para> - </listitem> - <listitem> - <para>Public IP Addresses</para> - </listitem> - <listitem> - <para>Site-to-Site VPNs</para> - </listitem> - <listitem> - <para>Network ACL Lists</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Select Site-to-Site VPN.</para> - <para>If you are creating the VPN gateway for the first time, selecting Site-to-Site VPN - prompts you to create a VPN gateway.</para> - </listitem> - <listitem> - <para>In the confirmation dialog, click Yes to confirm.</para> - <para>Within a few moments, the VPN gateway is created. You will be prompted to view the - details of the VPN gateway you have created. Click Yes to confirm.</para> - <para>The following details are displayed in the VPN Gateway page:</para> - <itemizedlist> - <listitem> - <para>IP Address</para> - </listitem> - <listitem> - <para>Account</para> - </listitem> - <listitem> - <para>Domain</para> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/create-vr-network-offering.xml ---------------------------------------------------------------------- diff --git a/en-US/create-vr-network-offering.xml b/en-US/create-vr-network-offering.xml deleted file mode 100644 index 317e3c2..0000000 --- a/en-US/create-vr-network-offering.xml +++ /dev/null @@ -1,108 +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="create-vr-network-offering"> - <title>Creating and Changing a Virtual Router Network Offering</title> - <para>To create the network offering in association with a virtual router system service - offering:</para> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as a user or admin.</para> - </listitem> - <listitem> - <para>First, create a system service offering, for example: VRsystemofferingHA.</para> - <para>For more information on creating a system service offering, see <xref - linkend="creating-system-service-offerings"/>.</para> - </listitem> - <listitem> - <para>From the Select Offering drop-down, choose Network Offering.</para> - </listitem> - <listitem> - <para>Click Add Network Offering.</para> - </listitem> - <listitem> - <para>In the dialog, make the following choices:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name</emphasis>. Any desired name for the network - offering.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Description</emphasis>. A short description of the offering - that can be displayed to users.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Network Rate</emphasis>. Allowed data transfer rate in MB per - second.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Traffic Type</emphasis>. The type of network traffic that will - be carried on the network.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Guest Type</emphasis>. Choose whether the guest network is - isolated or shared. For a description of these terms, see <xref - linkend="about-virtual-networks"/>.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Specify VLAN</emphasis>. (Isolated guest networks only) - Indicate whether a VLAN should be specified when this offering is used.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Supported Services</emphasis>. Select one or more of the - possible network services. For some services, you must also choose the service provider; - for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or - any other load balancers that have been configured in the cloud. Depending on which - services you choose, additional fields may appear in the rest of the dialog box. For - more information, see <xref linkend="creating-network-offerings"/></para> - </listitem> - <listitem> - <para><emphasis role="bold">System Offering</emphasis>. Choose the system service offering - that you want virtual routers to use in this network. In this case, the default âSystem - Offering For Software Routerâ and the custom âVRsystemofferingHAâ are available and - displayed.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click OK and the network offering is created.</para> - </listitem> - </orderedlist> - <para>To change the network offering of a guest network to the virtual router service - offering:</para> - <orderedlist> - <listitem> - <para>Select Network from the left navigation pane.</para> - </listitem> - <listitem> - <para>Select the guest network that you want to offer this network service to.</para> - </listitem> - <listitem> - <para>Click the Edit button.</para> - </listitem> - <listitem> - <para>From the Network Offering drop-down, select the virtual router network offering you have - just created.</para> - </listitem> - <listitem> - <para>Click OK.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/create-windows-template.xml ---------------------------------------------------------------------- diff --git a/en-US/create-windows-template.xml b/en-US/create-windows-template.xml deleted file mode 100644 index d02f067..0000000 --- a/en-US/create-windows-template.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="create-windows-template"> - <title>Creating a Windows Template</title> - <para>Windows templates must be prepared with Sysprep before they can be provisioned on multiple machines. Sysprep allows you to create a generic Windows template and avoid any possible SID conflicts.</para> - <note><para>(XenServer) Windows VMs running on XenServer require PV drivers, which may be provided in the template or added after the VM is created. The PV drivers are necessary for essential management functions such as mounting additional volumes and ISO images, live migration, and graceful shutdown.</para> - </note> - <para></para> - <para>An overview of the procedure is as follows:</para> - <orderedlist> - <listitem><para>Upload your Windows ISO.</para> <para>For more information, see <xref linkend="add-iso"/>.</para></listitem> - <listitem><para>Create a VM Instance with this ISO.</para><para> For more information, see <xref linkend="creating-vms"/>.</para></listitem> - <listitem><para>Follow the steps in Sysprep for Windows Server 2008 R2 (below) or Sysprep for Windows Server 2003 R2, depending on your version of Windows Server</para></listitem> - <listitem><para>The preparation steps are complete. Now you can actually create the template as described in Creating the Windows Template.</para></listitem> - </orderedlist> - <xi:include href="sysprep-windows-server-2008R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - <xi:include href="sysprep-for-windows-server-2003R2.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> - </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-a-plugin.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-a-plugin.xml b/en-US/creating-a-plugin.xml deleted file mode 100644 index 448d4e6..0000000 --- a/en-US/creating-a-plugin.xml +++ /dev/null @@ -1,29 +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="plugin-development"> - <title>Plugin Development</title> - <para>This chapter will detail different elements related to the development of plugins within Cloudstack</para> - <xi:include href="creating-my-first-plugin.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> -</chapter> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-compute-offerings.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-compute-offerings.xml b/en-US/creating-compute-offerings.xml deleted file mode 100644 index b10ef00..0000000 --- a/en-US/creating-compute-offerings.xml +++ /dev/null @@ -1,163 +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="creating-compute-offerings"> - <title>Creating a New Compute Offering</title> - <para>To create a new compute offering:</para> - <orderedlist> - <listitem> - <para>Log in with admin privileges to the &PRODUCT; UI.</para> - </listitem> - <listitem> - <para>In the left navigation bar, click Service Offerings.</para> - </listitem> - <listitem> - <para>In Select Offering, choose Compute Offering.</para> - </listitem> - <listitem> - <para>Click Add Compute Offering.</para> - </listitem> - <listitem> - <para>In the dialog, make the following choices:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name</emphasis>: Any desired name for the service - offering.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Description</emphasis>: A short description of the offering - that can be displayed to users</para> - </listitem> - <listitem> - <para><emphasis role="bold">Storage type</emphasis>: The type of disk that should be - allocated. Local allocates from storage attached directly to the host where the system - VM is running. Shared allocates from storage accessible via NFS.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Custom</emphasis>: Custom compute offerings can be used in - following cases: deploying a VM, changing the compute offering of a stopped VM and - running VMs, which is nothing but scaling up.</para> - <para>If the Custom field is checked, the end-user must fill in the desired values for - number of CPU, CPU speed, and RAM Memory when using a custom compute offering. When you - check this box, those three input fields are hidden in the dialog box. </para> - </listitem> - <listitem> - <para><emphasis role="bold"># of CPU cores</emphasis>: The number of cores which should be - allocated to a system VM with this offering. If Custom is checked, this field does not - appear.</para> - </listitem> - <listitem> - <para><emphasis role="bold">CPU (in MHz)</emphasis>: The CPU speed of the cores that the - system VM is allocated. For example, â2000â would provide for a 2 GHz clock. If Custom - is checked, this field does not appear.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Memory (in MB)</emphasis>: The amount of memory in megabytes - that the system VM should be allocated. For example, â2048â would provide for a 2 GB RAM - allocation. If Custom is checked, this field does not appear.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Network Rate</emphasis>: Allowed data transfer rate in MB per - second.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Disk Read Rate</emphasis>: Allowed disk read rate in bits per - second.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Disk Write Rate</emphasis>: Allowed disk write rate in bits - per second.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Disk Read Rate</emphasis>: Allowed disk read rate in IOPS - (input/output operations per second).</para> - </listitem> - <listitem> - <para><emphasis role="bold">Disk Write Rate</emphasis>: Allowed disk write rate in IOPS - (input/output operations per second).</para> - </listitem> - <listitem> - <para><emphasis role="bold">Offer HA</emphasis>: If yes, the administrator can choose to - have the system VM be monitored and as highly available as possible.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Storage Tags</emphasis>: The tags that should be associated - with the primary storage used by the system VM.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Host Tags</emphasis>: (Optional) Any tags that you use to - organize your hosts</para> - </listitem> - <listitem> - <para><emphasis role="bold">CPU cap</emphasis>: Whether to limit the level of CPU usage - even if spare capacity is available.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Public</emphasis>: Indicate whether the service offering - should be available all domains or only some domains. Choose Yes to make it available to - all domains. Choose No to limit the scope to a subdomain; &PRODUCT; will then prompt for - the subdomain's name.</para> - </listitem> - <listitem> - <para><emphasis role="bold">isVolatile</emphasis>: If checked, VMs created from this - service offering will have their root disks reset upon reboot. This is useful for secure - environments that need a fresh start on every boot and for desktops that should not - retain state.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Deployment Planner</emphasis>: Choose the technique that you - would like &PRODUCT; to use when deploying VMs based on this service offering.</para> - <para>First Fit places new VMs on the first host that is found having sufficient capacity - to support the VM's requirements.</para> - <para>User Dispersing makes the best effort to evenly distribute VMs belonging to the same - account on different clusters or pods.</para> - <para>User Concentrated prefers to deploy VMs belonging to the same account within a - single pod.</para> - <para>Implicit Dedication will deploy VMs on private infrastructure that is dedicated to a - specific domain or account. If you choose this planner, then you must also pick a value - for Planner Mode. <phrase condition="admin">See <xref - linkend="dedicated-host-cluster-pod"/>.</phrase> - <phrase condition="install">See Dedicating Resources to Accounts and Domains in the - Administration Guide.</phrase></para> - <para>Bare Metal is used with bare metal hosts. <phrase condition="admin">See Bare Metal - Installation in the Installation Guide.</phrase> - <phrase condition="install">See <xref linkend="baremetal-install"/>.</phrase></para> - </listitem> - <listitem> - <para><emphasis role="bold">Planner Mode</emphasis>: Used when ImplicitDedicationPlanner - is selected in the previous field. The planner mode determines how VMs will be deployed - on private infrastructure that is dedicated to a single domain or account.</para> - <para>Strict: A host will not be shared across multiple accounts. For example, strict - implicit dedication is useful for deployment of certain types of applications, such as - desktops, where no host can be shared between different accounts without violating the - desktop software's terms of license.</para> - <para>Preferred: The VM will be deployed in dedicated infrastructure if possible. - Otherwise, the VM can be deployed in shared infrastructure.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click Add.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-disk-offerings.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-disk-offerings.xml b/en-US/creating-disk-offerings.xml deleted file mode 100644 index 627311e..0000000 --- a/en-US/creating-disk-offerings.xml +++ /dev/null @@ -1,48 +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="creating-disk-offerings"> - <title>Creating a New Disk Offering</title> - <para>To create a new disk offering:</para> - <orderedlist> - <listitem><para>Log in with admin privileges to the &PRODUCT; UI.</para></listitem> - <listitem><para>In the left navigation bar, click Service Offerings.</para></listitem> - <listitem><para>In Select Offering, choose Disk Offering.</para></listitem> - <listitem><para>Click Add Disk Offering.</para></listitem> - <listitem><para>In the dialog, make the following choices:</para> - <itemizedlist> - <listitem><para>Name. Any desired name for the disk offering.</para></listitem> - <listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem> - <listitem><para>Custom Disk Size. If checked, the user can set their own disk size. If not checked, the root administrator must define a value in Disk Size.</para></listitem> - <listitem><para>Disk Size. Appears only if Custom Disk Size is not selected. Define the volume size in GB.</para></listitem> - <listitem><para>QoS Type. Three options: Empty (no Quality of Service), hypervisor (rate limiting enforced on the hypervisor side), and storage (guaranteed minimum and maximum IOPS enforced on the storage side). If leveraging QoS, make sure that the hypervisor or storage system supports this feature.</para></listitem> - <listitem><para>Custom IOPS. If checked, the user can set their own IOPS. If not checked, the root administrator can define values. If the root admin does not set values when using storage QoS, default values are used (the defauls can be overridden if the proper parameters are passed into &PRODUCT; when creating the primary storage in question).</para></listitem> - <listitem><para>Min IOPS. Appears only if storage QoS is to be used. Set a guaranteed minimum number of IOPS to be enforced on the storage side.</para></listitem> - <listitem><para>Max IOPS. Appears only if storage QoS is to be used. Set a maximum number of IOPS to be enforced on the storage side (the system may go above this limit in certain circumstances for short intervals).</para></listitem> - <listitem><para>(Optional)Storage Tags. The tags that should be associated with the primary storage for this disk. Tags are a comma separated list of attributes of the storage. For example "ssd,blue". Tags are also added on Primary Storage. &PRODUCT; matches tags on a disk offering to tags on the storage. If a tag is present on a disk offering that tag (or tags) must also be present on Primary Storage for the volume to be provisioned. If no such primary storage exists, allocation from the disk offering will fail..</para></listitem> - <listitem><para>Public. Indicate whether the service offering should be available all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to a subdomain; &PRODUCT; will then prompt for the subdomain's name.</para></listitem> - </itemizedlist></listitem> - <listitem><para>Click Add.</para></listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-my-first-plugin.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-my-first-plugin.xml b/en-US/creating-my-first-plugin.xml deleted file mode 100644 index 3809fd3..0000000 --- a/en-US/creating-my-first-plugin.xml +++ /dev/null @@ -1,216 +0,0 @@ -<?xml version='1.0' encoding='utf-8'?> -<!-- 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="creating-my-first-plugin"> - <title>Creating my first plugin</title> - <para>This is a brief walk through of creating a simple plugin that adds an additional command to the API to return the message "Hello World".</para> - <section id="letting-cloudstack-know-about-the-plugin"> - <title>Letting Cloudstack know about the plugin</title> - <para>Before we can being we need to tell Cloudstack about the existance of our plugin. In order to do this we are required to edit some files related to the cloud-client-ui module</para> - <orderedlist> - <listitem> - <para>Navigate to the folder called client</para> - </listitem> - <listitem> - <para>Open pom.xml and add a dependency, this will look something like the following: </para> - <example> - <title>client/pom.xml</title> - <programlisting language="XML"><dependency> - <groupId>org.apache.cloudstack</groupId> - <artifactId>cloud-plugin-api-helloworld</artifactId> - <version>${project.version}</version> -</dependency></programlisting> - </example> - </listitem> - <listitem> - <para>Continuing with client as your working directory open up tomcatconf/applicationContext.xml.in</para> - </listitem> - <listitem> - <para>Within this file we must insert a bean to load our class:</para> - <example> - <title>client/tomcatconf/applicationContext.xml.in</title> - <programlisting language="XML"><bean id="helloWorldImpl" class="org.apache.cloudstack.helloworld.HelloWorldImpl" /></programlisting> - </example> - </listitem> - <listitem> - <para>Finally we need to register the additional API commands we add. Again with client as your working directory this is done by modifying tomcatconf/commands.properties.in</para> - </listitem> - <listitem> - <para>Within the file we simply add the names of the API commands we want to create followed by a permission number. 1 = admin, 2 = resource domain admin, 4 = domain admin, 8 = user.</para> - <example> - <title>tomcatconf/commands.properties.in</title> - <programlisting>helloWorld=8</programlisting> - </example> - </listitem> - </orderedlist> - </section> - <section id="creating-the-plugin"> - <title>Creating the plugin</title> - <para>Within the Cloudstack filing structure all plugins live under the plugins folder. Since the sample plugin for this document is going to be API related it will live in plugins/api/helloworld. Along with this we will need a standard maven package layout, so lets create all the required folders:</para> - <programlisting language="Bash">$ mkdir -p plugins/api/helloworld/{src,target,test} -$ mkdir -p plugins/api/helloworld/src/org/apache/cloudstack/{api,helloworld} -$ mkdir -p plugins/api/helloworld/src/org/apache/cloudstack/api/{command,response} -$ mkdir -p plugins/api/helloworld/src/org/apache/cloudstack/api/command/user/helloworld</programlisting> - <para>With helloworld as our working directory we should have a tree layout like the following:</para> - <programlisting language="Bash">$ cd plugins/api/helloworld -$ tree -. -|-- src -| `-- org -| `-- apache -| `-- cloudstack -| |-- api -| | |-- command -| | | `-- user -| | | `-- helloworld -| | |-- response -| `-- helloworld -|-- target -`-- test - -12 directories, 0 files</programlisting> - <para>First we will create a pom.xml for our plugin:</para> - <example> - <title>plugins/api/helloworld/pom.xml</title> - <programlisting language="XML"><project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> - <modelVersion>4.0.0</modelVersion> - <artifactId>cloud-plugin-api-helloworld</artifactId> - <name>Apache CloudStack Plugin - Hello World Plugin</name> - <parent> - <groupId>org.apache.cloudstack</groupId> - <artifactId>cloudstack-plugins</artifactId> - <version>4.2.0-SNAPSHOT</version> - <relativePath>../../pom.xml</relativePath> - </parent> - <dependencies> - <dependency> - <groupId>org.apache.cloudstack</groupId> - <artifactId>cloud-api</artifactId> - <version>${project.version}</version> - </dependency> - <dependency> - <groupId>org.apache.cloudstack</groupId> - <artifactId>cloud-utils</artifactId> - <version>${project.version}</version> - </dependency> - </dependencies> - <build> - <defaultGoal>install</defaultGoal> - <sourceDirectory>src</sourceDirectory> - <testSourceDirectory>test</testSourceDirectory> - </build> -</project></programlisting> - </example> - <para>Next we need to make the root plugin pom aware of our plugin to do this simply edit plugins/pom.xml inserting a line like the following:</para> - <programlisting language="XML">...... -<module>api/helloworld</module> -......</programlisting> - <para>Finally we will being to create code for your plugin. Create an interface called HelloWorld that will extend PluggableService within src/org/apache/cloudstack/hellowold</para> - <programlisting language="Java">package org.apache.cloudstack.helloworld; - -import com.cloud.utils.component.PluggableService; - -public interface HelloWorld extends PluggableService { }</programlisting> - <para>Create an implementation of HelloWorld called HelloWorldImpl:</para> - <programlisting language="Java">package org.apache.cloudstack.helloworld; - -import org.apache.cloudstack.api.command.user.helloworld.HelloWorldCmd; -import org.apache.log4j.Logger; -import org.springframework.stereotype.Component; - -import javax.ejb.Local; -import java.util.*; - -@Component -@Local(value = HelloWorld.class) -public class HelloWorldImpl implements HelloWorld { - private static final Logger s_logger = Logger.getLogger(HelloWorldImpl.class); - - public HelloWorldImpl() { - super(); - } - /** - * This informs cloudstack of the API commands you are creating. - */ - @Override - public List<Class<?>> getCommands() { - List<Class<?>> cmdList = new ArrayList<Class<?>>(); - cmdList.add(HelloWorldCmd.class); - return cmdList; - } -}</programlisting> - <para>Next we will create our API command navigate to src/org/apache/cloudstack/api/command/user/helloworld and open up HelloWorldCmd.java, create it as follows</para> - <programlisting language="Java">package org.apache.cloudstack.api.command.user.helloworld; - -import org.apache.cloudstack.api.APICommand; -import org.apache.cloudstack.api.BaseCmd; -import org.apache.cloudstack.api.response.HelloWorldResponse; -import org.apache.log4j.Logger; - -// Note this name matches the name you inserted into client/tomcatconf/commands.properties.in -@APICommand(name = "helloWorld", responseObject = HelloWorldResponse.class, description = "Returns a hello world message", since = "4.2.0") -public class HelloWorldCmd extends BaseCmd { - public static final Logger s_logger = Logger.getLogger(HelloWorldCmd.class.getName()); - private static final String s_name = "helloworldresponse"; - - @Override - public void execute() - { - HelloWorldResponse response = new HelloWorldResponse(); - response.setObjectName("helloworld"); - response.setResponseName(getCommandName()); - this.setResponseObject(response); - } - - @Override - public String getCommandName() { - return s_name; - } - - @Override - public long getEntityOwnerId() { - return 0; - } -}</programlisting> - <para>Finally we need to create our HelloWorldResponse class, this will exist within src/org/apache/cloudstack/api/response/</para> - <programlisting language="Java">package org.apache.cloudstack.api.response; - -import com.google.gson.annotations.SerializedName; -import org.apache.cloudstack.api.BaseResponse; -import com.cloud.serializer.Param; - -@SuppressWarnings("unused") -public class HelloWorldResponse extends BaseResponse { - @SerializedName("HelloWorld") @Param(description="HelloWorld Response") - private String HelloWorld; - - public HelloWorldResponse(){ - this.HelloWorld = "Hello World"; - } -}</programlisting> - </section> - <section id="compiling-your-plugin"> - <title>Compiling your plugin:</title> - <para>Within the directory of your plugin i.e. plugins/api/helloworld run mvn clean install.</para> - <para>After this we need to recompile the client-cloud-ui to do this come back to the cloudstack base directory and execute mvn -pl client clean install</para> - </section> - <section id="starting-cloudstack-and-testing"> - <title>Starting Cloudstack and Testing:</title> - <para>Start up cloudstack with the normal mvn pl :client-cloud-ui jetty:run, wait a few moments for it to start up then head over to: localhost:8096/client/api?command=helloWorld and you should see your HelloWorld message.</para> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-network-offerings.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-network-offerings.xml b/en-US/creating-network-offerings.xml deleted file mode 100644 index 4f75781..0000000 --- a/en-US/creating-network-offerings.xml +++ /dev/null @@ -1,285 +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="creating-network-offerings"> - <title>Creating a New Network Offering</title> - <para>To create a network offering:</para> - <orderedlist> - <listitem> - <para>Log in with admin privileges to the &PRODUCT; UI.</para> - </listitem> - <listitem> - <para>In the left navigation bar, click Service Offerings.</para> - </listitem> - <listitem> - <para>In Select Offering, choose Network Offering.</para> - </listitem> - <listitem> - <para>Click Add Network Offering.</para> - </listitem> - <listitem> - <para>In the dialog, make the following choices:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name</emphasis>. Any desired name for the network - offering.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Description</emphasis>. A short description of the offering - that can be displayed to users.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Network Rate</emphasis>. Allowed data transfer rate in MB per - second.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Guest Type</emphasis>. Choose whether the guest network is - isolated or shared. </para> - <para condition="admin">For a description of this term, see <xref - linkend="about-virtual-networks"/>.</para> - <para condition="install">For a description of this term, see the Administration Guide. - </para> - </listitem> - <listitem> - <para><emphasis role="bold">Persistent</emphasis>. Indicate whether the guest network is - persistent or not. The network that you can provision without having to deploy a VM on - it is termed persistent network. For more information, see <xref - linkend="persistent-network"/>.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Specify VLAN</emphasis>. (Isolated guest networks only) - Indicate whether a VLAN could be specified when this offering is used. If you select - this option and later use this network offering while creating a VPC tier or an isolated - network, you will be able to specify a VLAN ID for the network you create.</para> - </listitem> - <listitem> - <para><emphasis role="bold">VPC</emphasis>. This option indicate whether the guest network - is Virtual Private Cloud-enabled. A Virtual Private Cloud (VPC) is a private, isolated - part of &PRODUCT;. A VPC can have its own virtual network topology that resembles a - traditional physical network. For more information on VPCs, see <xref linkend="vpc"/>.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Supported Services</emphasis>. Select one or more of the - possible network services. For some services, you must also choose the service provider; - for example, if you select Load Balancer, you can choose the &PRODUCT; virtual router or - any other load balancers that have been configured in the cloud. Depending on which - services you choose, additional fields may appear in the rest of the dialog box.</para> - <para>Based on the guest network type selected, you can see the following supported - services:</para> - <informaltable> - <tgroup cols="4" align="left" colsep="1" rowsep="1"> - <thead> - <row> - <entry><para>Supported Services</para></entry> - <entry><para>Description</para></entry> - <entry><para>Isolated</para></entry> - <entry><para>Shared</para></entry> - </row> - </thead> - <tbody> - <row> - <entry><para>DHCP</para></entry> - <entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>DNS</para></entry> - <entry><para>For more information, see <xref linkend="dns-dhcp"/>.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Load Balancer</para></entry> - <entry><para>If you select Load Balancer, you can choose the &PRODUCT; virtual - router or any other load balancers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Firewall</para></entry> - <entry><para condition="install">For more information, see <xref - linkend="firewall-rules"/>.</para> - <para condition="admin">For more information, see the Administration - Guide.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Source NAT</para></entry> - <entry><para>If you select Source NAT, you can choose the &PRODUCT; virtual router - or any other Source NAT providers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Static NAT</para></entry> - <entry><para>If you select Static NAT, you can choose the &PRODUCT; virtual router - or any other Static NAT providers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Port Forwarding</para></entry> - <entry><para>If you select Port Forwarding, you can choose the &PRODUCT; virtual - router or any other Port Forwarding providers that have been configured in the - cloud.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Not Supported</para></entry> - </row> - <row> - <entry><para>VPN</para></entry> - <entry><para>For more information, see <xref linkend="vpn"/>.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Not Supported</para></entry> - </row> - <row> - <entry><para>User Data</para></entry> - <entry><para condition="admin">For more information, see <xref - linkend="user-data-and-meta-data"/>.</para> - <para condition="install">For more information, see the Administration - Guide.</para></entry> - <entry><para>Not Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - <row> - <entry><para>Network ACL</para></entry> - <entry><para>For more information, see <xref linkend="configure-acl" - />.</para></entry> - <entry><para>Supported</para></entry> - <entry><para>Not Supported</para></entry> - </row> - <row> - <entry><para>Security Groups</para></entry> - <entry><para>For more information, see <xref linkend="add-security-group" - />.</para></entry> - <entry><para>Not Supported</para></entry> - <entry><para>Supported</para></entry> - </row> - </tbody> - </tgroup> - </informaltable> - </listitem> - <listitem> - <para><emphasis role="bold">System Offering</emphasis>. If the service provider for any of - the services selected in Supported Services is a virtual router, the System Offering - field appears. Choose the system service offering that you want virtual routers to use - in this network. For example, if you selected Load Balancer in Supported Services and - selected a virtual router to provide load balancing, the System Offering field appears - so you can choose between the &PRODUCT; default system service offering and any custom - system service offerings that have been defined by the &PRODUCT; root - administrator.</para> - <para condition="admin">For more information, see <xref linkend="system-service-offerings"/>.</para> - <para condition="install">For more information, see the Administration Guide.</para> - </listitem> - <listitem> - <para><emphasis role="bold">LB Isolation</emphasis>: Specify what type of load balancer - isolation you want for the network: Shared or Dedicated.</para> - <para><emphasis role="bold">Dedicated</emphasis>: If you select dedicated LB isolation, a - dedicated load balancer device is assigned for the network from the pool of dedicated - load balancer devices provisioned in the zone. If no sufficient dedicated load balancer - devices are available in the zone, network creation fails. Dedicated device is a good - choice for the high-traffic networks that make full use of the device's - resources.</para> - <para><emphasis role="bold">Shared</emphasis>: If you select shared LB isolation, a shared - load balancer device is assigned for the network from the pool of shared load balancer - devices provisioned in the zone. While provisioning &PRODUCT; picks the shared load - balancer device that is used by the least number of accounts. Once the device reaches - its maximum capacity, the device will not be allocated to a new account.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Mode</emphasis>: You can select either Inline mode or Side by - Side mode:</para> - <para><emphasis role="bold">Inline mode</emphasis>: Supported only for Juniper SRX - firewall and BigF5 load balancer devices. In inline mode, a firewall device is placed in - front of a load balancing device. The firewall acts as the gateway for all the incoming - traffic, then redirect the load balancing traffic to the load balancer behind it. The - load balancer in this case will not have the direct access to the public network. </para> - <para><emphasis role="bold">Side by Side</emphasis>: In side by side mode, a firewall - device is deployed in parallel with the load balancer device. So the traffic to the load - balancer public IP is not routed through the firewall, and therefore, is exposed to the - public network.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Associate Public IP</emphasis>: Select this option if you want - to assign a public IP address to the VMs deployed in the guest network. This option is - available only if</para> - <itemizedlist> - <listitem> - <para>Guest network is shared.</para> - </listitem> - <listitem> - <para>StaticNAT is enabled.</para> - </listitem> - <listitem> - <para>Elastic IP is enabled.</para> - </listitem> - </itemizedlist> - <para>For information on Elastic IP, see <xref linkend="elastic-ip"/>.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Redundant router capability</emphasis>: Available only when - Virtual Router is selected as the Source NAT provider. Select this option if you want to - use two virtual routers in the network for uninterrupted connection: one operating as - the master virtual router and the other as the backup. The master virtual router - receives requests from and sends responses to the userâs VM. The backup virtual router - is activated only when the master is down. After the failover, the backup becomes the - master virtual router. &PRODUCT; deploys the routers on different hosts to ensure - reliability if one host is down.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Conserve mode</emphasis>: Indicate whether to use conserve - mode. In this mode, network resources are allocated only when the first virtual machine - starts in the network. When conservative mode is off, the public IP can only be used for - a single service. For example, a public IP used for a port forwarding rule cannot be - used for defining other services, such as StaticNAT or load balancing. When the conserve - mode is on, you can define more than one service on the same public IP.</para> - <note> - <para>If StaticNAT is enabled, irrespective of the status of the conserve mode, no port - forwarding or load balancing rule can be created for the IP. However, you can add the - firewall rules by using the createFirewallRule command.</para> - </note> - </listitem> - <listitem> - <para><emphasis role="bold">Tags</emphasis>: Network tag to specify which physical network - to use.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Default egress policy</emphasis>: Configure the default policy - for firewall egress rules. Options are Allow and Deny. Default is Allow if no egress - policy is specified, which indicates that all the egress traffic is accepted when a - guest network is created from this offering. </para> - <para>To block the egress traffic for a guest network, select Deny. In this case, when you - configure an egress rules for an isolated guest network, rules are added to allow the - specified traffic.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click Add.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-new-volumes.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-new-volumes.xml b/en-US/creating-new-volumes.xml deleted file mode 100644 index 5440dc5..0000000 --- a/en-US/creating-new-volumes.xml +++ /dev/null @@ -1,84 +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="creating-new-volumes"> - <title>Creating a New Volume</title> - <para>You can add more data disk volumes to a guest VM at any time, up to the limits of your - storage capacity. Both &PRODUCT; administrators and users can add volumes to VM instances. When - you create a new volume, it is stored as an entity in &PRODUCT;, but the actual storage - resources are not allocated on the physical storage device until you attach the volume. This - optimization allows the &PRODUCT; to provision the volume nearest to the guest that will use it - when the first attachment is made.</para> - <section id="local-storage-data-volumes"> - <title>Using Local Storage for Data Volumes</title> - <para>You can create data volumes on local storage (supported with XenServer, KVM, and VMware). - The data volume is placed on the same host as the VM instance that is attached to the data - volume. These local data volumes can be attached to virtual machines, detached, re-attached, - and deleted just as with the other types of data volume.</para> - <para>Local storage is ideal for scenarios where persistence of data volumes and HA is not - required. Some of the benefits include reduced disk I/O latency and cost reduction from using - inexpensive local disks.</para> - <para>In order for local volumes to be used, the feature must be enabled for the zone.</para> - <para>You can create a data disk offering for local storage. When a user creates a new VM, they - can select this disk offering in order to cause the data disk volume to be placed in local - storage.</para> - <para>You can not migrate a VM that has a volume in local storage to a different host, nor - migrate the volume itself away to a different host. If you want to put a host into maintenance - mode, you must first stop any VMs with local data volumes on that host.</para> - </section> - <section id="creating-new-volume-steps"> - <title>To Create a New Volume</title> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as a user or admin.</para> - </listitem> - <listitem> - <para>In the left navigation bar, click Storage.</para> - </listitem> - <listitem> - <para>In Select View, choose Volumes.</para> - </listitem> - <listitem> - <para>To create a new volume, click Add Volume, provide the following details, and click - OK.</para> - <itemizedlist> - <listitem> - <para>Name. Give the volume a unique name so you can find it later.</para> - </listitem> - <listitem> - <para>Availability Zone. Where do you want the storage to reside? This should be close - to the VM that will use the volume.</para> - </listitem> - <listitem> - <para>Disk Offering. Choose the characteristics of the storage.</para> - </listitem> - </itemizedlist> - <para>The new volume appears in the list of volumes with the state âAllocated.â The volume - data is stored in &PRODUCT;, but the volume is not yet ready for use</para> - </listitem> - <listitem> - <para>To start using the volume, continue to Attaching a Volume </para> - </listitem> - </orderedlist> - </section> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-shared-network.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-shared-network.xml b/en-US/creating-shared-network.xml deleted file mode 100644 index e6a018f..0000000 --- a/en-US/creating-shared-network.xml +++ /dev/null @@ -1,132 +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="creating-shared-network"> - <title>Configuring a Shared Guest Network</title> - <orderedlist> - <listitem> - <para>Log in to the &PRODUCT; UI as administrator.</para> - </listitem> - <listitem> - <para>In the left navigation, choose Infrastructure.</para> - </listitem> - <listitem> - <para>On Zones, click View More.</para> - </listitem> - <listitem> - <para>Click the zone to which you want to add a guest network.</para> - </listitem> - <listitem> - <para>Click the Physical Network tab.</para> - </listitem> - <listitem> - <para>Click the physical network you want to work with.</para> - </listitem> - <listitem> - <para>On the Guest node of the diagram, click Configure.</para> - </listitem> - <listitem> - <para>Click the Network tab.</para> - </listitem> - <listitem> - <para>Click Add guest network.</para> - <para>The Add guest network window is displayed.</para> - </listitem> - <listitem> - <para>Specify the following:</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Name</emphasis>: The name of the network. This will be visible - to the user.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Description</emphasis>: The short description of the network - that can be displayed to users.</para> - </listitem> - <listitem> - <para><emphasis role="bold">VLAN ID</emphasis>: The unique ID of the VLAN.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Isolated VLAN ID</emphasis>: The unique ID of the Secondary - Isolated VLAN. </para> - </listitem> - <listitem> - <para><emphasis role="bold">Scope</emphasis>: The available scopes are Domain, Account, - Project, and All.</para> - <itemizedlist> - <listitem> - <para><emphasis role="bold">Domain</emphasis>: Selecting Domain limits the scope of - this guest network to the domain you specify. The network will not be available for - other domains. If you select Subdomain Access, the guest network is available to all - the sub domains within the selected domain.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Account</emphasis>: The account for which the guest - network is being created for. You must specify the domain the account belongs - to.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Project</emphasis>: The project for which the guest - network is being created for. You must specify the domain the project belongs - to.</para> - </listitem> - <listitem> - <para><emphasis role="bold">All</emphasis>: The guest network is available for all the - domains, account, projects within the selected zone. </para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para><emphasis role="bold">Network Offering</emphasis>: If the administrator has - configured multiple network offerings, select the one you want to use for this - network.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Gateway</emphasis>: The gateway that the guests should - use.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Netmask</emphasis>: The netmask in use on the subnet the - guests will use.</para> - </listitem> - <listitem> - <para><emphasis role="bold">IP Range</emphasis>: A range of IP addresses that are - accessible from the Internet and are assigned to the guest VMs.</para> - <para>If one NIC is used, these IPs should be in the same CIDR in the case of IPv6.</para> - </listitem> - <listitem> - <para><emphasis role="bold">IPv6 CIDR</emphasis>: The network prefix that defines the - guest network subnet. This is the CIDR that describes the IPv6 addresses in use in the - guest networks in this zone. To allot IP addresses from within a particular address - block, enter a CIDR.</para> - </listitem> - <listitem> - <para><emphasis role="bold">Network Domain</emphasis>: A custom DNS suffix at the level of - a network. If you want to assign a special domain name to the guest VM network, specify - a DNS suffix.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Click OK to confirm.</para> - </listitem> - </orderedlist> -</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/creating-system-service-offerings.xml ---------------------------------------------------------------------- diff --git a/en-US/creating-system-service-offerings.xml b/en-US/creating-system-service-offerings.xml deleted file mode 100644 index e33d9d0..0000000 --- a/en-US/creating-system-service-offerings.xml +++ /dev/null @@ -1,53 +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="creating-system-service-offerings"> - <title>Creating a New System Service Offering</title> - <para>To create a system service offering:</para> - <orderedlist> - <listitem><para>Log in with admin privileges to the &PRODUCT; UI.</para></listitem> - <listitem><para>In the left navigation bar, click Service Offerings.</para></listitem> - <listitem><para>In Select Offering, choose System Offering.</para></listitem> - <listitem><para>Click Add System Service Offering.</para></listitem> - <listitem><para>In the dialog, make the following choices:</para> - <itemizedlist> - <listitem><para>Name. Any desired name for the system offering.</para></listitem> - <listitem><para>Description. A short description of the offering that can be displayed to users</para></listitem> - <listitem><para>System VM Type. Select the type of system virtual machine that this offering is intended to support.</para></listitem> - <listitem><para>Storage type. The type of disk that should be allocated. Local allocates from storage attached directly to the host where the system VM is running. Shared allocates from storage accessible via NFS.</para></listitem> - <listitem><para># of CPU cores. The number of cores which should be allocated to a system VM with this offering</para></listitem> - <listitem><para>CPU (in MHz). The CPU speed of the cores that the system VM is allocated. For example, "2000" would provide for a 2 GHz clock.</para></listitem> - <listitem><para>Memory (in MB). The amount of memory in megabytes that the system VM should be allocated. For example, "2048" would provide for a 2 GB RAM allocation.</para></listitem> - <listitem><para>Network Rate. Allowed data transfer rate in MB per second.</para></listitem> - <listitem><para>Offer HA. If yes, the administrator can choose to have the system VM be monitored and as highly available as possible.</para></listitem> - <listitem><para>Storage Tags. The tags that should be associated with the primary storage used by the system VM.</para></listitem> - <listitem><para>Host Tags. (Optional) Any tags that you use to organize your hosts</para></listitem> - <listitem><para>CPU cap. Whether to limit the level of CPU usage even if spare capacity is available.</para></listitem> - <listitem><para>Public. Indicate whether the service offering should be available all domains or only some domains. Choose Yes to make it available to all domains. Choose No to limit the scope to a subdomain; &PRODUCT; will then prompt for the subdomain's name.</para></listitem> - </itemizedlist></listitem> - <listitem><para>Click Add.</para></listitem> - </orderedlist> - - -</section>
