http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/README ---------------------------------------------------------------------- diff --git a/README b/README deleted file mode 100644 index d62e274..0000000 --- a/README +++ /dev/null @@ -1,53 +0,0 @@ -# License - -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. - -## About this repository - -This is currently a test repository to explore using AsciiDoc -and/or pulling the Apache CloudStack documentation into its own -repository. - -THIS SHOULD BE CONSIDERED DRAFT DOCUMENTATION UNTIL THIS IS REMOVED. - -## Mailing lists - -The Apache CloudStack project maintains several mailing lists for -discussions about the project. - -If you have questions about the Apache CloudStack documentation, -see the developer's mailing list: - -[Development Mailing List](mailto:[email protected]) - -You may also wish to subscribe to one or more of the following -mailing lists. - -[Users Mailing List](mailto:[email protected]) -[Commits Mailing List](mailto:[email protected]) -[Issues Mailing List](mailto:[email protected]) -[Marketing Mailing List](mailto:[email protected]) - -The names are fairly self-explanatory, but you can learn more about -our lists on the Apache CloudStack Website here: - -http://cloudstack.apache.org/mailing-lists.html - -# Building Apache CloudStack documentation - -See the INSTALL file.
http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Admin_Guide.ent ---------------------------------------------------------------------- diff --git a/en-US/Admin_Guide.ent b/en-US/Admin_Guide.ent new file mode 100644 index 0000000..abb1885 --- /dev/null +++ b/en-US/Admin_Guide.ent @@ -0,0 +1,22 @@ +<!-- 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. +--> + +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2012"> +<!ENTITY HOLDER "Apache Software Foundation"> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Admin_Guide.xml ---------------------------------------------------------------------- diff --git a/en-US/Admin_Guide.xml b/en-US/Admin_Guide.xml new file mode 100644 index 0000000..d3b9706 --- /dev/null +++ b/en-US/Admin_Guide.xml @@ -0,0 +1,74 @@ +<?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; +]> + +<!-- 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_admin"> + <title>&PRODUCT; Administrator's Guide</title> + <productname>Apache CloudStack</productname> + <productnumber>4.2.0</productnumber> + <edition>1</edition> + <pubsnumber></pubsnumber> + <abstract> + <para> + Administration Guide for &PRODUCT;. + </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="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="accounts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="user-services-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="offerings.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="set-up-network-for-users.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="virtual-machines.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="working-with-hosts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="working-with-templates.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="storage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="work-with-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="working-with-system-vm.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="sys-reliability-and-ha.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="manage-cloud.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="api-overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="tuning.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="time-zones.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="alerts.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/cloudstack-docs/blob/b23872a5/en-US/Author_Group.xml ---------------------------------------------------------------------- diff --git a/en-US/Author_Group.xml b/en-US/Author_Group.xml new file mode 100644 index 0000000..ba9e651 --- /dev/null +++ b/en-US/Author_Group.xml @@ -0,0 +1,32 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE authorgroup PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd"; [ +<!ENTITY % BOOK_ENTITIES SYSTEM "Runbook.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. +--> + + +<authorgroup> + <author> + <firstname>Apache</firstname> + <surname>CloudStack</surname> + </author> +</authorgroup> + http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Book_Info.xml ---------------------------------------------------------------------- diff --git a/en-US/Book_Info.xml b/en-US/Book_Info.xml new file mode 100644 index 0000000..327668d --- /dev/null +++ b/en-US/Book_Info.xml @@ -0,0 +1,47 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo 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. +--> + +<bookinfo id="book-release-notes-3.0.4"> + <title>&PRODUCT; Guide</title> + <subtitle>Revised August 9, 2012 10:48 pm Pacific</subtitle> + <productname>Apache CloudStack</productname> + <productnumber>4.2.0</productnumber> + <edition>1</edition> + <pubsnumber></pubsnumber> + <abstract> + <para> + Complete technical documentation of &PRODUCT;. + </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> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Book_Info_Release_Notes_4.xml ---------------------------------------------------------------------- diff --git a/en-US/Book_Info_Release_Notes_4.xml b/en-US/Book_Info_Release_Notes_4.xml new file mode 100644 index 0000000..e1c270f --- /dev/null +++ b/en-US/Book_Info_Release_Notes_4.xml @@ -0,0 +1,38 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE bookinfo 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. +--> +<bookinfo id="book-release-notes-4.2"> + <title>Version 4.2.0 Release Notes</title> + <productname>Apache &PRODUCT;</productname> + <productnumber/> + <pubsnumber/> + <abstract> + <para>Release notes for the Apache &PRODUCT; 4.2.0 release.</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> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/CloudStack_GSoC_Guide.ent ---------------------------------------------------------------------- diff --git a/en-US/CloudStack_GSoC_Guide.ent b/en-US/CloudStack_GSoC_Guide.ent new file mode 100644 index 0000000..1741587 --- /dev/null +++ b/en-US/CloudStack_GSoC_Guide.ent @@ -0,0 +1,22 @@ +<!-- 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. +--> + +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2013"> +<!ENTITY HOLDER "Apache Software Foundation"> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/CloudStack_GSoC_Guide.xml ---------------------------------------------------------------------- diff --git a/en-US/CloudStack_GSoC_Guide.xml b/en-US/CloudStack_GSoC_Guide.xml new file mode 100644 index 0000000..cd8205d --- /dev/null +++ b/en-US/CloudStack_GSoC_Guide.xml @@ -0,0 +1,55 @@ +<?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_GSoC_Guide.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_gsoc_2013"> + <title>&PRODUCT; Guide for the 2013 Google Summer of Code</title> + <productname>Apache CloudStack</productname> + <productnumber>4.3.0</productnumber> + <edition>1</edition> + <pubsnumber></pubsnumber> + <abstract> + <para> + Guide for 2013 Google Summer of Code Projects. + </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="gsoc-tuna.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="gsoc-imduffy15.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="gsoc-dharmesh.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="gsoc-meng.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="gsoc-shiva.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> +</book> + http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/CloudStack_Nicira_NVP_Guide.ent ---------------------------------------------------------------------- diff --git a/en-US/CloudStack_Nicira_NVP_Guide.ent b/en-US/CloudStack_Nicira_NVP_Guide.ent new file mode 100644 index 0000000..abb1885 --- /dev/null +++ b/en-US/CloudStack_Nicira_NVP_Guide.ent @@ -0,0 +1,22 @@ +<!-- 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. +--> + +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2012"> +<!ENTITY HOLDER "Apache Software Foundation"> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/CloudStack_Nicira_NVP_Guide.xml ---------------------------------------------------------------------- diff --git a/en-US/CloudStack_Nicira_NVP_Guide.xml b/en-US/CloudStack_Nicira_NVP_Guide.xml new file mode 100644 index 0000000..5431fc1 --- /dev/null +++ b/en-US/CloudStack_Nicira_NVP_Guide.xml @@ -0,0 +1,55 @@ +<?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.2.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-vpc.xml" xmlns:xi="http://www.w3.org/2001/XInclude";></xi:include> + <xi:include href="plugin-niciranvp-troubleshooting.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="plugin-niciranvp-revisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> +</book> + http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Common_Content/Legal_Notice.xml ---------------------------------------------------------------------- diff --git a/en-US/Common_Content/Legal_Notice.xml b/en-US/Common_Content/Legal_Notice.xml new file mode 100644 index 0000000..2a2e3a7 --- /dev/null +++ b/en-US/Common_Content/Legal_Notice.xml @@ -0,0 +1,15 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE legalnotice PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "file:///C:/Program%20Files%20(x86)/Publican/DocBook_DTD/docbookx.dtd" [ +]> +<legalnotice> + <para> + 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 + </para> + <para> + http://www.apache.org/licenses/LICENSE-2.0 + </para> + <para> + 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. + </para> +</legalnotice> + http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Common_Content/feedback.xml ---------------------------------------------------------------------- diff --git a/en-US/Common_Content/feedback.xml b/en-US/Common_Content/feedback.xml new file mode 100644 index 0000000..4b06c9f --- /dev/null +++ b/en-US/Common_Content/feedback.xml @@ -0,0 +1,24 @@ +<?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="feedback"> + <title>Feedback</title> + <para>to-do</para> +</section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Developers_Guide.ent ---------------------------------------------------------------------- diff --git a/en-US/Developers_Guide.ent b/en-US/Developers_Guide.ent new file mode 100644 index 0000000..47a2b67 --- /dev/null +++ b/en-US/Developers_Guide.ent @@ -0,0 +1,21 @@ +<!-- 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. +--> +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2012"> +<!ENTITY HOLDER "Apache Software Foundation"> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Developers_Guide.xml ---------------------------------------------------------------------- diff --git a/en-US/Developers_Guide.xml b/en-US/Developers_Guide.xml new file mode 100644 index 0000000..7452e29 --- /dev/null +++ b/en-US/Developers_Guide.xml @@ -0,0 +1,61 @@ +<?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; +]> + +<!-- 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_developers"> + <title>&PRODUCT; Developer's Guide</title> + <productname>Apache CloudStack</productname> + <productnumber>4.2.0</productnumber> + <edition></edition> + <pubsnumber></pubsnumber> + <abstract> + <para> + This guide shows how to develop &PRODUCT;, use the API for operation and integration, access the usage data and use &PRODUCT; specific tools to ease development, testing and integration. + </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="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="building-with-maven.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="developer-introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="whats-new.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="api-calls.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="working-with-usage-data.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="storage-plugins.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="third-party-ui-plugin.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="working-with-documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="tools.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="event-types.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="alerts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="time-zones.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/cloudstack-docs/blob/b23872a5/en-US/Installation_Guide.ent ---------------------------------------------------------------------- diff --git a/en-US/Installation_Guide.ent b/en-US/Installation_Guide.ent new file mode 100644 index 0000000..abb1885 --- /dev/null +++ b/en-US/Installation_Guide.ent @@ -0,0 +1,22 @@ +<!-- 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. +--> + +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2012"> +<!ENTITY HOLDER "Apache Software Foundation"> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Installation_Guide.xml ---------------------------------------------------------------------- diff --git a/en-US/Installation_Guide.xml b/en-US/Installation_Guide.xml new file mode 100644 index 0000000..ea97f25 --- /dev/null +++ b/en-US/Installation_Guide.xml @@ -0,0 +1,62 @@ +<?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; +]> + +<!-- 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="book-installation"> + <title>&PRODUCT; Installation Guide</title> + <productname>Apache CloudStack</productname> + <productnumber>4.2.0</productnumber> + <edition>1</edition> + <pubsnumber/> + <abstract> + <para> Installation Guide for &PRODUCT;. </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="concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="cloud-infrastructure-concepts.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="source.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="ui.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="provisioning-steps.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="global-config.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="hypervisor-installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="additional-installation-options.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="choosing-a-deployment-architecture.xml" + xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="choosing-a-hypervisor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="aws-interface-compatibility.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="network-setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="storage-setup.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="networks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="best-practices.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> + <xi:include href="Revision_History_Install_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> +</book> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/LDAPserver-for-user-authentication.xml ---------------------------------------------------------------------- diff --git a/en-US/LDAPserver-for-user-authentication.xml b/en-US/LDAPserver-for-user-authentication.xml new file mode 100644 index 0000000..376631c --- /dev/null +++ b/en-US/LDAPserver-for-user-authentication.xml @@ -0,0 +1,39 @@ +<?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="LDAPserver-for-user-authentication"> + <title>Using an LDAP Server for User Authentication</title> + <para>You can use an external LDAP server such as Microsoft Active Directory or ApacheDS to authenticate &PRODUCT; end-users. Just map &PRODUCT; accounts to the corresponding LDAP accounts using a query filter. The query filter is written using the query syntax of the particular LDAP server, and can include special wildcard characters provided by &PRODUCT; for matching common values such as the userâs email address and name. &PRODUCT; will search the external LDAP directory tree starting at a specified base directory and return the distinguished name (DN) and password of the matching user. This information along with the given password is used to authenticate the user..</para> + <para>To set up LDAP authentication in &PRODUCT;, call the &PRODUCT; API command ldapConfig and provide the following:</para> + <itemizedlist> + <listitem><para>Hostname or IP address and listening port of the LDAP server</para></listitem> + <listitem> <para>Base directory and query filter</para></listitem> + <listitem><para>Search user DN credentials, which give &PRODUCT; permission to search on the LDAP server</para></listitem> + <listitem><para>SSL keystore and password, if SSL is used</para></listitem> + </itemizedlist> + <xi:include href="example-LDAP-configuration-commands.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="search-base.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="query-filter.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="search-user-bind-dn.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="SSL-keystore-path-and-password.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + </section> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/MidoNet_Plugin_Guide.ent ---------------------------------------------------------------------- diff --git a/en-US/MidoNet_Plugin_Guide.ent b/en-US/MidoNet_Plugin_Guide.ent new file mode 100644 index 0000000..f31c407 --- /dev/null +++ b/en-US/MidoNet_Plugin_Guide.ent @@ -0,0 +1,22 @@ +<!-- 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. +--> + +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2013"> +<!ENTITY HOLDER "Apache Software Foundation"> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/MidoNet_Plugin_Guide.xml ---------------------------------------------------------------------- diff --git a/en-US/MidoNet_Plugin_Guide.xml b/en-US/MidoNet_Plugin_Guide.xml new file mode 100644 index 0000000..86182e6 --- /dev/null +++ b/en-US/MidoNet_Plugin_Guide.xml @@ -0,0 +1,52 @@ +<?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="midonet_plugin"> + <title>&PRODUCT; Plugin Guide for the MidoNet Plugin</title> + <productname>Apache CloudStack</productname> + <productnumber>4.2.0</productnumber> + <edition>1</edition> + <pubsnumber></pubsnumber> + <abstract> + <para> + Plugin Guide for the MidoNet 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-midonet-about.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="plugin-midonet-usage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="plugin-midonet-revisions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> +</book> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Preface.xml ---------------------------------------------------------------------- diff --git a/en-US/Preface.xml b/en-US/Preface.xml new file mode 100644 index 0000000..e046410 --- /dev/null +++ b/en-US/Preface.xml @@ -0,0 +1,31 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE preface 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. +--> + +<preface id="pref-cloudstack-Preface"> + <title>Preface</title> + <xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + <xi:include href="feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude";><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude";><xi:include href="Common_Content/feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"; /> + </xi:fallback> + </xi:include> +</preface> http://git-wip-us.apache.org/repos/asf/cloudstack-docs/blob/b23872a5/en-US/Release_Notes.ent ---------------------------------------------------------------------- diff --git a/en-US/Release_Notes.ent b/en-US/Release_Notes.ent new file mode 100644 index 0000000..7858ad5 --- /dev/null +++ b/en-US/Release_Notes.ent @@ -0,0 +1,22 @@ +<!-- 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. +--> + +<!ENTITY PRODUCT "CloudStack"> +<!ENTITY BOOKID "Technical Documentation"> +<!ENTITY YEAR "2012"> +<!ENTITY HOLDER "Apache Software Foundation">
