You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by hu...@apache.org on 2012/10/03 18:48:30 UTC
[2/2] git commit: Create the documentation skeleton
Create the documentation skeleton
Project: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/commit/11cdd6e9
Tree: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/tree/11cdd6e9
Diff: http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/diff/11cdd6e9
Branch: refs/heads/master
Commit: 11cdd6e9c345febeeb1684af63499d4fa7c468e0
Parents: 18a09c9
Author: Hugo Trippaers <ht...@schubergphilis.com>
Authored: Tue Oct 2 18:01:52 2012 -0700
Committer: Hugo Trippaers <ht...@schubergphilis.com>
Committed: Wed Oct 3 09:47:50 2012 -0700
----------------------------------------------------------------------
docs/en-US/cloudstack_plugin_niciranvp.xml | 54 +++++++++++++++
docs/en-US/plugin-niciranvp-about.xml | 28 ++++++++
docs/en-US/plugin-niciranvp-features.xml | 26 +++++++
docs/en-US/plugin-niciranvp-guide.xml | 31 ++++++++
docs/en-US/plugin-niciranvp-introduction.xml | 65 ++++++++++++++++++
docs/en-US/plugin-niciranvp-troubleshooting.xml | 29 ++++++++
docs/en-US/plugin-niciranvp-usage.xml | 30 ++++++++
docs/publican-plugin-niciranvp.cfg | 28 ++++++++
8 files changed, 291 insertions(+), 0 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/cloudstack_plugin_niciranvp.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/cloudstack_plugin_niciranvp.xml b/docs/en-US/cloudstack_plugin_niciranvp.xml
new file mode 100644
index 0000000..55c7ad7
--- /dev/null
+++ b/docs/en-US/cloudstack_plugin_niciranvp.xml
@@ -0,0 +1,54 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE book 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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+
+<!-- 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.
+-->
+
+<book>
+ <bookinfo id="cloudstack_plugin_niciranvp">
+ <title>&PRODUCT; Plugin Guide for the Nicira NVP Plugin</title>
+ <productname>Apache CloudStack</productname>
+ <productnumber>4.0</productnumber>
+ <edition>1</edition>
+ <pubsnumber></pubsnumber>
+ <abstract>
+ <para>
+ Plugin Guide for the Nicira NVP Plugin.
+ </para>
+ </abstract>
+ <corpauthor>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="Common_Content/images/title_logo.svg" format="SVG" />
+ </imageobject>
+ </inlinemediaobject>
+ </corpauthor>
+ <xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </bookinfo>
+ <xi:include href="plugin-niciranvp-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="plugin-niciranvp-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="plugin-niciranvp-troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</book>
+
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/plugin-niciranvp-about.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-about.xml b/docs/en-US/plugin-niciranvp-about.xml
new file mode 100644
index 0000000..4f7d070
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-about.xml
@@ -0,0 +1,28 @@
+<?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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<chapter id="About-the-Nicira-NVP-Plugin">
+ <title>The Nicira NVP Plugin</title>
+ <xi:include href="plugin-niciranvp-introduction.xml"></xi:include>
+ <xi:include href="plugin-niciranvp-features.xml"></xi:include>
+</chapter>
+
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/plugin-niciranvp-features.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-features.xml b/docs/en-US/plugin-niciranvp-features.xml
new file mode 100644
index 0000000..b96e2d5
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-features.xml
@@ -0,0 +1,26 @@
+<?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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- 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="Features-of-the-Nicira-NVP-Plugin">
+ <title>Features of the Nicira NVP Plugin</title>
+ <para>In CloudStack release 4.0.x this plugin supports the Connectivity service. This service is responsible for creating Layer 2 networks supporting the networks created by Guests. In other words when an tennant creates a new network, instead of the traditional VLAN a logical network will be created by sending the appropriate calls to the Nicira NVP Controller.</para>
+</section>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/plugin-niciranvp-guide.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-guide.xml b/docs/en-US/plugin-niciranvp-guide.xml
new file mode 100644
index 0000000..89c9871
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-guide.xml
@@ -0,0 +1,31 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<!DOCTYPE chapter 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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<chapter id="niciranvp-plugin-guide">
+ <title>Plugin Guide for the Nicira NVP Plugin</title>
+ <xi:include href="plugin-niciranvp-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="plugin-niciranvp-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ <xi:include href="plugin-niciranvp-troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+</chapter>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/plugin-niciranvp-introduction.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-introduction.xml b/docs/en-US/plugin-niciranvp-introduction.xml
new file mode 100644
index 0000000..259fd51
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-introduction.xml
@@ -0,0 +1,65 @@
+<?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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- 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="Introduction-to-the-Nicira-NVP-Plugin">
+ <title>Introduction to the Nicira NVP Plugin</title>
+ <para>The Nicira NVP plugin allows CloudStack to use the Nicira solution for virtualized network as a provider for CloudStack networks and services.</para>
+ <!--
+ <para>Always use &PRODUCT; rather than typing CloudStack or CloudPlatform.</para>
+ <para>Indent with 4 spaces, not with tab characters.</para>
+ <para>To hyperlink to a URL outside this document: <ulink url="http://external URL here">Display text of the link here</ulink></para>
+ <para>To hyperlink to another section in this document: <xref linkend="SECTION-ID-OF-THE-OTHER-SECTION-GOES-HERE." />
+ The publication tools will automatically insert the display text of the link for you.</para>
+ <note><para>Use this for all tips and asides. Don't use other tags such as tip.
+ Our publication tool (publican) prefers the note tag. The tool will
+ automatically insert the text NOTE: for you, so please don't type it.</para></note>
+ <warning><para>Use this for anything that is vital to avoid runtime errors. Don't use
+ other tags such as caution. Our publication tool (publican) prefers the warning tag. The tool will
+ automatically insert the text WARNING: for you, so please don't type it.</para></warning>
+ <para>Here's how to do a bulleted list:</para>
+ <itemizedlist>
+ <listitem><para>Bulleted list item text.</para></listitem>
+ </itemizedlist>
+ <para>Here's how to do a numbered list. These are used for step by step instructions
+ or to describe a sequence of events in time. For everything else, use a bulleted list.</para>
+ <orderedlist>
+ <listitem><para>Text of the step</para></listitem>
+ <listitem><para>You might also want a sub-list within one of the list items. Like this:</para>
+ <orderedlist numeration="loweralpha">
+ <listitem><para>Inner list item text.</para></listitem>
+ </orderedlist>
+ </listitem>
+ </orderedlist>
+ <para>Here's how to insert an image. Put the graphic file in /images, a subdirectory of the directory where this XML file is.
+ Refer to it using this tag. The tag is admittedly complex, but it's the one we need to use with publican:</para>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="./images/YOUR_FILENAME_HERE.png" />
+ </imageobject>
+ <textobject><phrase>YOUR_FILENAME_HERE.png: Alt text describing this image, such as
+ “structure of a zone.” Required for accessibility.</phrase></textobject>
+ </mediaobject>
+ <para>A section can contain sub-sections. Please make each sub-section a separate file to enable reuse.
+ Then include the sub-section like this:</para>
+ <xi:include href="SUBSECTION_FILE_NAME.xml" xmlns:xi="http://www.w3.org/2001/XInclude" />
+ -->
+</section>
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/plugin-niciranvp-troubleshooting.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-troubleshooting.xml b/docs/en-US/plugin-niciranvp-troubleshooting.xml
new file mode 100644
index 0000000..6c78beb
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-troubleshooting.xml
@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter 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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<chapter id="Troubleshooting-the-Nicira-NVP-Plugin">
+ <title>Troubleshooting the Nicira NVP Plugin</title>
+ <!--
+ <xi:include href="plugin-niciranvp-uuidreferences.xml"></xi:include>
+ <xi:include href="plugin-niciranvp-tables.xml"></xi:include>
+ -->
+</chapter>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/en-US/plugin-niciranvp-usage.xml
----------------------------------------------------------------------
diff --git a/docs/en-US/plugin-niciranvp-usage.xml b/docs/en-US/plugin-niciranvp-usage.xml
new file mode 100644
index 0000000..4164cee
--- /dev/null
+++ b/docs/en-US/plugin-niciranvp-usage.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter 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;
+<!ENTITY % xinclude SYSTEM "http://www.docbook.org/xml/4.4/xinclude.mod">
+%xinclude;
+]>
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0.
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<chapter id="Using-the-Nicira-NVP-Plugin">
+ <title>Using the Nicira NVP Plugin</title>
+ <!--
+ <xi:include href="plugin-niciranvp-preparations.xml"></xi:include>
+ <xi:include href="plugin-niciranvp-provider.xml"></xi:include>
+ <xi:include href="plugin-niciranvp-devicemanagement.xml"></xi:include>
+ -->
+</chapter>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-cloudstack/blob/11cdd6e9/docs/publican-plugin-niciranvp.cfg
----------------------------------------------------------------------
diff --git a/docs/publican-plugin-niciranvp.cfg b/docs/publican-plugin-niciranvp.cfg
new file mode 100644
index 0000000..f419e05
--- /dev/null
+++ b/docs/publican-plugin-niciranvp.cfg
@@ -0,0 +1,28 @@
+# Publican configuration file for CloudStack Complete Documentation Set
+# Contains all technical docs except release notes
+# Config::Simple 4.58
+# Tue May 29 00:57:27 2012
+#
+# 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.
+
+xml_lang: en-US
+type: Book
+docname: cloudstack_plugin_niciranvp
+brand: cloudstack
+chunk_first: 1
+chunk_section_depth: 1
+condition: install