diff --git a/doc/source/activeengine.rst b/doc/source/activeengine.rst index 3833d7d..3b4129e 100644 --- a/doc/source/activeengine.rst +++ b/doc/source/activeengine.rst @@ -5,26 +5,24 @@ Active Engine Guide =================== Active engine is used as initial configuration and management tool during deployed machine startup. -Currently z/VM driver use xcatconf4z and cloud-init as 2 stage active engine. +Currently z/VM driver use zvmguestconfigure and cloud-init as 2 stage active engine. -Installation and Configuration of xcatconf4z --------------------------------------------- +Installation and Configuration of zvmguestconfigure +--------------------------------------------------- -xCAT supports initiating changes to a Linux on z Systems virtual machine while Linux is shut down or +Cloudlib4zvm supports initiating changes to a Linux on z Systems virtual machine while Linux is shut down or the virtual machine is logged off. The changes to Linux are implemented using an activation engine (AE) -that is run when Linux is booted the next time. The xCAT activation engine, xcatconf4z, handles changes -initiated by xCAT. The script/service must be installed in the Linux on z Systems virtual server so it can -process change request files transmitted by the xCAT ZHCP service to the reader of the virtual machine -as a class X file. The script is xcatconf4z and is located at /opt/xcat/share/xcat/scripts in the xCAT -MN machine. +that is run when Linux is booted the next time. The 1st active engine, zvmguestconfigure, must be installed +in the Linux on z Systems virtual server so it can process change request files transmitted by the cloudlib4sdk +service to the reader of the virtual machine as a class X file. -The xcatconf4z script should be installed in a machine that can be managed while it is logged off. This +zvmguestconfigure script should be installed in a machine that can be managed while it is logged off. This includes a Linux on z Systems that will be captured for netboot or sysclone deploys. .. note:: An additional activation engine, cloud-init, should be installed to handle OpenStack related - tailoring of the system. The cloud-init AE relies on tailoring performed by the xCAT AE, xcatconf4z. + tailoring of the system. The cloud-init AE relies on tailoring performed by the zvmguestconfigure. Installation and Configuration of cloud-init -------------------------------------------- diff --git a/doc/source/cloudlib4zvm.rst b/doc/source/cloudlib4zvm.rst index bb553a2..339650f 100644 --- a/doc/source/cloudlib4zvm.rst +++ b/doc/source/cloudlib4zvm.rst @@ -21,3 +21,5 @@ Links * Pypi: ``_ * Doc: ``_ +* Gerrit: ``_ +* Github: ``_ diff --git a/doc/source/conf.py b/doc/source/conf.py index b461281..bf0ab42 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -36,15 +36,12 @@ sys.path.insert(0, os.path.abspath('./')) # ones. extensions = [ 'oslosphinx', - 'oslo_config.sphinxconfiggen', 'sphinx.ext.autodoc', 'ext.support_matrix', - 'sphinx.ext.autodoc', - 'oslosphinx', 'oslo_config.sphinxconfiggen', ] -# config_generator_config_file = '../../etc/nova/nova-zvm-oslo-conf-generator.conf' +config_generator_config_file = '../../etc/nova/nova-zvm-oslo-conf-generator.conf' sample_config_basename = '_static/nova_zvm' # Add any paths that contain templates here, relative to this directory. diff --git a/doc/source/imageguide.rst b/doc/source/imageguide.rst index 6de2dab..c59647e 100644 --- a/doc/source/imageguide.rst +++ b/doc/source/imageguide.rst @@ -22,8 +22,7 @@ Image Requirements ECKD * Images created with the previous version of the OpenStack support should be recaptured with an - updated xcatconf4z installed, version 2.0 or later. see below chapter for more detail on - xcatconf4z. + updated zvmguestconfigure installed * An image deployed on a compute node must match the disk type supported by that compute node, as configured by the zvm_diskpool_type property in the nova.conf configuration file. A compute node @@ -40,15 +39,10 @@ Image Requirements disk. * For glance image-create, it is strongly suggested that you capture an instance with a root disk size no - greater than 5GB. If you really want to capture a larger root device, you will need to logon xCAT MN - and modify the timeout value in for httpd service to make image-create work as expected. + greater than 5GB. -* For nova boot, it is recommended that you deploy an instance with a root disk size no greater than - 5GB. If you really want to deploy a larger root device, you will need to logon xCAT MN and modify - the timeout value in for httpd service to make boot work as expected. - -* For nova resize operation, we suggest that you resize an instance with a root disk size no greater than - 5GB. +* For nova boot, resize, it is recommended that you deploy an instance with a root disk size no greater than + 5GB. * The network interfaces must be IPv4 interfaces. @@ -69,8 +63,7 @@ Image Requirements 4. The root disk should have a single partition. - 5. The image being captured should support SSH access using keys instead of specifying a password. The - subsequent steps to capture the image will perform a key exchange to allow xCAT to access the server. + 5. The image being captured should support SSH access using keys instead of specifying a password. 6. The image being captured should not have any network interface cards (NICs) defined below virtual address 1100. diff --git a/doc/source/images/zvm_arch.jpg b/doc/source/images/zvm_arch.jpg new file mode 100644 index 0000000..b9364d9 Binary files /dev/null and b/doc/source/images/zvm_arch.jpg differ diff --git a/doc/source/images/zvm_history.jpg b/doc/source/images/zvm_history.jpg new file mode 100644 index 0000000..a79133b Binary files /dev/null and b/doc/source/images/zvm_history.jpg differ diff --git a/doc/source/index.rst b/doc/source/index.rst index 69fd7de..7750a18 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -41,6 +41,7 @@ Overview .. toctree:: :maxdepth: 2 + zvm topology support-matrix cloudlib4zvm diff --git a/doc/source/planning.rst b/doc/source/planning.rst index 33f9564..f65cc38 100644 --- a/doc/source/planning.rst +++ b/doc/source/planning.rst @@ -15,7 +15,7 @@ z/VM System Requirements configuration, and must have been created using the IBM-provided installation instructions for SSI configurations. -* The appropriate APARs installed, the current list of which can be found at z/VM xCAT Maintenance +* The appropriate APARs installed, the current list of which can be found at z/VM cloud connector Maintenance (http://www.vm.ibm.com/sysman/xcmntlvl.html) and z/VM OpenStack Cloud Information (http://www.vm.ibm.com/sysman/osmntlvl.html). diff --git a/doc/source/support-matrix.ini b/doc/source/support-matrix.ini index 9798d57..21815be 100644 --- a/doc/source/support-matrix.ini +++ b/doc/source/support-matrix.ini @@ -186,7 +186,7 @@ notes=Live migration provides a way to move an instance off one built on the container based virtualization. Therefore this operation is not considered mandatory to support. cli=nova live-migration ;nova host-evacuate-live -driver-impl-ibm-zvm=complete +driver-impl-ibm-zvm=missing [operation.force-live-migration-to-complete] title=Force live migration to complete @@ -265,7 +265,7 @@ notes=The resize operation allows the user to change a running running instance. Therefore this operation is considered optional to support in drivers. cli=nova resize -driver-impl-ibm-zvm=complete +driver-impl-ibm-zvm=missing [operation.resume] title=Restore instance @@ -315,7 +315,7 @@ notes=The snapshot operation allows the current state of the snapshot cannot be assumed. Therefore this operation is not considered mandatory to support. cli=nova image-create -driver-impl-ibm-zvm=complete +driver-impl-ibm-zvm=missing [operation.suspend] title=Suspend instance diff --git a/doc/source/zvm.rst b/doc/source/zvm.rst new file mode 100644 index 0000000..4c2396b --- /dev/null +++ b/doc/source/zvm.rst @@ -0,0 +1,36 @@ +.. _zvm: + +================= +z/VM Introduction +================= + +This document gives basic information about z/VM itself and some history +about z/VM, for more detailed information, please refer to z/VM website +http://www.vm.ibm.com + +z/VM architecture +----------------- + +z/VM provides a highly secure and scalable enterprise cloud infrastructure +and an environment for efficiently running multiple diverse critical applications +on IBM z Systems and IBM LinuxONE with support for more virtual servers than +any other platform in a single footprint. +These z/VM virtual servers can run Linux, z/OS and more. + +Linux on IBM z Systems and IBM LinuxONE offer a uniquely powerful, high-performance +solution. Supreme efficiency for optimized workload deployment, innovative system +management with IBM Wave for z/VM, and the legendary performance and scalability +of z/VM come together to form a foundation for your Linux applications that is +simple, cost-effective, efficient, and secure. + +.. image:: ./images/zvm_arch.jpg + +z/VM history +------------ + +z/VM has over 45 years history and it's keep being used in wide industries such as +banking, securities, insurence etc. Following picture describe the evolution until +2011 and after that z/VM 6.3 , 6.4 has a set of new features to fit for old and new +customers and openstack enablement is also introduced. + +.. image:: ./images/zvm_history.jpg