incubator-cloudstack-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ke4...@apache.org
Subject [1/2] git commit: refs/heads/master - dev guide updates for 4.1
Date Thu, 14 Feb 2013 04:58:11 GMT
dev guide updates for 4.1

Signed-off-by: radhikap <radhika.puthiyetath@citrix.com>


Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/8db8ee71
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/8db8ee71
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/8db8ee71

Branch: refs/heads/master
Commit: 8db8ee71d6fc73c1aefd17e82ea6e0c1ccc8adee
Parents: fe44e39
Author: radhikap <radhika.puthiyetath@citrix.com>
Authored: Wed Feb 13 16:39:47 2013 +0530
Committer: David Nalley <david@gnsa.us>
Committed: Wed Feb 13 23:55:57 2013 -0500

----------------------------------------------------------------------
 docs/en-US/added-API-commands-4-1.xml  |   41 ++++++++++
 docs/en-US/changed-apicommands-4.1.xml |  106 +++++++++++++++++++++++++++
 docs/en-US/reset-ssh-key-dev.xml       |   27 +++++++
 docs/en-US/vmx-settings-dev.xml        |   40 ++++++++++
 docs/en-US/whats-new.xml               |   71 ++++++++++--------
 5 files changed, 252 insertions(+), 33 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/8db8ee71/docs/en-US/added-API-commands-4-1.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/added-API-commands-4-1.xml b/docs/en-US/added-API-commands-4-1.xml
new file mode 100644
index 0000000..f635e9d
--- /dev/null
+++ b/docs/en-US/added-API-commands-4-1.xml
@@ -0,0 +1,41 @@
+<?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="added-API-commands-4.1">
+  <title>Added API Commands in 4.1-incubating</title>
+  <itemizedlist>
+    <listitem>
+      <para>createEgressFirewallRules (creates an egress firewall rule on the guest
network.)</para>
+    </listitem>
+    <listitem>
+      <para>deleteEgressFirewallRules (deletes a egress firewall rule on the guest
network.)</para>
+    </listitem>
+    <listitem>
+      <para>listEgressFirewallRules (lists the egress firewall rules configured for
a guest
+        network.)</para>
+    </listitem>
+    <listitem>
+      <para>resetSSHKeyForVirtualMachine (Resets the SSHkey for virtual machine.)</para>
+    </listitem>
+    <listitem>
+      <para>addBaremetalHost (Adds a new host.)</para>
+    </listitem>
+  </itemizedlist>
+</section>

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/8db8ee71/docs/en-US/changed-apicommands-4.1.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/changed-apicommands-4.1.xml b/docs/en-US/changed-apicommands-4.1.xml
new file mode 100644
index 0000000..42bd088
--- /dev/null
+++ b/docs/en-US/changed-apicommands-4.1.xml
@@ -0,0 +1,106 @@
+<?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="changed-apicommands-4.1">
+  <title>Changed API Commands in 4.1-incubating</title>
+  <informaltable>
+    <tgroup cols="2" align="left" colsep="1" rowsep="1">
+      <colspec colwidth="1.0*" colname="1" colnum="1"/>
+      <colspec colwidth="4.37*" colname="2" colnum="2"/>
+      <thead>
+        <row>
+          <entry><para>API Commands</para></entry>
+          <entry><para>Description</para></entry>
+        </row>
+      </thead>
+      <tbody>
+        <row>
+          <entry>
+            <para>createNetworkOffering</para>
+            <para>listNetworkOfferings</para>
+            <para>listNetworks</para>
+          </entry>
+          <entry>
+            <para>The following request parameters is added: isPersistent.</para>
+            <para>This parameter determines if the network or network offering created
or listed by
+              using this offering are persistent or not.</para>
+          </entry>
+        </row>
+        <row>
+          <entry>
+            <para>addF5LoadBalancer</para>
+            <para>configureNetscalerLoadBalancer</para>
+            <para>addNetscalerLoadBalancer</para>
+            <para>listF5LoadBalancers</para>
+            <para>configureF5LoadBalancer</para>
+            <para>listNetscalerLoadBalancers</para>
+          </entry>
+          <entry>
+            <para>The following response parameter is removed: inline.</para>
+          </entry>
+        </row>
+        <row>
+          <entry><para>listFirewallRules</para>
+            <para>createFirewallRule</para></entry>
+          <entry>
+            <para>The following request parameter is added: traffictype (optional).</para>
+          </entry>
+        </row>
+        <row>
+          <entry><para>listUsageRecords</para></entry>
+          <entry><para>The following response parameter is added: virtualsize.</para>
+          </entry>
+        </row>
+        <row>
+          <entry>
+            <para>deleteIso</para>
+          </entry>
+          <entry>
+            <para>The following request parameter is added: forced (optional).</para>
+          </entry>
+        </row>
+        <row>
+          <entry>
+            <para>createStoragePool</para>
+          </entry>
+          <entry>
+            <para>The following request parameters are made mandatory:</para>
+            <itemizedlist>
+              <listitem>
+                <para>podid</para>
+              </listitem>
+              <listitem>
+                <para>clusterid</para>
+              </listitem>
+            </itemizedlist>
+          </entry>
+        </row>
+        <row>
+          <entry>
+            <para>listZones</para>
+          </entry>
+          <entry>
+            <para>The following request parameters is added: securitygroupenabled</para>
+          </entry>
+        </row>
+      </tbody>
+    </tgroup>
+  </informaltable>
+</section>

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/8db8ee71/docs/en-US/reset-ssh-key-dev.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/reset-ssh-key-dev.xml b/docs/en-US/reset-ssh-key-dev.xml
new file mode 100644
index 0000000..1a904e5
--- /dev/null
+++ b/docs/en-US/reset-ssh-key-dev.xml
@@ -0,0 +1,27 @@
+<?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="reset-ssh-key-dev">
+  <title>Resetting SSH Keys to Access VMs</title>
+  <para>Use the resetSSHKeyForVirtualMachine API to set or reset the SSH keypair assigned
to a
+    virtual machine. With the addition of this feature, a lost or compromised SSH keypair
can be
+    changed, and the user can access the VM by using the new keypair. Just create or register
a new
+    keypair, then call resetSSHKeyForVirtualMachine.</para>
+</section>

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/8db8ee71/docs/en-US/vmx-settings-dev.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/vmx-settings-dev.xml b/docs/en-US/vmx-settings-dev.xml
new file mode 100644
index 0000000..a0fdf7f
--- /dev/null
+++ b/docs/en-US/vmx-settings-dev.xml
@@ -0,0 +1,40 @@
+<?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="vmx-settings-dev">
+  <title>Additional VMX Settings</title>
+  <para>A VMX (.vmx) file is the primary configuration file for a virtual machine.
When a new VM is
+    created, information on the operating system, disk sizes, and networking is stored in
this file.
+    The VM actively writes to its .vmx file for all the configuration changes. The VMX file
is
+    typically located in the directory where the VM is created. In Windows Vista / Windows
7 /
+    Windows Server 2008, the default location is C:\Users\&lt;your_user_name&gt;\My
+    Documents\Virtual Machines\&lt;virtual_machine_name&gt;.vmx. In Linux, vmware-cmd
-l lists the
+    full path to all the registered VMX files. Any manual additions to the .vmx file from
ESX/ESXi
+    are overwritten by the entries stored in the vCenter Server database. Therefore, before
you edit
+    a .vmx file, first remove the VM from the vCenter server's inventory and register the
VM again
+    after editing.</para>
+  <para>The CloudStack API that supports passing some of the VMX settings is registerTemplate.
The
+    supported parameters are rootDiskController, nicAdapter, and keyboard. In addition to
these
+    existing VMX parameters, you can now use the keyboard.typematicMinDelay parameter in
the
+    registerTemplate API call. This parameter controls the amount of delay for the repeated
key
+    strokes on remote consoles. For more information on keyboard.typematicMinDelay, see <ulink
+      url=" http://kb.vmware.com/selfservice/microsites/search.do?language=en_US&amp;cmd=displayKC&amp;externalId=196"
+      >keyboard.typematicMinDelay</ulink>.</para>
+</section>

http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/8db8ee71/docs/en-US/whats-new.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/whats-new.xml b/docs/en-US/whats-new.xml
index 77b3ec3..29ae1f6 100644
--- a/docs/en-US/whats-new.xml
+++ b/docs/en-US/whats-new.xml
@@ -3,40 +3,45 @@
 <!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.
+  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="whats-new">
-    <title>What's New in the API?</title>
-    <para>The following describes any new major features of each &PRODUCT; version
as it applies to API usage.</para>
-    <section id="whats-new-in-api-4.0">
-        <title>What's New in the API for 4.0</title>
-        <xi:include href="changed-apicommands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
-        <xi:include href="added-API-commands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
-    </section>
-    <section id="whats-new-in-api-3.0">
-        <title>What's New in the API for 3.0</title>
-        <xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
-        <xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
-        <xi:include href="change-to-behavior-of-list-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
-        <xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
-        <xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
-        <xi:include href="added-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"
/>
-    </section>
+  <title>What's New in the API?</title>
+  <para>The following describes any new major features of each &PRODUCT; version
as it applies to
+    API usage.</para>
+  <section id="whats-new-in-api-4.1">
+    <title>What's New in the API for 4.1</title>
+    <xi:include href="vmx-settings-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="reset-ssh-key-dev.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="changed-apicommands-4.1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="added-API-commands-4-1.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  </section>
+  <section id="whats-new-in-api-4.0">
+    <title>What's New in the API for 4.0</title>
+    <xi:include href="changed-apicommands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="added-API-commands-4-0.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  </section>
+  <section id="whats-new-in-api-3.0">
+    <title>What's New in the API for 3.0</title>
+    <xi:include href="enabling-port-8096.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="stopped-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="change-to-behavior-of-list-commands.xml"
+      xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="removed-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="added-API-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+    <xi:include href="added-error-codes.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
+  </section>
 </chapter>


Mime
View raw message