From 3f8bf6ca100f3a11b4f18104dc3ca98f28bf2431 Mon Sep 17 00:00:00 2001
From: Michal Nasiadka <mnasiadka@gmail.com>
Date: Tue, 20 Aug 2019 18:04:04 +0200
Subject: [PATCH] Support matrix for Kolla

* Created support matrix for x86_64 and aarch64
* Populated with buildable vs unbuildable images
* Populated with images tested by k-a marked by T

Change-Id: I3f71dafc5f50dfdd2c44a70ba3c294c9308ce3b1
---
 doc/source/index.rst          |  8 +++
 doc/source/matrix_aarch64.csv | 99 +++++++++++++++++++++++++++++++++++
 doc/source/matrix_x86.csv     | 99 +++++++++++++++++++++++++++++++++++
 doc/source/support_matrix.rst | 65 +++++++++++++++++++++++
 4 files changed, 271 insertions(+)
 create mode 100644 doc/source/matrix_aarch64.csv
 create mode 100644 doc/source/matrix_x86.csv
 create mode 100644 doc/source/support_matrix.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 929471af86..53946b8d0d 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -57,3 +57,11 @@ Contributor Guide
    :maxdepth: 2
 
    contributor/index
+
+Support Matrix
+==============
+
+.. toctree::
+   :maxdepth: 2
+
+   support_matrix
diff --git a/doc/source/matrix_aarch64.csv b/doc/source/matrix_aarch64.csv
new file mode 100644
index 0000000000..d6e26ba727
--- /dev/null
+++ b/doc/source/matrix_aarch64.csv
@@ -0,0 +1,99 @@
+Image,CentOS,,Ubuntu,,Debian
+,Binary,Source,Binary,Source,Binary,Source
+almanach,N,C,N,C,N,C
+aodh,C,C,C,C,N,C
+barbican,C,C,C,C,N,C
+bifrost,N,C,N,N,N,N
+blazar,N,C,N,C,N,C
+ceilometer,C,C,C,C,N,C
+ceph,C,C,C,C,N,C
+certmonger,C,C,C,C,N,C
+chrony,C,C,C,C,N,C
+cinder,C,C,C,C,N,C
+cloudkitty,C,C,N,C,N,C
+collectd,C,C,C,C,N,C
+congress,C,C,N,C,N,C
+cron,C,C,C,C,N,C
+cyborg,N,N,N,N,N,N
+designate,C,C,C,C,N,C
+dind,C,C,C,C,N,C
+dnsmasq,C,C,C,C,N,C
+dragonflow,N,C,N,C,N,C
+ec2-api,C,C,C,C,N,C
+elasticsearch,N,N,C,C,N,C
+etcd,C,C,C,C,N,C
+fluentd,C,C,C,C,N,C
+freezer,N,C,N,C,N,C
+glance,C,C,C,C,N,C
+gnocchi,C,C,C,C,N,C
+grafana,C,C,C,C,N,C
+hacluster,N,N,C,C,N,C
+haproxy,C,C,C,C,N,C
+heat,C,C,C,C,N,C
+helm-repository,C,C,C,C,N,C
+horizon,C,C,C,C,N,C
+influxdb,N,N,C,C,N,C
+ironic,C,C,C,C,N,C
+ironic-neutron-agent,N,N,N,N,N,N
+ironic-inspector,N,N,N,N,N,N
+iscsid,C,C,C,C,N,C
+kafka,C,C,C,C,N,C
+karbor,N,C,N,C,N,C
+keepalived,C,C,C,C,N,C
+keystone,C,C,C,C,N,C
+kibana,N,N,N,N,N,N
+kolla-toolbox,C,C,C,C,N,C
+kube,C,C,C,C,N,C
+kubernetes-entrypoint,C,C,C,C,N,C
+kubetoolbox,C,C,C,C,N,C
+kuryr,N,C,N,C,N,C
+logstash,C,C,C,C,N,C
+magnum,C,C,C,C,N,C
+manila,C,C,C,C,N,C
+mariadb,C,C,C,C,N,C
+masakari,N,C,N,C,N,C
+memcached,C,C,C,C,N,C
+mistral,C,C,C,C,N,C
+monasca,N,N,N,N,N,N
+mongodb,N,N,C,C,N,N
+multipathd,C,C,C,C,N,C
+murano,C,C,C,C,N,C
+neutron,C,C,C,C,N,C
+nova,C,C,C,C,N,C
+novajoin,C,C,N,C,N,C
+octavia,C,C,N,C,N,C
+opendaylight,N,N,N,N,N,N
+openvswitch,C,C,C,C,N,C
+ovn,C,C,C,C,N,C
+ovsdpdk,N,N,C,C,N,N
+panko,C,C,C,C,N,C
+placement,C,C,N,C,N,C
+prometheus,C,C,C,C,N,C
+ptp,C,C,C,C,N,C
+qdrouterd,C,C,C,C,N,N
+qinling,N,C,N,C,N,C
+rabbitmq,C,C,C,C,N,C
+radvd,C,C,C,C,N,C
+rally,C,C,C,C,N,C
+redis,C,C,C,C,N,C
+rsyslog,C,C,C,C,N,C
+sahara,C,C,C,C,N,C
+searchlight,N,C,N,C,N,C
+senlin,C,C,C,C,N,C
+sensu,C,C,N,N,N,N
+skydive,C,C,N,N,N,N
+solum,N,C,N,C,N,C
+storm,C,C,C,C,N,C
+swift,C,C,C,C,N,C
+tacker,C,C,N,C,N,C
+telegraf,N,N,N,N,N,N
+tempest,C,N,C,N,N,N
+tgtd,C,C,C,C,N,C
+tripleoclient,N,N,N,N,N,N
+trove,C,C,N,C,N,C
+vitrage,C,C,N,C,N,C
+vmtp,N,C,N,C,N,C
+watcher,C,C,C,C,N,C
+zaqar,C,C,C,C,N,C
+zookeeper,C,C,C,C,N,C
+zun,N,C,N,C,N,C
diff --git a/doc/source/matrix_x86.csv b/doc/source/matrix_x86.csv
new file mode 100644
index 0000000000..f65d33d5fc
--- /dev/null
+++ b/doc/source/matrix_x86.csv
@@ -0,0 +1,99 @@
+Image,CentOS,,Ubuntu,,Debian
+,Binary,Source,Binary,Source,Binary,Source
+almanach,N,C,N,C,N,C
+aodh,C,C,C,C,N,C
+barbican,C,T,C,C,N,C
+bifrost,N,T,N,C,N,N
+blazar,N,C,N,C,N,C
+ceilometer,C,C,C,C,N,C
+ceph,C,T,C,T,N,C
+certmonger,C,C,C,C,N,C
+chrony,T,T,T,T,N,T
+cinder,C,T,C,T,N,C
+cloudkitty,C,C,N,C,N,C
+collectd,C,C,C,C,N,C
+congress,C,C,N,C,N,C
+cron,T,T,T,T,N,T
+cyborg,N,C,N,N,N,N
+designate,C,C,C,C,N,C
+dind,C,C,C,C,N,C
+dnsmasq,T,T,C,T,N,C
+dragonflow,N,C,N,C,N,C
+ec2-api,C,C,N,C,N,C
+elasticsearch,C,C,C,C,N,C
+etcd,C,T,C,T,N,C
+fluentd,T,T,T,T,N,T
+freezer,N,C,N,C,N,C
+glance,T,T,T,T,N,T
+gnocchi,C,C,C,C,N,C
+grafana,C,C,C,C,N,C
+hacluster,C,C,C,C,N,C
+haproxy,T,T,T,T,N,C
+heat,T,T,N,T,N,T
+helm-repository,C,C,C,C,N,C
+horizon,T,T,T,T,N,T
+influxdb,C,C,C,C,N,C
+ironic,T,T,C,T,N,C
+ironic-neutron-agent,T,T,N,T,N,C
+ironic-inspector,T,T,C,T,N,C
+iscsid,T,T,T,T,N,C
+kafka,C,C,C,C,N,C
+karbor,N,C,N,C,N,C
+keepalived,T,T,T,T,N,C
+keystone,T,T,T,T,N,T
+kibana,C,C,C,C,N,C
+kolla-toolbox,T,T,T,T,N,T
+kube,C,C,C,C,N,C
+kubernetes-entrypoint,C,C,C,C,N,C
+kubetoolbox,C,C,C,C,N,C
+kuryr,N,T,N,T,N,C
+logstash,C,C,C,C,N,C
+magnum,C,C,C,C,N,C
+manila,C,C,C,C,N,C
+mariadb,T,T,T,T,N,T
+masakari,N,T,N,T,N,C
+memcached,T,T,T,T,N,C
+mistral,C,T,N,C,N,C
+monasca,N,C,N,C,N,N
+mongodb,C,C,C,C,N,N
+multipathd,C,C,C,C,N,C
+murano,C,C,C,C,N,C
+neutron,T,T,T,T,N,T
+nova,T,T,T,T,N,T
+novajoin,C,C,N,C,N,C
+octavia,C,C,N,C,N,C
+opendaylight,C,C,C,C,N,N
+openvswitch,T,T,T,T,N,T
+ovn,C,C,C,C,N,C
+ovsdpdk,N,N,C,C,N,N
+panko,C,C,C,C,N,C
+placement,T,T,T,T,N,T
+prometheus,C,C,C,C,N,C
+ptp,C,C,C,C,N,C
+qdrouterd,C,C,N,N,N,N
+qinling,N,C,N,C,N,C
+rabbitmq,T,T,T,T,N,T
+radvd,C,C,C,C,N,C
+rally,C,C,C,C,N,C
+redis,C,T,C,C,N,C
+rsyslog,C,C,C,C,N,C
+sahara,C,C,C,C,N,C
+searchlight,N,C,N,C,N,C
+senlin,C,C,C,C,N,C
+sensu,C,C,C,C,N,N
+skydive,C,C,C,C,N,C
+solum,N,C,N,C,N,C
+storm,C,C,C,C,N,C
+swift,C,C,C,C,N,C
+tacker,C,T,N,C,N,C
+telegraf,C,C,C,C,N,N
+tempest,C,C,C,C,N,C
+tgtd,C,T,C,T,N,C
+tripleoclient,C,N,N,N,N,N
+trove,C,C,C,C,N,C
+vitrage,C,C,N,C,N,C
+vmtp,N,C,N,C,N,C
+watcher,C,C,C,C,N,C
+zaqar,C,C,N,C,N,C
+zookeeper,C,C,C,C,N,C
+zun,N,T,N,T,N,C
diff --git a/doc/source/support_matrix.rst b/doc/source/support_matrix.rst
new file mode 100644
index 0000000000..090adc0e0a
--- /dev/null
+++ b/doc/source/support_matrix.rst
@@ -0,0 +1,65 @@
+.. _support_matrix:
+
+===========================
+Kolla Images Support Matrix
+===========================
+
+Support clause definitions
+==========================
+
+T - Tested
+----------
+
+Coverage:
+
+* CI in ``kolla-ansible`` is testing that images are functional
+* kolla core team is maintaining versions
+
+M - Maintained
+--------------
+
+Coverage:
+
+* kolla core team is maintaining versions
+
+C - Community maintained
+------------------------
+
+Coverage:
+
+* supported by the broader community (not core team) or not supported at all
+
+N - Not Available/Unknown
+-------------------------
+
+Not available *(e.g. not buildable)*.
+Please see :ref:`unbuildable-images-list`
+
+x86_64 images
+=============
+
+.. csv-table:: x86_64 images
+   :header-rows: 2
+   :stub-columns: 1
+   :file: ./matrix_x86.csv
+
+aarch64 images
+==============
+
+.. csv-table:: aarch64 images
+   :header-rows: 2
+   :stub-columns: 1
+   :file: ./matrix_aarch64.csv
+
+ppc64le images
+==============
+
+.. note:: TODO
+
+.. _unbuildable-images-list:
+
+Currently unbuildable images
+============================
+
+For a list of currently unbuildable images please look into
+``kolla/image/build.py`` file - ``UNBUILDABLE_IMAGES`` dictionary.