Appending a Display Name to the Guest VM’s Internal Name

Reply-To: dev@cloudstack.apache.org Delivered-To: mailing list commits@cloudstack.apache.org Received: (qmail 78969 invoked by uid 99); 1 Oct 2015 14:04:12 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 01 Oct 2015 14:04:12 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id B86E1E1549; Thu, 1 Oct 2015 14:04:12 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: sebgoa@apache.org To: commits@cloudstack.apache.org Date: Thu, 01 Oct 2015 14:04:53 -0000 Message-Id: <422e0870b787499eb693caec8f48cc63@git.apache.org> In-Reply-To: <70dce7e46df64989b9cdbc3fddef9604@git.apache.org> References: <70dce7e46df64989b9cdbc3fddef9604@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [43/51] [partial] cloudstack-docs git commit: Remove all old docbook files http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/append-displayname-vms.xml ---------------------------------------------------------------------- diff --git a/en-US/append-displayname-vms.xml b/en-US/append-displayname-vms.xml deleted file mode 100644 index 592a6e8..0000000 --- a/en-US/append-displayname-vms.xml +++ /dev/null @@ -1,84 +0,0 @@ - - -%BOOK_ENTITIES; -]> - -

- Appending a Display Name to the Guest VM’s Internal Name - Every guest VM has an internal name. The host uses the internal name to identify the guest - VMs. &PRODUCT; gives you an option to provide a guest VM with a display name. You can set this - display name as the internal name so that the vCenter can use it to identify the guest VM. A new - global parameter, vm.instancename.flag, has now been added to achieve this functionality. - The default format of the internal name is - i-<user_id>-<vm_id>-<instance.name>, where instance.name is a global - parameter. However, If vm.instancename.flag is set to true, and if a display name is provided - during the creation of a guest VM, the display name is appended to the internal name of the - guest VM on the host. This makes the internal name format as - i-<user_id>-<vm_id>-<displayName>. The default value of vm.instancename.flag - is set to false. This feature is intended to make the correlation between instance names and - internal names easier in large data center deployments. - The following table explains how a VM name is displayed in different scenarios. - - - - - - - - - - User-Provided Display Name - vm.instancename.flag - Hostname on the VM - Name on vCenter - Internal Name - - - - - Yes - True - Display name - i-<user_id>-<vm_id>-displayName - i-<user_id>-<vm_id>-displayName - - - No - True - UUID - i-<user_id>-<vm_id>-<instance.name> - i-<user_id>-<vm_id>-<instance.name> - - - Yes - False - Display name - i-<user_id>-<vm_id>-<instance.name> - i-<user_id>-<vm_id>-<instance.name> - - - No - False - UUID - i-<user_id>-<vm_id>-<instance.name> - i-<user_id>-<vm_id>-<instance.name> - - - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/asynchronous-commands-example.xml ---------------------------------------------------------------------- diff --git a/en-US/asynchronous-commands-example.xml b/en-US/asynchronous-commands-example.xml deleted file mode 100644 index 330f125..0000000 --- a/en-US/asynchronous-commands-example.xml +++ /dev/null @@ -1,106 +0,0 @@ - - -

- Example - - The following shows an example of using an asynchronous command. Assume the API command: - command=deployVirtualMachine&zoneId=1&serviceOfferingId=1&diskOfferingId=1&templateId=1 - - CloudStack will immediately return a job ID and any other additional data. - - <deployvirtualmachineresponse> - <jobid>1</jobid> - <id>100</id> - </deployvirtualmachineresponse> - - Using the job ID, you can periodically poll for the results by using the queryAsyncJobResult command. - command=queryAsyncJobResult&jobId=1 - Three possible results could come from this query. - Job is still pending: - - <queryasyncjobresult> - <jobid>1</jobid> - <jobstatus>0</jobstatus> - <jobprocstatus>1</jobprocstatus> - </queryasyncjobresult> - - Job has succeeded: - - <queryasyncjobresultresponse cloud-stack-version="3.0.1.6"> - <jobid>1</jobid> - <jobstatus>1</jobstatus> - <jobprocstatus>0</jobprocstatus> - <jobresultcode>0</jobresultcode> - <jobresulttype>object</jobresulttype> - <jobresult> - <virtualmachine> - <id>450</id> - <name>i-2-450-VM</name> - <displayname>i-2-450-VM</displayname> - <account>admin</account> - <domainid>1</domainid> - <domain>ROOT</domain> - <created>2011-03-10T18:20:25-0800</created> - <state>Running</state> - <haenable>false</haenable> - <zoneid>1</zoneid> - <zonename>San Jose 1</zonename> - <hostid>2</hostid> - <hostname>905-13.sjc.lab.vmops.com</hostname> - <templateid>1</templateid> - <templatename>CentOS 5.3 64bit LAMP</templatename> - <templatedisplaytext>CentOS 5.3 64bit LAMP</templatedisplaytext> - <passwordenabled>false</passwordenabled> - <serviceofferingid>1</serviceofferingid> - <serviceofferingname>Small Instance</serviceofferingname> - <cpunumber>1</cpunumber> - <cpuspeed>500</cpuspeed> - <memory>512</memory> - <guestosid>12</guestosid> - <rootdeviceid>0</rootdeviceid> - <rootdevicetype>NetworkFilesystem</rootdevicetype> - <nic> - <id>561</id> - <networkid>205</networkid> - <netmask>255.255.255.0</netmask> - <gateway>10.1.1.1</gateway> - <ipaddress>10.1.1.225</ipaddress> - <isolationuri>vlan://295</isolationuri> - <broadcasturi>vlan://295</broadcasturi> - <traffictype>Guest</traffictype> - <type>Virtual</type> - <isdefault>true</isdefault> - </nic> - <hypervisor>XenServer</hypervisor> - </virtualmachine> - </jobresult> - </queryasyncjobresultresponse> - - Job has failed: - - <queryasyncjobresult> - <jobid>1</jobid> - <jobstatus>2</jobstatus> - <jobprocstatus>0</jobprocstatus> - <jobresultcode>551</jobresultcode> - <jobresulttype>text</jobresulttype> - <jobresult>Unable to deploy virtual machine id = 100 due to not enough capacity</jobresult> - </queryasyncjobresult> - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/asynchronous-commands.xml ---------------------------------------------------------------------- diff --git a/en-US/asynchronous-commands.xml b/en-US/asynchronous-commands.xml deleted file mode 100644 index 4c9b59c..0000000 --- a/en-US/asynchronous-commands.xml +++ /dev/null @@ -1,38 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Asynchronous Commands - Asynchronous commands were introduced in &PRODUCT; 2.x. Commands are designated as asynchronous when they can potentially take a long period of time to complete such as creating a snapshot or disk volume. They differ from synchronous commands by the following: - - - They are identified in the API Reference by an (A). - They will immediately return a job ID to refer to the job that will be responsible in processing the command. - If executed as a "create" resource command, it will return the resource ID as well as the job ID. - You can periodically check the status of the job by making a simple API call to the command, queryAsyncJobResult and passing in the job ID. - - - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/attach-iso-to-vm.xml ---------------------------------------------------------------------- diff --git a/en-US/attach-iso-to-vm.xml b/en-US/attach-iso-to-vm.xml deleted file mode 100644 index 8e0d424..0000000 --- a/en-US/attach-iso-to-vm.xml +++ /dev/null @@ -1,40 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - -

- Attaching an ISO to a VM - - In the left navigation, click Instances. - Choose the virtual machine you want to work with. - Click the Attach ISO button. - - - - - iso.png: depicts adding an iso image - - - In the Attach ISO dialog box, select the desired ISO. - Click OK. - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/attaching-volume.xml ---------------------------------------------------------------------- diff --git a/en-US/attaching-volume.xml b/en-US/attaching-volume.xml deleted file mode 100644 index bb9196a..0000000 --- a/en-US/attaching-volume.xml +++ /dev/null @@ -1,61 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - -

- Attaching a Volume - You can attach a volume to a guest VM to provide extra disk storage. Attach a volume when - you first create a new volume, when you are moving an existing volume from one VM to another, or - after you have migrated a volume from one storage pool to another. - - - Log in to the &PRODUCT; UI as a user or admin. - - - In the left navigation, click Storage. - - - In Select View, choose Volumes. - - - Click the volume name in the Volumes list, then click the Attach Disk button - - - - - AttachDiskButton.png: button to attach a volume - - - - - - In the Instance popup, choose the VM to which you want to attach the volume. You will - only see instances to which you are allowed to attach volumes; for example, a user will see - only instances created by that user, but the administrator will have more choices. - - - - When the volume has been attached, you should be able to see it by clicking Instances, - the instance name, and View Volumes. - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/automatic-snapshot-creation-retention.xml ---------------------------------------------------------------------- diff --git a/en-US/automatic-snapshot-creation-retention.xml b/en-US/automatic-snapshot-creation-retention.xml deleted file mode 100644 index 54fbe68..0000000 --- a/en-US/automatic-snapshot-creation-retention.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -%BOOK_ENTITIES; -]> - -

- Automatic Snapshot Creation and Retention - (Supported for the following hypervisors: XenServer, - VMware vSphere, and KVM) - Users can set up a recurring snapshot policy to automatically create multiple snapshots of a - disk at regular intervals. Snapshots can be created on an hourly, daily, weekly, or monthly - interval. One snapshot policy can be set up per disk volume. For example, a user can set up a - daily snapshot at 02:30. - With each snapshot schedule, users can also specify the number of scheduled snapshots to be - retained. Older snapshots that exceed the retention limit are automatically deleted. This - user-defined limit must be equal to or lower than the global limit set by the &PRODUCT; - administrator. See . The limit applies only to those - snapshots that are taken as part of an automatic recurring snapshot policy. Additional manual - snapshots can be created and retained. -

\ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/autoscale.xml ---------------------------------------------------------------------- diff --git a/en-US/autoscale.xml b/en-US/autoscale.xml deleted file mode 100644 index c1f4a33..0000000 --- a/en-US/autoscale.xml +++ /dev/null @@ -1,286 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - -

- Configuring AutoScale - AutoScaling allows you to scale your back-end services or application VMs up or down - seamlessly and automatically according to the conditions you define. With AutoScaling enabled, - you can ensure that the number of VMs you are using seamlessly scale up when demand increases, - and automatically decreases when demand subsides. Thus it helps you save compute costs by - terminating underused VMs automatically and launching new VMs when you need them, without the - need for manual intervention. - NetScaler AutoScaling is designed to seamlessly launch or terminate VMs based on - user-defined conditions. Conditions for triggering a scaleup or scaledown action can vary from a - simple use case like monitoring the CPU usage of a server to a complex use case of monitoring a - combination of server's responsiveness and its CPU usage. For example, you can configure - AutoScaling to launch an additional VM whenever CPU usage exceeds 80 percent for 15 minutes, or - to remove a VM whenever CPU usage is less than 20 percent for 30 minutes. - &PRODUCT; uses the NetScaler load balancer to monitor all aspects of a system's health and - work in unison with &PRODUCT; to initiate scale-up or scale-down actions. - - AutoScale is supported on NetScaler Release 10 Build 74.4006.e and beyond. - - - Prerequisites - Before you configure an AutoScale rule, consider the following: - - - - Ensure that the necessary template is prepared before configuring AutoScale. When a VM - is deployed by using a template and when it comes up, the application should be up and - running. - - If the application is not running, the NetScaler device considers the VM as - ineffective and continues provisioning the VMs unconditionally until the resource limit is - exhausted. - - - - Deploy the templates you prepared. Ensure that the applications come up on the first - boot and is ready to take the traffic. Observe the time requires to deploy the template. - Consider this time when you specify the quiet time while configuring AutoScale. - - - The AutoScale feature supports the SNMP counters that can be used to define conditions - for taking scale up or scale down actions. To monitor the SNMP-based counter, ensure that - the SNMP agent is installed in the template used for creating the AutoScale VMs, and the - SNMP operations work with the configured SNMP community and port by using standard SNMP - managers. For example, see to configure SNMP on a RHEL - machine. - - - Ensure that the endpointe.url parameter present in the Global Settings is set to the - Management Server API URL. For example, http://10.102.102.22:8080/client/api. In a - multi-node Management Server deployment, use the virtual IP address configured in the load - balancer for the management server’s cluster. Additionally, ensure that the NetScaler device - has access to this IP address to provide AutoScale support. - If you update the endpointe.url, disable the AutoScale functionality of the load - balancer rules in the system, then enable them back to reflect the changes. For more - information see - - - If the API Key and Secret Key are regenerated for an AutoScale user, ensure that the - AutoScale functionality of the load balancers that the user participates in are disabled and - then enabled to reflect the configuration changes in the NetScaler. - - - In an advanced Zone, ensure that at least one VM should be present before configuring a - load balancer rule with AutoScale. Having one VM in the network ensures that the network is - in implemented state for configuring AutoScale. - - - - Configuration - Specify the following: - - - - - - - autoscaleateconfig.png: Configuring AutoScale - - - - - Template: A template consists of a base OS image and - application. A template is used to provision the new instance of an application on a scaleup - action. When a VM is deployed from a template, the VM can start taking the traffic from the - load balancer without any admin intervention. For example, if the VM is deployed for a Web - service, it should have the Web server running, the database connected, and so on. - - - Compute offering: A predefined set of virtual hardware - attributes, including CPU speed, number of CPUs, and RAM size, that the user can select when - creating a new virtual machine instance. Choose one of the compute offerings to be used - while provisioning a VM instance as part of scaleup action. - - - Min Instance: The minimum number of active VM instances - that is assigned to a load balancing rule. The active VM instances are the application - instances that are up and serving the traffic, and are being load balanced. This parameter - ensures that a load balancing rule has at least the configured number of active VM instances - are available to serve the traffic. - - If an application, such as SAP, running on a VM instance is down for some reason, the - VM is then not counted as part of Min Instance parameter, and the AutoScale feature - initiates a scaleup action if the number of active VM instances is below the configured - value. Similarly, when an application instance comes up from its earlier down state, this - application instance is counted as part of the active instance count and the AutoScale - process initiates a scaledown action when the active instance count breaches the Max - instance value. - - - - Max Instance: Maximum number of active VM instances - that should be assigned to a load balancing rule. This - parameter defines the upper limit of active VM instances that can be assigned to a load - balancing rule. - Specifying a large value for the maximum instance parameter might result in provisioning - large number of VM instances, which in turn leads to a single load balancing rule exhausting - the VM instances limit specified at the account or domain level. - - If an application, such as SAP, running on a VM instance is down for some reason, the - VM is not counted as part of Max Instance parameter. So there may be scenarios where the - number of VMs provisioned for a scaleup action might be more than the configured Max - Instance value. Once the application instances in the VMs are up from an earlier down - state, the AutoScale feature starts aligning to the configured Max Instance value. - - - - Specify the following scale-up and scale-down policies: - - - Duration: The duration, in seconds, for which the - conditions you specify must be true to trigger a scaleup action. The conditions defined - should hold true for the entire duration you specify for an AutoScale action to be invoked. - - - - Counter: The performance counters expose the state of - the monitored instances. By default, &PRODUCT; offers four performance counters: Three SNMP - counters and one NetScaler counter. The SNMP counters are Linux User CPU, Linux System CPU, - and Linux CPU Idle. The NetScaler counter is ResponseTime. The root administrator can add - additional counters into &PRODUCT; by using the &PRODUCT; API. - - - Operator: The following five relational operators are - supported in AutoScale feature: Greater than, Less than, Less than or equal to, Greater than - or equal to, and Equal to. - - - Threshold: Threshold value to be used for the counter. - Once the counter defined above breaches the threshold value, the AutoScale feature initiates - a scaleup or scaledown action. - - - Add: Click Add to add the condition. - - - Additionally, if you want to configure the advanced settings, click Show advanced settings, - and specify the following: - - - Polling interval: Frequency in which the conditions, - combination of counter, operator and threshold, are to be evaluated before taking a scale up - or down action. The default polling interval is 30 seconds. - - - Quiet Time: This is the cool down period after an - AutoScale action is initiated. The time includes the time taken to complete provisioning a - VM instance from its template and the time taken by an application to be ready to serve - traffic. This quiet time allows the fleet to come up to a stable state before any action can - take place. The default is 300 seconds. - - - Destroy VM Grace Period: The duration in seconds, after - a scaledown action is initiated, to wait before the VM is destroyed as part of scaledown - action. This is to ensure graceful close of any pending sessions or transactions being - served by the VM marked for destroy. The default is 120 seconds. - - - Security Groups: Security groups provide a way to - isolate traffic to the VM instances. A security group is a group of VMs that filter their - incoming and outgoing traffic according to a set of rules, called ingress and egress rules. - These rules filter network traffic according to the IP address that is attempting to - communicate with the VM. - - - Disk Offerings: A predefined set of disk size for - primary data storage. - - - SNMP Community: The SNMP community string to be used by - the NetScaler device to query the configured counter value from the provisioned VM - instances. Default is public. - - - SNMP Port: The port number on which the SNMP agent that - run on the provisioned VMs is listening. Default port is 161. - - - User: This is the user that the NetScaler device use to - invoke scaleup and scaledown API calls to the cloud. If no option is specified, the user who - configures AutoScaling is applied. Specify another user name to override. - - - Apply: Click Apply to create the AutoScale - configuration. - - - - Disabling and Enabling an AutoScale Configuration - If you want to perform any maintenance operation on the AutoScale VM instances, disable - the AutoScale configuration. When the AutoScale configuration is disabled, no scaleup or - scaledown action is performed. You can use this downtime for the maintenance activities. To - disable the AutoScale configuration, click the Disable AutoScale - - - - - EnableDisable.png: button to enable or disable AutoScale. - - button. - - The button toggles between enable and disable, depending on whether AutoScale is currently - enabled or not. After the maintenance operations are done, you can enable the AutoScale - configuration back. To enable, open the AutoScale configuration page again, then click the - Enable AutoScale - - - - - EnableDisable.png: button to enable or disable AutoScale. - - button. - - Updating an AutoScale Configuration - You can update the various parameters and add or delete the conditions in a scaleup or - scaledown rule. Before you update an AutoScale configuration, ensure that you disable the - AutoScale load balancer rule by clicking the Disable AutoScale button. - - After you modify the required AutoScale parameters, click Apply. To apply the new AutoScale - policies, open the AutoScale configuration page again, then click the Enable AutoScale - button. - - Runtime Considerations - - - - - An administrator should not assign a VM to a load balancing rule which is configured for - AutoScale. - - - Before a VM provisioning is completed if NetScaler is shutdown or restarted, the - provisioned VM cannot be a part of the load balancing rule though the intent was to assign - it to a load balancing rule. To workaround, rename the AutoScale provisioned VMs based on - the rule name or ID so at any point of time the VMs can be reconciled to its load balancing - rule. - - - Making API calls outside the context of AutoScale, such as destroyVM, on an autoscaled - VM leaves the load balancing configuration in an inconsistent state. Though VM is destroyed - from the load balancer rule, NetScaler continues to show the VM as a service assigned to a - rule. - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-api-examples.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-api-examples.xml b/en-US/aws-api-examples.xml deleted file mode 100644 index ee3b44a..0000000 --- a/en-US/aws-api-examples.xml +++ /dev/null @@ -1,145 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Examples - There are many tools available to interface with a AWS compatible API. In this section we provide - a few examples that users of &PRODUCT; can build upon. - -

- Boto Examples - Boto is one of them. It is a Python package available at https://github.com/boto/boto. - In this section we provide two examples of Python scripts that use Boto and have been tested with the - &PRODUCT; AWS API Interface. - First is an EC2 example. Replace the Access and Secret Keys with your own and - update the endpoint. - - - An EC2 Boto example - #!/usr/bin/env python - -import sys -import os -import boto -import boto.ec2 - -region = boto.ec2.regioninfo.RegionInfo(name="ROOT",endpoint="localhost") -apikey='GwNnpUPrO6KgIdZu01z_ZhhZnKjtSdRwuYd4DvpzvFpyxGMvrzno2q05MB0ViBoFYtdqKd' -secretkey='t4eXLEYWw7chBhDlaKf38adCMSHx_wlds6JfSx3z9fSpSOm0AbP9Moj0oGIzy2LSC8iw' - -def main(): - '''Establish connection to EC2 cloud''' - conn =boto.connect_ec2(aws_access_key_id=apikey, - aws_secret_access_key=secretkey, - is_secure=False, - region=region, - port=7080, - path="/awsapi", - api_version="2010-11-15") - - '''Get list of images that I own''' - images = conn.get_all_images() - print images - myimage = images[0] - '''Pick an instance type''' - vm_type='m1.small' - reservation = myimage.run(instance_type=vm_type,security_groups=['default']) - -if __name__ == '__main__': - main() - - - - Second is an S3 example. Replace the Access and Secret keys with your own, - as well as the endpoint of the service. Be sure to also update the file paths to something - that exists on your machine. - - - An S3 Boto Example - #!/usr/bin/env python - -import sys -import os -from boto.s3.key import Key -from boto.s3.connection import S3Connection -from boto.s3.connection import OrdinaryCallingFormat - -apikey='ChOw-pwdcCFy6fpeyv6kUaR0NnhzmG3tE7HLN2z3OB_s-ogF5HjZtN4rnzKnq2UjtnHeg_yLA5gOw' -secretkey='IMY8R7CJQiSGFk4cHwfXXN3DUFXz07cCiU80eM3MCmfLs7kusgyOfm0g9qzXRXhoAPCH-IRxXc3w' - -cf=OrdinaryCallingFormat() - -def main(): - '''Establish connection to S3 service''' - conn =S3Connection(aws_access_key_id=apikey,aws_secret_access_key=secretkey, \ - is_secure=False, \ - host='localhost', \ - port=7080, \ - calling_format=cf, \ - path="/awsapi/rest/AmazonS3") - - try: - bucket=conn.create_bucket('cloudstack') - k = Key(bucket) - k.key = 'test' - try: - k.set_contents_from_filename('/Users/runseb/Desktop/s3cs.py') - except: - print 'could not write file' - pass - except: - bucket = conn.get_bucket('cloudstack') - k = Key(bucket) - k.key = 'test' - try: - k.get_contents_to_filename('/Users/runseb/Desktop/foobar') - except: - print 'Could not get file' - pass - - try: - bucket1=conn.create_bucket('teststring') - k=Key(bucket1) - k.key('foobar') - k.set_contents_from_string('This is my silly test') - except: - bucket1=conn.get_bucket('teststring') - k = Key(bucket1) - k.key='foobar' - k.get_contents_as_string() - -if __name__ == '__main__': - main() - - - - -

- -

- JClouds Examples - -

- -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-ec2-configuration.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-ec2-configuration.xml b/en-US/aws-ec2-configuration.xml deleted file mode 100644 index f0f2d0f..0000000 --- a/en-US/aws-ec2-configuration.xml +++ /dev/null @@ -1,109 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Enabling the EC2 and S3 Compatible Interface - - The software that provides AWS API compatibility is installed along with &PRODUCT;. You must enable the services and perform some setup steps prior to using it. - - - Set the global configuration parameters for each service to true. - See . - Create a set of &PRODUCT; service offerings with names that match the Amazon service offerings. - You can do this through the &PRODUCT; UI as described in the Administration Guide. - Be sure you have included the Amazon default service offering, m1.small. As well as any EC2 instance types that you will use. - - If you did not already do so when you set the configuration parameter in step , restart the Management Server. - # service cloudstack-management restart - - - The following sections provides details to perform these steps - -

- Enabling the Services - To enable the EC2 and S3 compatible services you need to set the configuration variables enable.ec2.api - and enable.s3.api to true. You do not have to enable both at the same time. Enable the ones you need. - This can be done via the &PRODUCT; GUI by going in Global Settings or via the API. - The snapshot below shows you how to use the GUI to enable these services - - - - - - - - Use the GUI to set the configuration variable to true - - - - - Using the &PRODUCT; API, the easiest is to use the so-called integration port on which you can make - unauthenticated calls. In Global Settings set the port to 8096 and subsequently call the updateConfiguration method. - The following urls shows you how: - - - - http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true - http://localhost:8096/client/api?command=updateConfiguration&name=enable.ec2.api&value=true - - - - Once you have enabled the services, restart the server. -

- -

- Creating EC2 Compatible Service Offerings - You will also need to define compute service offerings with names compatible with the - Amazon EC2 instance types API names (e.g m1.small,m1.large). This can be done via the &PRODUCT; GUI. - Go under Service Offerings select Compute offering and either create - a new compute offering or modify an existing one, ensuring that the name matches an EC2 instance type API name. The snapshot below shows you how: - - - - - - - Use the GUI to set the name of a compute service offering to an EC2 instance - type API name. - - - -

- Modifying the AWS API Port - - (Optional) The AWS API listens for requests on port 7080. If you prefer AWS API to listen on another port, you can change it as follows: - - Edit the files /etc/cloudstack/management/server.xml, /etc/cloudstack/management/server-nonssl.xml, - and /etc/cloudstack/management/server-ssl.xml. - In each file, find the tag <Service name="Catalina7080">. Under this tag, - locate <Connector executor="tomcatThreadPool-internal" port= ....<. - Change the port to whatever port you want to use, then save the files. - Restart the Management Server. - - If you re-install &PRODUCT;, you will have to re-enable the services and if need be update the port. - -

- -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-ec2-introduction.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-ec2-introduction.xml b/en-US/aws-ec2-introduction.xml deleted file mode 100644 index 4cf071b..0000000 --- a/en-US/aws-ec2-introduction.xml +++ /dev/null @@ -1,53 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Amazon Web Services Compatible Interface - &PRODUCT; can translate Amazon Web Services (AWS) API calls to native &PRODUCT; API calls - so that users can continue using existing AWS-compatible tools. This translation service runs as - a separate web application in the same tomcat server as the management server of &PRODUCT;, - listening on a different port. The Amazon Web Services (AWS) compatible interface provides the - EC2 SOAP and Query APIs as well as the S3 REST API. - - This service was previously enabled by separate software called CloudBridge. It is now - fully integrated with the &PRODUCT; management server. - - - The compatible interface for the EC2 Query API and the S3 API are Work In Progress. The S3 compatible API offers a way to store data on the management server file system, it is not an implementation of the S3 backend. - - Limitations - - - Supported only in zones that use basic networking. - - - Available in fresh installations of &PRODUCT;. Not available through upgrade of previous versions. - - - Features such as Elastic IP (EIP) and Elastic Load Balancing (ELB) are only available in an infrastructure - with a Citrix NetScaler device. Users accessing a Zone with a NetScaler device will need to use a - NetScaler-enabled network offering (DefaultSharedNetscalerEIP and ELBNetworkOffering). - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-ec2-requirements.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-ec2-requirements.xml b/en-US/aws-ec2-requirements.xml deleted file mode 100644 index 62e94b1..0000000 --- a/en-US/aws-ec2-requirements.xml +++ /dev/null @@ -1,36 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Supported API Version - - The EC2 interface complies with Amazon's WDSL version dated November 15, 2010, available at - http://ec2.amazonaws.com/doc/2010-11-15/. - The interface is compatible with the EC2 command-line - tools EC2 tools v. 1.3.6230, which can be downloaded at http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip. - - - Work is underway to support a more recent version of the EC2 API -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-ec2-supported-commands.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-ec2-supported-commands.xml b/en-US/aws-ec2-supported-commands.xml deleted file mode 100644 index 7cdbcad..0000000 --- a/en-US/aws-ec2-supported-commands.xml +++ /dev/null @@ -1,396 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Supported AWS API Calls - The following Amazon EC2 commands are supported by &PRODUCT; when the AWS API compatible interface is enabled. - For a few commands, there are differences between the &PRODUCT; and Amazon EC2 versions, and these differences are noted. The underlying SOAP call for each command is also given, for those who have built tools using those calls. - - - Elastic IP API mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-allocate-address - AllocateAddress - associateIpAddress - - - ec2-associate-address - AssociateAddress - enableStaticNat - - - ec2-describe-addresses - DescribeAddresses - listPublicIpAddresses - - - ec2-diassociate-address - DisassociateAddress - disableStaticNat - - - ec2-release-address - ReleaseAddress - disassociateIpAddress - - - -

- - Availability Zone API mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-describe-availability-zones - DescribeAvailabilityZones - listZones - - - -

- - Images API mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-create-image - CreateImage - createTemplate - - - ec2-deregister - DeregisterImage - DeleteTemplate - - - ec2-describe-images - DescribeImages - listTemplates - - - ec2-register - RegisterImage - registerTemplate - - - -

- - Image Attributes API mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-describe-image-attribute - DescribeImageAttribute - listTemplatePermissions - - - ec2-modify-image-attribute - ModifyImageAttribute - updateTemplatePermissions - - - ec2-reset-image-attribute - ResetImageAttribute - updateTemplatePermissions - - - -

- - Instances API mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-describe-instances - DescribeInstances - listVirtualMachines - - - ec2-run-instances - RunInstances - deployVirtualMachine - - - ec2-reboot-instances - RebootInstances - rebootVirtualMachine - - - ec2-start-instances - StartInstances - startVirtualMachine - - - ec2-stop-instances - StopInstances - stopVirtualMachine - - - ec2-terminate-instances - TerminateInstances - destroyVirtualMachine - - - -

- - Instance Attributes Mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-describe-instance-attribute - DescribeInstanceAttribute - listVirtualMachines - - - -

- - Keys Pairs Mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-add-keypair - CreateKeyPair - createSSHKeyPair - - - ec2-delete-keypair - DeleteKeyPair - deleteSSHKeyPair - - - ec2-describe-keypairs - DescribeKeyPairs - listSSHKeyPairs - - - ec2-import-keypair - ImportKeyPair - registerSSHKeyPair - - - -

- - Passwords API Mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-get-password - GetPasswordData - getVMPassword - - - -

- - Security Groups API Mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-authorize - AuthorizeSecurityGroupIngress - authorizeSecurityGroupIngress - - - ec2-add-group - CreateSecurityGroup - createSecurityGroup - - - ec2-delete-group - DeleteSecurityGroup - deleteSecurityGroup - - - ec2-describe-group - DescribeSecurityGroups - listSecurityGroups - - - ec2-revoke - RevokeSecurityGroupIngress - revokeSecurityGroupIngress - - - -

- - Snapshots API Mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-create-snapshot - CreateSnapshot - createSnapshot - - - ec2-delete-snapshot - DeleteSnapshot - deleteSnapshot - - - ec2-describe-snapshots - DescribeSnapshots - listSnapshots - - - -

- - Volumes API Mapping - - - - - EC2 command - SOAP call - &PRODUCT; API call - - - - - ec2-attach-volume - AttachVolume - attachVolume - - - ec2-create-volume - CreateVolume - createVolume - - - ec2-delete-volume - DeleteVolume - deleteVolume - - - ec2-describe-volume - DescribeVolume - listVolumes - - - ec2-detach-volume - DetachVolume - detachVolume - - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-ec2-timeouts.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-ec2-timeouts.xml b/en-US/aws-ec2-timeouts.xml deleted file mode 100644 index 73d0c16..0000000 --- a/en-US/aws-ec2-timeouts.xml +++ /dev/null @@ -1,51 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - -

- Using Timeouts to Ensure AWS API Command Completion - The Amazon EC2 command-line tools have a default connection timeout. When used with &PRODUCT;, a longer timeout might be needed for some commands. If you find that commands are not completing due to timeouts, you can specify a custom timeouts. You can add the following optional command-line parameters to any &PRODUCT;-supported EC2 command: - - - - - - - --connection-timeout TIMEOUT - Specifies a connection timeout (in seconds). - Example: --connection-timeout 30 - - - - --request-timeout TIMEOUT - Specifies a request timeout (in seconds). - Example: --request-timeout 45 - - - - - - Example: - ec2-run-instances 2 –z us-test1 –n 1-3 --connection-timeout 120 --request-timeout 120 - The timeouts optional arguments are not specific to &PRODUCT;. -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-ec2-user-setup.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-ec2-user-setup.xml b/en-US/aws-ec2-user-setup.xml deleted file mode 100644 index a2d8918..0000000 --- a/en-US/aws-ec2-user-setup.xml +++ /dev/null @@ -1,105 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - -

- AWS API User Setup - In general, users need not be aware that they are using a translation service provided by &PRODUCT;. - They only need to send AWS API calls to &PRODUCT;'s endpoint, and it will translate the calls to the native &PRODUCT; API. Users of the Amazon EC2 compatible interface will be able to keep their existing EC2 tools - and scripts and use them with their &PRODUCT; deployment, by specifying the endpoint of the - management server and using the proper user credentials. In order to do this, each user must - perform the following configuration steps: - - - - Generate user credentials. - - - Register with the service. - - - For convenience, set up environment variables for the EC2 SOAP command-line tools. - - - -

- AWS API User Registration - Each user must perform a one-time registration. The user follows these steps: - - - Obtain the following by looking in the &PRODUCT; UI, using the API, or asking the cloud administrator: - - - The &PRODUCT; server's publicly available DNS name or IP address - The user account's Access key and Secret key - - - - Generate a private key and a self-signed X.509 certificate. The user substitutes their own desired storage location for /path/to/… below. - - - $ openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /path/to/private_key.pem -out /path/to/cert.pem - - - - Register the user X.509 certificate and Access/Secret keys with the AWS compatible service. - If you have the source code of &PRODUCT; go to the awsapi-setup/setup directory and use the Python script - cloudstack-aws-api-register. If you do not have the source then download the script using the following command. - - - wget -O cloudstack-aws-api-register "https://git-wip-us.apache.org/repos/asf?p=cloudstack.git;a=blob_plain;f=awsapi-setup/setup/cloudstack-aws-api-register;hb=4.1" - - - Then execute it, using the access and secret keys that were obtained in step . An example is shown below. - - $ cloudstack-aws-api-register --apikey=User’s &PRODUCT; API key --secretkey=User’s &PRODUCT; Secret key --cert=/path/to/cert.pem --url=http://&PRODUCT;.server:7080/awsapi - - - - - - A user with an existing AWS certificate could choose to use the same certificate with &PRODUCT;, but note that the certificate would be uploaded to the &PRODUCT; management server database. - - -

- AWS API Command-Line Tools Setup - To use the EC2 command-line tools, the user must perform these steps: - - - Be sure you have the right version of EC2 Tools. - The supported version is available at http://s3.amazonaws.com/ec2-downloads/ec2-api-tools-1.3-62308.zip. - - - - Set up the EC2 environment variables. This can be done every time you use the service or you can set them up in the proper shell profile. Replace the endpoint (i.e EC2_URL) with the proper address of your &PRODUCT; management server and port. In a bash shell do the following. - - - $ export EC2_CERT=/path/to/cert.pem - $ export EC2_PRIVATE_KEY=/path/to/private_key.pem - $ export EC2_URL=http://localhost:7080/awsapi - $ export EC2_HOME=/path/to/EC2_tools_directory - - - -

http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/aws-interface-compatibility.xml ---------------------------------------------------------------------- diff --git a/en-US/aws-interface-compatibility.xml b/en-US/aws-interface-compatibility.xml deleted file mode 100644 index 2c85c24..0000000 --- a/en-US/aws-interface-compatibility.xml +++ /dev/null @@ -1,34 +0,0 @@ - - -%BOOK_ENTITIES; -]> - - - - - Amazon Web Services Compatible Interface - - - - - - - - http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/f42520a5/en-US/basic-adv-networking.xml ---------------------------------------------------------------------- diff --git a/en-US/basic-adv-networking.xml b/en-US/basic-adv-networking.xml deleted file mode 100644 index 46f0650..0000000 --- a/en-US/basic-adv-networking.xml +++ /dev/null @@ -1,113 +0,0 @@ - - -%BOOK_ENTITIES; -]> - -

- Basic and Advanced Networking - &PRODUCT; provides two styles of networking:. - - Basic - For AWS-style networking. Provides a single network where guest isolation can be provided - through layer-3 means such as security groups (IP address source filtering). - - - Advanced - For more sophisticated network topologies. This network model provides the most - flexibility in defining guest networks, but requires more configuration steps than basic - networking. - - Each zone has either basic or advanced networking. Once the choice of networking model for a - zone has been made and configured in &PRODUCT;, it can not be changed. A zone is either - basic or advanced for its entire lifetime. - The following table compares the networking features in the two networking models. - - - - - Networking Feature - Basic Network - Advanced Network - - - - - Number of networks - Single network - Multiple networks - - - Firewall type - Physical - Physical and Virtual - - - Load balancer - Physical - Physical and Virtual - - - Isolation type - Layer 3 - Layer 2 and Layer 3 - - - VPN support - No - Yes - - - Port forwarding - Physical - Physical and Virtual - - - 1:1 NAT - Physical - Physical and Virtual - - - Source NAT - No - Physical and Virtual - - - Userdata - Yes - Yes - - - Network usage monitoring - sFlow / netFlow at physical router - Hypervisor and Virtual Router - - - DNS and DHCP - Yes - Yes - - - - - The two types of networking may be in use in the same cloud. However, a given zone must use - either Basic Networking or Advanced Networking. - Different types of network traffic can be segmented on the same physical network. Guest - traffic can also be segmented by account. To isolate traffic, you can use separate VLANs. If you - are using separate VLANs on a single physical network, make sure the VLAN tags are in separate - numerical ranges. -