Просмотр исходного кода

[DOCUMENTATION] English:
- manual fixes

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@16404 44c647ce-9c0f-0410-b52a-842ac1e357ba

mikaelkael 16 лет назад
Родитель
Сommit
6746e4fb8e

+ 85 - 62
documentation/manual/en/module_specs/Zend_Service_Amazon_Ec2-CloudWatch.xml

@@ -5,8 +5,9 @@
     <para>
         Amazon CloudWatch is an easy-to-use web service that provides
         comprehensive monitoring for Amazon Elastic Compute Cloud (Amazon
-        EC2) and Elastic Load Balancing. For more details information
-        check cout the <ulink ulr="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/index.html?SvcIntro.html">
+        <acronym>EC2</acronym>) and Elastic Load Balancing. For more details information
+        check cout the <ulink
+            url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/index.html?SvcIntro.html">
             Amazon CloudWatch Developers Guide</ulink>
     </para>
 
@@ -16,7 +17,7 @@
         <example id="zend.service.amazon.ec2.cloudwatch.usage.list">
             <title>Listing Aviable Metrics</title>
             <para>
-                <code>listMetrics</code> returns a list of up to 500 valid metrics for
+                <methodname>listMetrics()</methodname> returns a list of up to 500 valid metrics for
                 which there is recorded data available to a you and a NextToken string
                 that can be used to query for the next set of results.
             </para>
@@ -30,77 +31,99 @@ $return = $ec2_ebs->listMetrics();
         <example id="zend.service.amazon.ec2.cloudwatch.usage.getmetricstatistics">
             <title>Return Statistics for a given metric</title>
             <para>
-                <code>getMetricStatistics</code> Returns data for one or more
+                <methodname>getMetricStatistics()</methodname> Returns data for one or more
                 statistics of given a metric.
             </para>
-            <note>
-                The maximum number of datapoints that the Amazon CloudWatch service will
-                return in a single GetMetricStatistics request is 1,440. If a request is
-                made that would generate more datapoints than this amount, Amazon CloudWatch
-                will return an error. You can alter your request by narrowing the time range
-                (StartTime, EndTime) or increasing the Period in your single request. You may
-                also get all of the data at the granularity you originally asked for by making
-                multiple requests with adjacent time ranges.
-            </note>
             <para>
-                <code>getMetricStatistics</code> only requires two parameters but it also has four
-                additional parameters that are optional.
-                <itemizedlist>
-                    <listitem>
-                        <emphasis>Required:</emphasis>
-                    </listitem>
-                    <listitem>
+                <note>
+                    <para>
+                        The maximum number of datapoints that the Amazon CloudWatch service will
+                        return in a single GetMetricStatistics request is 1,440. If a request is
+                        made that would generate more datapoints than this amount, Amazon CloudWatch
+                        will return an error. You can alter your request by narrowing the time range
+                        (StartTime, EndTime) or increasing the Period in your single request. You
+                        may also get all of the data at the granularity you originally asked for
+                        by making multiple requests with adjacent time ranges.
+                    </para>
+                </note>
+            </para>
+            <para>
+                <methodname>getMetricStatistics()</methodname> only requires two parameters but it
+                also has four additional parameters that are optional.
+            </para>
+            <itemizedlist>
+                <listitem>
+                    <para><emphasis>Required:</emphasis></para>
+                </listitem>
+                <listitem>
+                    <para>
                         <emphasis>MeasureName</emphasis> The measure name that corresponds to
-                        the measure for the gathered metric. Valid EC2 Values are
+                        the measure for the gathered metric. Valid <acronym>EC2</acronym> Values are
                         CPUUtilization, NetworkIn, NetworkOut, DiskWriteOps
                         DiskReadBytes, DiskReadOps, DiskWriteBytes. Valid Elastic
                         Load Balancing Metrics are Latency, RequestCount, HealthyHostCount
-                        UnHealthyHostCount.  <ulink url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/arch-AmazonCloudWatch-metricscollected.html">
+                        UnHealthyHostCount. <ulink
+                            url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/arch-AmazonCloudWatch-metricscollected.html">
                             For more information click here</ulink>
-                    </listitem>
-                    <listitem>
-                        <emphasis>Statistics</emphasis> The statistics to be returned for the given metric. Valid
-                        values are Average, Maximum, Minimum, Samples, Sum.  You can specify
-                        this as a string or as an array of values.  If you don't specify one
-                        it will default to Average instead of failing out.  If you specify an incorrect
-                        option it will just skip it. <ulink url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/arch-Amazon-CloudWatch-statistics.html">
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <emphasis>Statistics</emphasis> The statistics to be returned for the given
+                        metric. Valid values are Average, Maximum, Minimum, Samples, Sum. You can
+                        specify this as a string or as an array of values. If you don't specify one
+                        it will default to Average instead of failing out. If you specify an
+                        incorrect option it will just skip it. <ulink
+                            url="http://docs.amazonwebservices.com/AmazonCloudWatch/latest/DeveloperGuide/arch-Amazon-CloudWatch-statistics.html">
                             For more information click here</ulink>
-                    </listitem>
-                    <listitem>
-                        <emphasis>Optional:</emphasis>
-                    </listitem>
-                    <listitem>
-                        <emphasis>Dimensions</emphasis> Amazon CloudWatch allows you to specify one Dimension to further filter
-                        metric data on. If you don't specify a dimension, the service returns the aggregate
-                        of all the measures with the given measure name and time range.
-                    </listitem>
-                    <listitem>
-                        <emphasis>Unit</emphasis> The standard unit of Measurement for a given Measure. Valid Values: Seconds,
-                        Percent, Bytes, Bits, Count, Bytes/Second, Bits/Second, Count/Second, and None
-                        Constraints: When using count/second as the unit, you should use Sum as the statistic
-                        instead of Average. Otherwise, the sample returns as equal to the number of requests
-                        instead of the number of 60-second intervals. This will cause the Average to
-                        always equals one when the unit is count/second.
-                    </listitem>
-                    <listitem>
-                        <emphasis>StartTime</emphasis> The timestamp of the first datapoint to return, inclusive. For example,
-                        2008-02-26T19:00:00+00:00. We round your value down to the nearest minute.
-                        You can set your start time for more than two weeks in the past. However,
-                        you will only get data for the past two weeks. (in ISO 8601 format)
-                        Constraints: Must be before EndTime
-                    </listitem>
-                    <listitem>
-                        <emphasis>EndTime</emphasis> The timestamp to use for determining the last datapoint to return. This is
-                        the last datapoint to fetch, exclusive. For example, 2008-02-26T20:00:00+00:00.
-                        (in ISO 8601 format)
-                    </listitem>
-                </itemizedlist>
-            </para>
+                    </para>
+                </listitem>
+                <listitem>
+                    <para><emphasis>Optional:</emphasis></para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <emphasis>Dimensions</emphasis> Amazon CloudWatch allows you to specify one
+                        Dimension to further filter metric data on. If you don't specify a
+                        dimension, the service returns the aggregate of all the measures with the
+                        given measure name and time range.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <emphasis>Unit</emphasis> The standard unit of Measurement for a given
+                        Measure. Valid Values: Seconds, Percent, Bytes, Bits, Count, Bytes/Second,
+                        Bits/Second, Count/Second, and None. Constraints: When using count/second
+                        as the unit, you should use Sum as the statistic instead of Average.
+                        Otherwise, the sample returns as equal to the number of requests
+                        instead of the number of 60-second intervals. This will cause the Average
+                        to always equals one when the unit is count/second.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <emphasis>StartTime</emphasis> The timestamp of the first datapoint to
+                        return, inclusive. For example, 2008-02-26T19:00:00+00:00. We round your
+                        value down to the nearest minute. You can set your start time for more than
+                        two weeks in the past. However, you will only get data for the past two
+                        weeks. (in ISO 8601 format). Constraints: Must be before EndTime.
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <emphasis>EndTime</emphasis> The timestamp to use for determining the last
+                        datapoint to return. This is the last datapoint to fetch, exclusive. For
+                        example, 2008-02-26T20:00:00+00:00 (in ISO 8601 format).
+                    </para>
+                </listitem>
+            </itemizedlist>
 
             <programlisting language="php"><![CDATA[
 $ec2_ebs = new Zend_Service_Amazon_Ec2_CloudWatch('aws_key','aws_secret_key');
-$return = $ec2_ebs->getMetricStatistics(array('MeasureName' => 'NetworkIn', 'Statistics' => array('Average')));
+$return = $ec2_ebs->getMetricStatistics(
+                                     array('MeasureName' => 'NetworkIn',
+                                           'Statistics' => array('Average')));
 ]]></programlisting>
         </example>
     </sect2>
-</sect1>
+</sect1>

+ 34 - 33
documentation/manual/en/module_specs/Zend_Service_Amazon_Ec2-ReservedInstance.xml

@@ -4,14 +4,14 @@
     <title>Zend_Service_Amazon_Ec2: Reserved Instances</title>
 
     <para>
-        With Amazon EC2 Reserved Instances, you can make a low one-time payment for
-        each instance to reserve and receive a significant discount on the hourly
+        With Amazon <acronym>EC2</acronym> Reserved Instances, you can make a low one-time payment
+        for each instance to reserve and receive a significant discount on the hourly
         usage charge for that instance.
     </para>
     <para>
-        Amazon EC2 Reserved Instances are based on instance type and location
+        Amazon <acronym>EC2</acronym> Reserved Instances are based on instance type and location
         (region and Availability Zone) for a specified period of time (e.g.,
-        1 year or 3 years) and are only available for Linux/UNIX instances.
+        1 year or 3 years) and are only available for Linux or UNIX instances.
     </para>
 
     <sect2 id="zend.service.amazon.ec2.reserved.instance.howitworks">
@@ -23,13 +23,13 @@
         </para>
         <itemizedlist>
             <listitem>
-                (4) m1.small instances in Availability Zone us-east-1a
+                <para>(4) m1.small instances in Availability Zone us-east-1a</para>
             </listitem>
             <listitem>
-                (4) c1.medium instances in Availability Zone us-east-1b
+                <para>(4) c1.medium instances in Availability Zone us-east-1b</para>
             </listitem>
             <listitem>
-                (2) c1.xlarge instances in Availability Zone us-east-1b
+                <para>(2) c1.xlarge instances in Availability Zone us-east-1b</para>
             </listitem>
         </itemizedlist>
         <para>
@@ -37,35 +37,35 @@
         </para>
         <itemizedlist>
             <listitem>
-                (2) m1.small instances in Availability Zone us-east-1a
+                <para>(2) m1.small instances in Availability Zone us-east-1a</para>
             </listitem>
             <listitem>
-                (2) c1.medium instances in Availability Zone us-east-1a
+                <para>(2) c1.medium instances in Availability Zone us-east-1a</para>
             </listitem>
             <listitem>
-                (2) m1.xlarge instances in Availability Zone us-east-1a
+                <para>(2) m1.xlarge instances in Availability Zone us-east-1a</para>
             </listitem>
         </itemizedlist>
         <para>
-            Amazon EC2 applies the two m1.small Reserved Instances to two of the instances
-            in Availability Zone us-east-1a. Amazon EC2 doesn't apply the two c1.medium
-            Reserved Instances because the c1.medium instances are in a different Availability
-            Zone and does not apply the m1.xlarge Reserved Instances because there are no
-            running m1.xlarge instances.
+            Amazon <acronym>EC2</acronym> applies the two m1.small Reserved Instances to two of the
+            instances in Availability Zone us-east-1a. Amazon <acronym>EC2</acronym> doesn't apply
+            the two c1.medium Reserved Instances because the c1.medium instances are in a different
+            Availability Zone and does not apply the m1.xlarge Reserved Instances because there are
+            no running m1.xlarge instances.
         </para>
     </sect2>
 
     <sect2 id="zend.service.amazon.ec2.reserved.instance.operations">
         <title>Reserved Instances Usage</title>
         <example id="zend.service.amazon.ec2.reserved.instance.operations.describe">
-            <title>Describes Reserved Instances that you purchased.</title>
+            <title>Describes Reserved Instances that you purchased</title>
             <para>
-                <code>describeInstances</code> will return information about a reserved
-                instance or instances that you purchased.
+                <methodname>describeInstances()</methodname> will return information about a
+                reserved instance or instances that you purchased.
             </para>
             <para>
-                <code>describeInstances</code> returns a multi-demential array that contains
-                reservedInstancesId, instanceType, availabilityZone, duration, fixedPrice,
+                <methodname>describeInstances()</methodname> returns a multi-demential array that
+                contains reservedInstancesId, instanceType, availabilityZone, duration, fixedPrice,
                 usagePrice, productDescription, instanceCount and state.
             </para>
             <programlisting language="php"><![CDATA[
@@ -77,17 +77,17 @@ $return = $ec2_instance->describeInstances('instanceId');
         </example>
 
         <example id="zend.service.amazon.ec2.reserved.instance.offerings.describe">
-            <title>Describe current Reserved Instance Offerings aviable</title>
+            <title>Describe current Reserved Instance Offerings available</title>
             <para>
-                <code>describeOfferings</code> Describes Reserved Instance offerings
-                that are available for purchase. With Amazon EC2 Reserved Instances,
-                you purchase the right to launch Amazon EC2 instances for a period of
-                time (without getting insufficient capacity errors) and pay a lower
+                <methodname>describeOfferings()</methodname> Describes Reserved Instance offerings
+                that are available for purchase. With Amazon <acronym>EC2</acronym> Reserved
+                Instances, you purchase the right to launch Amazon <acronym>EC2</acronym> instances
+                for a period of time (without getting insufficient capacity errors) and pay a lower
                 usage rate for the actual time used.
             </para>
             <para>
-                <code>describeOfferings</code> returns a multi-demential array that contains
-                reservedInstancesId, instanceType, availabilityZone, duration, fixedPrice,
+                <methodname>describeOfferings()</methodname> returns a multi-demential array that
+                contains reservedInstancesId, instanceType, availabilityZone, duration, fixedPrice,
                 usagePrice and productDescription.
             </para>
             <programlisting language="php"><![CDATA[
@@ -100,13 +100,14 @@ $return = $ec2_instance->describeOfferings();
         <example id="zend.service.amazon.ec2.reserved.instance.offerings.purchase">
             <title>Turn off CloudWatch Monitoring on an Instance(s)</title>
             <para>
-                <code>purchaseOffering</code> Purchases a Reserved Instance for use with your
-                account. With Amazon EC2 Reserved Instances, you purchase the right to launch
-                Amazon EC2 instances for a period of time (without getting insufficient capacity
-                errors) and pay a lower usage rate for the actual time used.
+                <methodname>purchaseOffering()</methodname> Purchases a Reserved Instance for use
+                with your account. With Amazon <acronym>EC2</acronym> Reserved Instances, you
+                purchase the right to launch Amazon <acronym>EC2</acronym> instances for a period
+                of time (without getting insufficient capacity errors) and pay a lower usage rate
+                for the actual time used.
             </para>
             <para>
-                <code>purchaseOffering</code> returns the reservedInstanceId.
+                <methodname>purchaseOffering()</methodname> returns the reservedInstanceId.
             </para>
             <programlisting language="php"><![CDATA[
 $ec2_instance = new Zend_Service_Amazon_Ec2_Instance_Reserved('aws_key',
@@ -116,4 +117,4 @@ $return = $ec2_instance->purchaseOffering('offeringId', 'instanceCount');
 
         </example>
     </sect2>
-</sect1>
+</sect1>

+ 85 - 68
documentation/manual/en/module_specs/Zend_Service_Amazon_Ec2-WindowsInstance.xml

@@ -6,24 +6,30 @@
     <para>
         Using Amazon EC2 instances running Windows is similar to using instances
         running Linux and UNIX. The following are the major differences between
-        instances that use Linux/UNIX and Windows:
+        instances that use Linux or UNIX and Windows:
+    </para>
 
-        <itemizedlist>
-            <listitem>
+    <itemizedlist>
+        <listitem>
+            <para>
                 Remote Desktop—To access Windows instances, you use Remote
                 Desktop instead of SSH.
-            </listitem>
-            <listitem>
+            </para>
+        </listitem>
+        <listitem>
+            <para>
                 Administrative Password—To access Windows instances the first time,
                 you must obtain the administrative password using the ec2-get-password
                 command.
-            </listitem>
-            <listitem>
+            </para>
+        </listitem>
+        <listitem>
+            <para>
                 Simplified Bundling—To bundle a Windows instance, you use a single command
                 that shuts down the instance, saves it as an AMI, and restarts it.
-            </listitem>
-        </itemizedlist>
-    </para>
+            </para>
+        </listitem>
+    </itemizedlist>
 
     <para>
         As part of this service, Amazon EC2 instances can now run Microsoft Windows Server
@@ -34,58 +40,65 @@
         and Microsoft SharePoint Server require Windows with Authentication Services.
     </para>
     <note>
-        To get started using Windows instances, we recommend using the AWS Management Console.
-        There are differences in pricing between Windows and Windows with Authentication Services
-        instances. For information on pricing, go to the Amazon EC2 Product Page.
+        <para>
+            To get started using Windows instances, we recommend using the AWS Management Console.
+            There are differences in pricing between Windows and Windows with Authentication
+            Services instances. For information on pricing, go to the Amazon EC2 Product Page.
+        </para>
     </note>
 
     <para>
         Amazon EC2 currently provides the following Windows AMIs:
-
-        <itemizedlist>
-            <listitem>
-                Windows Authenticated (32-bit)
-            </listitem>
-            <listitem>
-                Windows Authenticated (64-bit)
-            </listitem>
-            <listitem>
-                Windows Anonymous (32-bit)
-            </listitem>
-            <listitem>
-                Windows Anonymous (64-bit)
-            </listitem>
-        </itemizedlist>
     </para>
 
+    <itemizedlist>
+        <listitem>
+            <para>Windows Authenticated (32-bit)</para>
+        </listitem>
+        <listitem>
+            <para>Windows Authenticated (64-bit)</para>
+        </listitem>
+        <listitem>
+            <para>Windows Anonymous (32-bit)</para>
+        </listitem>
+        <listitem>
+            <para>Windows Anonymous (64-bit)</para>
+        </listitem>
+    </itemizedlist>
+
     <para>
         The Windows public AMIs that Amazon provides are unmodified
         versions of Windows with the following two exceptions: we added
         drivers to improve the networking and disk I/O performance and
         we created the Amazon EC2 configuration service. The Amazon EC2
         configuration service performs the following functions:
+    </para>
 
-        <itemizedlist>
-            <listitem>
+    <itemizedlist>
+        <listitem>
+            <para>
                 Randomly sets the Administrator password on initial launch,
-                encrypts the password with the user’s SSH key, and reports
+                encrypts the password with the user's SSH key, and reports
                 it to the console. This operation happens upon initial AMI
                 launch. If you change the password, AMIs that are created
                 from this instance use the new password.
-            </listitem>
-            <listitem>
+            </para>
+        </listitem>
+        <listitem>
+            <para>
                 Configures the computer name to the internal DNS name. To
                 determine the internal DNS name, see Using Instance Addressing.
-            </listitem>
-            <listitem>
-                 Sends the last three system and application errors from the
-                 event log to the console. This helps developers to identify
-                 problems that caused an instance to crash or network connectivity
-                 to be lost.
-            </listitem>
-        </itemizedlist>
-    </para>
-
+            </para>
+        </listitem>
+        <listitem>
+            <para>
+                Sends the last three system and application errors from the
+                event log to the console. This helps developers to identify
+                problems that caused an instance to crash or network connectivity
+                to be lost.
+            </para>
+        </listitem>
+    </itemizedlist>
 
     <sect2 id="zend.service.amazon.ec2.windows.instance.operations">
         <title>Windows Instances Usage</title>
@@ -93,26 +106,30 @@
         <example id="zend.service.amazon.ec2.windows.instance.operations.bundle">
             <title>Bundles an Amazon EC2 instance running Windows</title>
             <para>
-                <code>bundle</code> has three require paramters and one optional
-                <itemizedlist>
-                    <listitem>
-                         <code>instanceId</code> The instance you want to bundle
-                    </listitem>
-                    <listitem>
-                         <code>s3Bucket</code> Where you want the ami to live on S3
-                    </listitem>
-                    <listitem>
-                         <code>s3Prefix</code> The prefix you want to assign to the AMI on S3
-                    </listitem>
-                    <listitem>
-                         <code>uploadExpiration</code> The expiration of the upload policy.
-                         Amazon recommends 12 hours or longer. This is based in nubmer of
-                         minutes. Default is 1440 minutes (24 hours)
-                    </listitem>
-                </itemizedlist>
+                <methodname>bundle()</methodname> has three require paramters and one optional
             </para>
+            <itemizedlist>
+                <listitem>
+                     <para><emphasis>instanceId</emphasis> The instance you want to bundle</para>
+                </listitem>
+                <listitem>
+                     <para><emphasis>s3Bucket</emphasis> Where you want the ami to live on S3</para>
+                </listitem>
+                <listitem>
+                     <para>
+                        <emphasis>s3Prefix</emphasis> The prefix you want to assign to the AMI on S3
+                    </para>
+                </listitem>
+                <listitem>
+                    <para>
+                        <emphasis>uploadExpiration</emphasis> The expiration of the upload policy.
+                        Amazon recommends 12 hours or longer. This is based in nubmer of
+                        minutes. Default is 1440 minutes (24 hours)
+                    </para>
+                </listitem>
+            </itemizedlist>
             <para>
-                <code>bundle</code> returns a multi-demential array that contains
+                <methodname>bundle()</methodname> returns a multi-demential array that contains
                 instanceId, bundleId, state, startTime, updateTime, progress
                 s3Bucket and s3Prefix.
             </para>
@@ -127,11 +144,11 @@ $return = $ec2_instance->bundle('instanceId', 's3Bucket', 's3Prefix');
         <example id="zend.service.amazon.ec2.windows.instance.operations.describe">
             <title>Describes current bundling tasks</title>
             <para>
-                <code>describeBundle</code> Describes current bundling tasks
+                <methodname>describeBundle()</methodname> Describes current bundling tasks
             </para>
             <para>
-                <code>describeBundle</code> returns a multi-demential array that contains
-                instanceId, bundleId, state, startTime, updateTime, progress
+                <methodname>describeBundle()</methodname> returns a multi-demential array that
+                contains instanceId, bundleId, state, startTime, updateTime, progress
                 s3Bucket and s3Prefix.
             </para>
             <programlisting language="php"><![CDATA[
@@ -144,11 +161,11 @@ $return = $ec2_instance->describeBundle('bundleId');
         <example id="zend.service.amazon.ec2.windows.instance.operations.cancel">
             <title>Cancels an Amazon EC2 bundling operation</title>
             <para>
-                <code>cancelBundle</code> Cancels an Amazon EC2 bundling operation
+                <methodname>cancelBundle()</methodname> Cancels an Amazon EC2 bundling operation
             </para>
             <para>
-                <code>cancelBundle</code> returns a multi-demential array that contains
-                instanceId, bundleId, state, startTime, updateTime, progress
+                <methodname>cancelBundle()</methodname> returns a multi-demential array that
+                contains instanceId, bundleId, state, startTime, updateTime, progress
                 s3Bucket and s3Prefix.
             </para>
             <programlisting language="php"><![CDATA[
@@ -159,4 +176,4 @@ $return = $ec2_instance->cancelBundle('bundleId');
 
         </example>
     </sect2>
-</sect1>
+</sect1>