Skip to content

Commit 14728c7

Browse files
committed
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
1 parent 8996162 commit 14728c7

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

doc/source/configuration.rst

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,9 @@ will not be set if there is no IPv6 address on the default Ethernet interface.
195195
Setting it here also makes it available for ``openrc`` to set ``OS_AUTH_URL``.
196196
``HOST_IPV6`` is not set by default.
197197

198+
For architecture specific configurations which differ from the x86 default
199+
here, see `arch-configuration`_.
200+
198201
Historical Notes
199202
================
200203

@@ -749,3 +752,60 @@ overridden by setting them in the ``localrc`` section.
749752
::
750753

751754
TERMINATE_TIMEOUT=30
755+
756+
757+
.. _arch-configuration:
758+
759+
Architectures
760+
-------------
761+
762+
The upstream CI runs exclusively on nodes with x86 architectures, but
763+
OpenStack supports even more architectures. Some of them need to configure
764+
Devstack in a certain way.
765+
766+
KVM on s390x (IBM z Systems)
767+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
768+
769+
KVM on s390x (IBM z Systems) is supported since the *Kilo* release. For
770+
an all-in-one setup, these minimal settings in the ``local.conf`` file
771+
are needed::
772+
773+
[[local|localrc]]
774+
ADMIN_PASSWORD=secret
775+
DATABASE_PASSWORD=$ADMIN_PASSWORD
776+
RABBIT_PASSWORD=$ADMIN_PASSWORD
777+
SERVICE_PASSWORD=$ADMIN_PASSWORD
778+
779+
DOWNLOAD_DEFAULT_IMAGES=False
780+
IMAGE_URLS="https://cloud-images.ubuntu.com/xenial/current/xenial-server-cloudimg-s390x-disk1.img"
781+
782+
enable_service n-sproxy
783+
disable_service n-novnc
784+
disable_service etcd3 # https://bugs.launchpad.net/devstack/+bug/1693192
785+
786+
[[post-config|$NOVA_CONF]]
787+
788+
[serial_console]
789+
base_url=ws://$HOST_IP:6083/ # optional
790+
791+
Reasoning:
792+
793+
* The default image of Devstack is x86 only, so we deactivate the download
794+
with ``DOWNLOAD_DEFAULT_IMAGES``. The referenced guest image
795+
in the code above (``IMAGE_URLS``) serves as an example. The list of
796+
possible s390x guest images is not limited to that.
797+
798+
* This platform doesn't support a graphical console like VNC or SPICE.
799+
The technical reason is the missing framebuffer on the platform. This
800+
means we rely on the substitute feature *serial console* which needs the
801+
proxy service ``n-sproxy``. We also disable VNC's proxy ``n-novnc`` for
802+
that reason . The configuration in the ``post-config`` section is only
803+
needed if you want to use the *serial console* outside of the all-in-one
804+
setup.
805+
806+
* The service ``etcd3`` needs to be disabled as long as bug report
807+
https://bugs.launchpad.net/devstack/+bug/1693192 is not resolved.
808+
809+
.. note:: To run *Tempest* against this *Devstack* all-in-one, you'll need
810+
to use a guest image which is smaller than 1GB when uncompressed.
811+
The example image from above is bigger than that!

0 commit comments

Comments
 (0)