Fix building documentation

doc/html/_sources/architecture.rst.txt

@@ -0,0 +1,29 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+Introduction
+************
+
+What is Feilong
+===============
+
+Feilong is a Software Development Kit (SDK) for managing z/VM resources.
+It provides a set of APIs to operate these resources, including guest, image,
+network, volume etc. It comes with a python client library,
+but can be used from other languages.
+
+Integration Examples
+====================
+
+* Example 1: integration with OpenStack
+
+.. image:: ./images/openstack_zcc.jpg
+
+
+Internal Architecture
+=====================
+
+Here is an internal component list of Feilong:
+
+.. image:: ./images/zcc_internal.jpg

doc/html/_sources/change.rst.txt

@@ -0,0 +1,129 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+.. _`Change log`:
+
+Release Notes
+*************
+
+Release 1.4.0
+-------------
+
+New features released with zVMCLoudConnector 1.4.0:
+
+* Attach/detach volume to inactive guest.
+
+* Support set hostname without cloud-init.
+
+Release 1.3.0
+-------------
+New features released with zVMCloudConnector 1.3.0:
+
+* Support upload image through octet stream.
+
+* Guest live migrate, support live migrate in z/VM SSI cluster.
+
+* Live resize guest memory, and static resize guest memory.
+
+* Attach/detach volume to active guest.
+
+Release 1.2.1
+-------------
+zVMCloudConnector 1.2.1 includes one change:
+
+* Support "application/json,utf-8" context type in restclient.
+
+Release 1.2.0
+-------------
+Following new features released with zVMCloudConnector 1.2.0:
+
+* Dedicate OSA device to guest. If osa_device specified when invoking
+  z/VM Cloud Connector restful API to create network interface, the OSA device
+  will be dedicated to the guest.
+
+* Resize CPUs of guest. Resize guest CPU count by updating static definition.
+
+* Live resize CPUs of guest. Currently only increasing CPU count is supported,
+  decreasing is not supported.
+
+Release 1.1.0
+-------------
+zVMCloudConnector 1.1.0 is mainly includes the change:
+
+* Switch config drive format from tgz to iso9660
+
+    Config drive in iso9660 format is commonly used by cloud-init.
+
+Release 1.0.1
+-------------
+
+zVMCloudConnector 1.0.1 release mainly adapts to the SMAPI changes in z/VM 6.4
+APAR VM66120 1Q 2018. If the z/VM 6.4 has been applied APAR VM66120, must
+upgrade z/VM Cloud Connector to 1.0.1 .
+
+Release 1.0.0
+-------------
+
+zVMCloudConnector 1.0.0 release includes many basic features that enables
+z/VM Cloud management through zVMCloudConnector APIs.
+
+**Supported features**
+
+* Host(hypervisor) management
+
+  get host information and get host disk pool information.
+
+* Guests(virtual machines) management
+
+  - Provisoning: create, delete guest definition; capture, deploy guests;
+    create, delete, configure disks; create, delete, couple, uncouple vnics to
+    vswitch; configure vnics and network interfaces.
+
+  - Power actions including start, stop, softstop, reboot, reset, pause,
+    unpause and get power state.
+
+  - Query information: get guest information, guest list, get guest definition
+    information, get console outputs, get nic information.
+
+* Image management
+
+  Support import, export, delete images; query image information, get image
+  root disk size.
+
+* Network features
+
+  - vswitch: create, delete vswitch; grant, revoke vswitch access,
+    get vswitch list, query vswitch information, set user vlan id.
+
+  - Hot plug/unplug network interfaces to live guest.
+
+* Monitoring
+
+  Inspect virtual machine cpu, memory and vnic stats.
+
+* RESTful API
+
+  zVMCloudConnector provides standard RESTful API, which makes it easier to
+  integrate with other cloud platforms. zVMCloudConnector RESTful API supports
+  to be configured in a HTTP or HTTPS server.
+
+* Authorization mechanism
+
+  Support token based validation mechanism to make sure all zVMCloudConnector
+  RESTful API requests are authorized.
+
+* IUCV management channel
+
+  zVMCloudConnector manages virtual machines through z/VM IUCV communication
+  channel, which does not require network connection.
+
+* Monitoring data cache
+
+  Implement a cache layer in zVMCloudConnector to improve performance of getting
+  monitoring data.
+
+Release 0.3.2
+-------------
+
+Beta release since Dec 4, 2017

doc/html/_sources/configuration.rst.txt

@@ -0,0 +1,10 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+.. _`configuration options`:
+
+Configuration Options
+*********************
+
+.. literalinclude:: ./zvmsdk.conf.sample

doc/html/_sources/errorcodemsg.rst.txt

@@ -0,0 +1,15 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+Error Codes and Messages
+************************
+
+This is a reference to Feilong API error codes
+and messages.
+
+.. csv-table::
+   :header: "overallRC";"modID";"rc";"rs";"errmsg"
+   :delim: ;
+   :widths: 20,10,5,5,65
+   :file: errcode.csv

doc/html/_sources/faq.rst.txt

@@ -0,0 +1,32 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+General info
+************
+
+This section provides answers to frequent asked questions.
+
+FAQ
+===
+
+Change default NIC address
+--------------------------
+
+For NIC address on to be created VM, the default value 1000 is defined by
+Feilong configuration file, generally it is defined by ``default_nic_vdev``
+item of ``zvm`` section in ``/etc/zvmsdk/zvmsdk.conf``.
+
+If you want to create a VM with different value, change it to any integer you
+want and make sure no conflict to other address then restart the Feilong service.
+
+Log on through 3270 or PCOM terminal
+------------------------------------
+
+Currently, Feilong doesn't support to set a password for virtual machine
+(the definition in user directory), it is designed from a security perspective.
+Only the administrator has the authority to logon the virtual machine through x3270
+or PCOM, the common user is only allowed to connect to guest through network
+(ssh with id and password)
+
+Refer to ``default_admin_userid`` configuration in ``zvm`` section for more detail info.

doc/html/_sources/generalinfo.rst.txt

@@ -0,0 +1,73 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+General info
+************
+
+Content of this package
+========================
+
+Feilong (also known as python-zvm-sdk) is a client library written in Python
+that interacts with `z/VM`_ SMAPI (System management API) of `IBM Z`_ or
+`LinuxONE`_ machines. The goal of this package is to make the z/VM SMAPI easy
+to be consumed by upper layer programmers and provide a set of APIs to be
+called through RESTful interfaces.
+
+.. _IBM Z: https://www.ibm.com/z
+.. _LinuxONE: https://www.ibm.com/linuxone
+.. _z/VM: https://www.ibm.com/products/zvm
+
+The z/VM SMAPI is the access point for any external tools to
+manage the z/VM running on IBM Z or LinuxONE platform. It supports management of
+lifecycle and configuration of various platform resources, such as guest,
+CPU, memory, virtual switches, disk storage, and more.
+
+Version
+=======
+
+This documentation applies to version |release| of the Feilong package (python-zvm-sdk).
+You can also see that version in the top left corner of this page.
+
+The Feilong package (python-zvm-sdk) uses the rules of `Semantic Versioning 2.0.0`_ for
+its version.
+
+.. _Semantic Versioning 2.0.0: http://semver.org/spec/v2.0.0.html
+
+Compatibility
+=============
+
+In this package, compatibility is always seen from the perspective of the user
+of the package. Thus, a backwards compatible new version of this package means
+that the user can safely upgrade to that new version without encountering
+compatibility issues.
+
+This package uses the rules of `Semantic Versioning 2.0.0`_ for compatibility
+between package versions, and for :ref:`deprecations <Deprecations>`.
+
+Violations of these compatibility rules are described in section
+:ref:`Change log`.
+
+.. _`Deprecations`:
+
+Deprecations
+============
+
+Deprecated functionality is marked accordingly in this documentation and in the
+:ref:`Change log`
+
+Bug reporting and questions
+===========================
+
+If you encounter any problem with this package, please open a bug against
+`Feilong issue tracker`_ or ask question `Feilong question`_
+
+.. _Feilong issue tracker: https://bugs.launchpad.net/python-zvm-sdk/+bug
+.. _Feilong question: https://answers.launchpad.net/python-zvm-sdk/
+
+License
+=======
+
+This package is licensed under the `Apache 2.0 License`_.
+
+.. _Apache 2.0 License: https://raw.githubusercontent.com/zhmcclient/python-zhmcclient/master/LICENSE

doc/html/_sources/index.rst.txt

@@ -0,0 +1,30 @@
+..
+ Copyright Contributors to the Feilong Project.
+ SPDX-License-Identifier: CC-BY-4.0
+
+============================================
+Welcome to the Feilong Document
+============================================
+
+.. toctree::
+   :maxdepth: 2
+   :numbered:
+
+   generalinfo
+   architecture
+   quickstart
+   setuphttpd
+   makeimage
+   sample
+   restapi
+   errorcodemsg
+   configuration
+   resize
+   faq
+   change
+
+----
+
+.. image:: https://i.creativecommons.org/l/by/4.0/80x15.png
+
+This documentation is under `Creative Commons Attribution 4.0 International License <http://creativecommons.org/licenses/by/4.0/>`_