From 524577307ca785690f7b08dc7e0ead1929d46618 Mon Sep 17 00:00:00 2001 From: Chip Childers Date: Tue, 7 Aug 2012 15:09:05 -0400 Subject: [PATCH] Patch from Joe Brockmeier: docs/en-US/e* licenses Adds Apache license to all the e-named files in the docs/en-US folder, also fixes the DTD to point to http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd instead of a file on the local drive, and adds &PRODUCT; in place of CloudPlatform or CloudStack. --- docs/en-US/enable-disable-static-nat.xml | 23 ++++++++++++++-- docs/en-US/enable-security-groups.xml | 21 ++++++++++++++- docs/en-US/enabling-api-call-expiration.xml | 24 +++++++++++++++++ docs/en-US/enabling-port-8096.xml | 24 +++++++++++++++++ docs/en-US/end-user-ui-overview.xml | 21 ++++++++++++++- docs/en-US/error-handling.xml | 25 ++++++++++++++++- docs/en-US/event-log-queries.xml | 21 ++++++++++++++- docs/en-US/event-types.xml | 26 +++++++++++++++++- docs/en-US/events-log.xml | 24 ++++++++++++++--- docs/en-US/events.xml | 21 ++++++++++++++- .../example-LDAP-configuration-commands.xml | 23 ++++++++++++++-- ...example-response-from-listUsageRecords.xml | 26 +++++++++++++++++- docs/en-US/export-template.xml | 23 ++++++++++++++-- .../external-firewalls-and-load-balancers.xml | 27 +++++++++++++++---- 14 files changed, 308 insertions(+), 21 deletions(-) diff --git a/docs/en-US/enable-disable-static-nat.xml b/docs/en-US/enable-disable-static-nat.xml index 0895b889483..3a768846960 100644 --- a/docs/en-US/enable-disable-static-nat.xml +++ b/docs/en-US/enable-disable-static-nat.xml @@ -1,14 +1,33 @@ - %BOOK_ENTITIES; ]> + + +
Enabling or Disabling Static NAT If port forwarding rules are already in effect for an IP address, you cannot enable static NAT to that IP. If a guest VM is part of more than one network, static NAT rules will function only if they are defined on the default network. - Log in to the CloudPlatform UI as an administrator or end user. + Log in to the &PRODUCT; UI as an administrator or end user. In the left navigation, choose Network. Click the name of the network where you want to work with. Click View IP Addresses. diff --git a/docs/en-US/enable-security-groups.xml b/docs/en-US/enable-security-groups.xml index b97b65e7922..f2e07b3114d 100644 --- a/docs/en-US/enable-security-groups.xml +++ b/docs/en-US/enable-security-groups.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Enabling Security Groups In order for security groups to function in a zone, the security groups feature must first be enabled for the zone. The administrator can do this when creating a new zone, by selecting a network offering that includes security groups. The procedure is described in Basic Zone Configuration in the Advanced Installation Guide. diff --git a/docs/en-US/enabling-api-call-expiration.xml b/docs/en-US/enabling-api-call-expiration.xml index 9ebbb208033..dd0d9ceccfc 100644 --- a/docs/en-US/enabling-api-call-expiration.xml +++ b/docs/en-US/enabling-api-call-expiration.xml @@ -1,3 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + +
Enabling API Call Expiration diff --git a/docs/en-US/enabling-port-8096.xml b/docs/en-US/enabling-port-8096.xml index 55214399437..9609ee40523 100644 --- a/docs/en-US/enabling-port-8096.xml +++ b/docs/en-US/enabling-port-8096.xml @@ -1,3 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + +
Enabling Port 8096 diff --git a/docs/en-US/end-user-ui-overview.xml b/docs/en-US/end-user-ui-overview.xml index 879485cbe28..9c52720d69e 100644 --- a/docs/en-US/end-user-ui-overview.xml +++ b/docs/en-US/end-user-ui-overview.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
End User's UI Overview The &PRODUCT; UI helps users of cloud infrastructure to view and use their cloud resources, including virtual machines, templates and ISOs, data volumes and snapshots, guest networks, and IP addresses. If the user is a member or administrator of one or more &PRODUCT; projects, the UI can provide a project-oriented view. diff --git a/docs/en-US/error-handling.xml b/docs/en-US/error-handling.xml index 1b2684f3413..869e964850e 100644 --- a/docs/en-US/error-handling.xml +++ b/docs/en-US/error-handling.xml @@ -1,6 +1,29 @@ + + +%BOOK_ENTITIES; +]> + + +
Error Handling If an error occurs while processing an API request, the appropriate response in the format specified is returned. Each error response consists of an error code and an error text describing what possibly can go wrong. For an example error response, see page 12. An HTTP error code of 401 is always returned if API request was rejected due to bad signatures, missing API Keys, or the user simply did not have the permissions to execute the command.
- diff --git a/docs/en-US/event-log-queries.xml b/docs/en-US/event-log-queries.xml index b425ce0dfec..1eb449783fc 100644 --- a/docs/en-US/event-log-queries.xml +++ b/docs/en-US/event-log-queries.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
Event Log Queries Database logs can be queried from the user interface. The list of events captured by the system includes: diff --git a/docs/en-US/event-types.xml b/docs/en-US/event-types.xml index f9570b1450f..7be69706529 100644 --- a/docs/en-US/event-types.xml +++ b/docs/en-US/event-types.xml @@ -1,3 +1,27 @@ + + +%BOOK_ENTITIES; +]> + + +
Event Types @@ -193,4 +217,4 @@ -
\ No newline at end of file +
diff --git a/docs/en-US/events-log.xml b/docs/en-US/events-log.xml index 4087e58bbf4..5db856a8b7f 100644 --- a/docs/en-US/events-log.xml +++ b/docs/en-US/events-log.xml @@ -1,10 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
Event Logs - There are two types of events logged in the CloudPlatform Event Log. Standard events log the success or failure of an event and can be used to identify jobs or processes that have failed. There are also long running job events. Events for asynchronous jobs log when a job is scheduled, when it starts, and when it completes. Other long running synchronous jobs log when a job starts, and when it completes. Long running synchronous and asynchronous event logs can be used to gain more information on the status of a pending job or can be used to identify a job that is hanging or has not started. The following sections provide more information on these events.. + There are two types of events logged in the &PRODUCT; Event Log. Standard events log the success or failure of an event and can be used to identify jobs or processes that have failed. There are also long running job events. Events for asynchronous jobs log when a job is scheduled, when it starts, and when it completes. Other long running synchronous jobs log when a job starts, and when it completes. Long running synchronous and asynchronous event logs can be used to gain more information on the status of a pending job or can be used to identify a job that is hanging or has not started. The following sections provide more information on these events..
- diff --git a/docs/en-US/events.xml b/docs/en-US/events.xml index b1a67c13201..9d672ff4c0d 100644 --- a/docs/en-US/events.xml +++ b/docs/en-US/events.xml @@ -1,8 +1,27 @@ - %BOOK_ENTITIES; ]> + + +
diff --git a/docs/en-US/example-LDAP-configuration-commands.xml b/docs/en-US/example-LDAP-configuration-commands.xml index a91a9094ae5..e557386c3ca 100644 --- a/docs/en-US/example-LDAP-configuration-commands.xml +++ b/docs/en-US/example-LDAP-configuration-commands.xml @@ -1,11 +1,30 @@ - %BOOK_ENTITIES; ]> + + +
Example LDAP Configuration Commands - To understand the examples in this section, you need to know the basic concepts behind calling the CloudPlatform API, which are explained in the Developer’s Guide. + To understand the examples in this section, you need to know the basic concepts behind calling the &PRODUCT; API, which are explained in the Developer’s Guide. The following shows an example invocation of ldapConfig with an ApacheDS LDAP server http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash The command must be URL-encoded. Here is the same example without the URL encoding: diff --git a/docs/en-US/example-response-from-listUsageRecords.xml b/docs/en-US/example-response-from-listUsageRecords.xml index 96615bb0f52..8ed752de55c 100644 --- a/docs/en-US/example-response-from-listUsageRecords.xml +++ b/docs/en-US/example-response-from-listUsageRecords.xml @@ -1,7 +1,31 @@ + + +%BOOK_ENTITIES; +]> + + +
Example response from listUsageRecords - All CloudStack API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS: + All &PRODUCT; API requests are submitted in the form of a HTTP GET/POST with an associated command and any parameters. A request is composed of the following whether in HTTP or HTTPS: <listusagerecordsresponse> diff --git a/docs/en-US/export-template.xml b/docs/en-US/export-template.xml index c6db53f179f..05df2c0974b 100644 --- a/docs/en-US/export-template.xml +++ b/docs/en-US/export-template.xml @@ -1,10 +1,29 @@ - %BOOK_ENTITIES; ]> + + +
Exporting Templates - End users and Administrators may export templates from the CloudPlatform. Navigate to the template in the UI and choose the Download function from the Actions menu. + End users and Administrators may export templates from the &PRODUCT;. Navigate to the template in the UI and choose the Download function from the Actions menu.
diff --git a/docs/en-US/external-firewalls-and-load-balancers.xml b/docs/en-US/external-firewalls-and-load-balancers.xml index 239e7b8f584..1452804885d 100644 --- a/docs/en-US/external-firewalls-and-load-balancers.xml +++ b/docs/en-US/external-firewalls-and-load-balancers.xml @@ -1,11 +1,28 @@ - %BOOK_ENTITIES; ]> + + +
External Firewalls and Load Balancers - CloudPlatform is capable of replacing its Virtual Router with an external Juniper SRX device and an optional external NetScaler or F5 load balancer for gateway and load balancing services. In this case, the VMs use the SRX as their gateway. - - -
+ &PRODUCT; is capable of replacing its Virtual Router with an external Juniper SRX device and an optional external NetScaler or F5 load balancer for gateway and load balancing services. In this case, the VMs use the SRX as their gateway. +