Browse code

docs: add "kvm on s390x" specific configuration in `local.conf`

The upstream CI runs exclusively on nodes with x86 architectures, but
OpenStack supports even more platforms. One of them is the KVM
on s390x (IBM z systems), which is supported since the *Kilo* release.
This change describes the additional settings in the ``local.conf`` file
to enable Devstack on that platform. This is useful for PoCs.

Change-Id: I943b552ca2e36210ac57f36c16db930eb5e58623

Markus Zoeller authored on 2017/05/29 22:39:21
Showing 1 changed files
... ...
@@ -195,6 +195,9 @@ will not be set if there is no IPv6 address on the default Ethernet interface.
195 195
 Setting it here also makes it available for ``openrc`` to set ``OS_AUTH_URL``.
196 196
 ``HOST_IPV6`` is not set by default.
197 197
 
198
+For architecture specific configurations which differ from the x86 default
199
+here, see `arch-configuration`_.
200
+
198 201
 Historical Notes
199 202
 ================
200 203
 
... ...
@@ -749,3 +752,60 @@ overridden by setting them in the ``localrc`` section.
749 749
     ::
750 750
 
751 751
         TERMINATE_TIMEOUT=30
752
+
753
+
754
+.. _arch-configuration:
755
+
756
+Architectures
757
+-------------
758
+
759
+The upstream CI runs exclusively on nodes with x86 architectures, but
760
+OpenStack supports even more architectures. Some of them need to configure
761
+Devstack in a certain way.
762
+
763
+KVM on s390x (IBM z Systems)
764
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
765
+
766
+KVM on s390x (IBM z Systems) is supported since the *Kilo* release. For
767
+an all-in-one setup, these minimal settings in the ``local.conf`` file
768
+are needed::
769
+
770
+    [[local|localrc]]
771
+    ADMIN_PASSWORD=secret
772
+    DATABASE_PASSWORD=$ADMIN_PASSWORD
773
+    RABBIT_PASSWORD=$ADMIN_PASSWORD
774
+    SERVICE_PASSWORD=$ADMIN_PASSWORD
775
+
776
+    DOWNLOAD_DEFAULT_IMAGES=False
777
+    IMAGE_URLS="https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-s390x-disk1.img"
778
+
779
+    enable_service n-sproxy
780
+    disable_service n-novnc
781
+    disable_service etcd3  # https://bugs.launchpad.net/devstack/+bug/1693192
782
+
783
+    [[post-config|$NOVA_CONF]]
784
+
785
+    [serial_console]
786
+    base_url=ws://$HOST_IP:6083/  # optional
787
+
788
+Reasoning:
789
+
790
+* The default image of Devstack is x86 only, so we deactivate the download
791
+  with ``DOWNLOAD_DEFAULT_IMAGES``. The referenced guest image
792
+  in the code above (``IMAGE_URLS``) serves as an example. The list of
793
+  possible s390x guest images is not limited to that.
794
+
795
+* This platform doesn't support a graphical console like VNC or SPICE.
796
+  The technical reason is the missing framebuffer on the platform. This
797
+  means we rely on the substitute feature *serial console* which needs the
798
+  proxy service ``n-sproxy``. We also disable VNC's proxy ``n-novnc`` for
799
+  that reason . The configuration in the ``post-config`` section is only
800
+  needed if you want to use the *serial console* outside of the all-in-one
801
+  setup.
802
+
803
+* The service ``etcd3`` needs to be disabled as long as bug report
804
+  https://bugs.launchpad.net/devstack/+bug/1693192 is not resolved.
805
+
806
+.. note:: To run *Tempest* against this *Devstack* all-in-one, you'll need
807
+   to use a guest image which is smaller than 1GB when uncompressed.
808
+   The example image from above is bigger than that!