From d00a058faba08888a085611f6fa968184173df3e Mon Sep 17 00:00:00 2001 From: Scott Little Date: Tue, 11 Apr 2023 14:04:24 -0400 Subject: [PATCH] Several fixes to get thing compiling correctly. Removed an erronious reference to integ from libvirt's meta_data.yaml. Fix revcounts for relocated qemu and libvirt. Added ${OS}_build_layer.cfg file so that the build system won't ignore this repo. Add a zuul setup. Add minimal doc and release notes setup. Testing: build-pkgs -c -a: pass build-pkgs -p libvirt,qemu: pass build-iso: pass Story: 2010317 Task: 47779 Signed-off-by: Scott Little Change-Id: Id31df64f0182a6ae48ac4034100183e11218e988 --- .zuul.yaml | 264 +++++++++++++++++++++++++++++ centos_build_layer.cfg | 1 + debian_build_layer.cfg | 1 + doc/requirements.txt | 5 + doc/source/conf.py | 160 +++++++++++++++++ doc/source/index.rst | 26 +++ libvirt/debian/meta_data.yaml | 3 +- qemu/debian/meta_data.yaml | 3 +- releasenotes/source/conf.py | 257 ++++++++++++++++++++++++++++ releasenotes/source/index.rst | 8 + releasenotes/source/unreleased.rst | 5 + test-requirements.txt | 3 + tox.ini | 11 -- 13 files changed, 734 insertions(+), 13 deletions(-) create mode 100644 .zuul.yaml create mode 100644 centos_build_layer.cfg create mode 100644 debian_build_layer.cfg create mode 100644 doc/requirements.txt create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst create mode 100644 releasenotes/source/conf.py create mode 100644 releasenotes/source/index.rst create mode 100644 releasenotes/source/unreleased.rst create mode 100644 test-requirements.txt diff --git a/.zuul.yaml b/.zuul.yaml new file mode 100644 index 0000000..dd73f93 --- /dev/null +++ b/.zuul.yaml @@ -0,0 +1,264 @@ +--- +- project: + templates: + - publish-stx-docs + - stx-release-notes-jobs + check: + jobs: + - openstack-tox-pep8 + - openstack-tox-linters + - stx-virt-pylint + gate: + jobs: + - openstack-tox-pep8 + - openstack-tox-linters + - stx-virt-pylint + post: + jobs: + - stx-virt-upload-git-mirror + +# This is the common base job definition for StarlingX flock services +- job: + name: flock-devstack-virt-base + parent: devstack + description: | + Base job for StarlingX Flock components DevStack tests + nodeset: openstack-single-node-bionic + roles: + - zuul: openstack/devstack + timeout: 9000 + required-projects: + - name: openstack/devstack + - name: openstack/keystone + - name: openstack/requirements + vars: + devstack_services: + ceilometer-acentral: false + ceilometer-acompute: false + ceilometer-alarm-evaluator: false + ceilometer-alarm-notifier: false + ceilometer-anotification: false + ceilometer-api: false + ceilometer-collector: false + horizon: false + # Swift services + s-account: false + s-container: false + s-object: false + s-proxy: false + tempest: false + # Database + mysql: false + postgresql: true + devstack_localrc: + # LIBS_FROM_GIT: keystone + FORCE: yes + +# A minimal base job that eliminates most OpenStack services +# Leave Celiometer, Horizon and Swift in the base since none +# of our jobs need them. +- job: + name: flock-devstack-virt-base-min + parent: flock-devstack-virt-base + timeout: 7800 + vars: + devstack_services: + # Cinder services + c-api: false + c-bak: false + c-sch: false + c-vol: false + cinder: false + # Glance services + g-api: false + g-reg: false + # Nova services + n-api: false + n-api-meta: false + n-cauth: false + n-cond: false + n-cpu: false + n-novnc: false + n-obj: false + n-sch: false + placement-api: false + # Neutron services + q-agt: true + q-dhcp: false + q-l3: false + q-meta: false + q-metering: false + q-svc: false + +# An equivalent tox-based functional test job to flock-devstack-virt-base +- job: + name: flock-devstack-virt-tox-base + parent: devstack-tox-functional + description: | + Base job for StarlingX Flock components DevStack tests that use tox + nodeset: openstack-single-node-bionic + roles: + - zuul: openstack/devstack + timeout: 9000 + required-projects: + - name: openstack/devstack + - name: openstack/keystone + - name: openstack/requirements + vars: + devstack_services: + ceilometer-acentral: false + ceilometer-acompute: false + ceilometer-alarm-evaluator: false + ceilometer-alarm-notifier: false + ceilometer-anotification: false + ceilometer-api: false + ceilometer-collector: false + horizon: false + # Swift services + s-account: false + s-container: false + s-object: false + s-proxy: false + tempest: false + # Database + mysql: false + postgresql: true + devstack_localrc: + # LIBS_FROM_GIT: keystone + FORCE: yes + +# And the tox version of the base-min job +- job: + name: flock-devstack-virt-tox-base-min + parent: flock-devstack-virt-tox-base + timeout: 7800 + vars: + devstack_services: + # Cinder services + c-api: false + c-bak: false + c-sch: false + c-vol: false + cinder: false + # Glance services + g-api: false + g-reg: false + # Nova services + n-api: false + n-api-meta: false + n-cauth: false + n-cond: false + n-cpu: false + n-novnc: false + n-obj: false + n-sch: false + placement-api: false + # Neutron services + q-agt: true + q-dhcp: false + q-l3: false + q-meta: false + q-metering: false + q-svc: false + +# Try this as a tox-based job with a minimal functional target in tox.ini +- job: + name: stx-virt-pylint + parent: tox + required-projects: + - starlingx/config + vars: + tox_envlist: pylint + tox_extra_args: -c tox.ini + +- job: + name: stx-virt-upload-git-mirror + parent: upload-git-mirror + description: > + Mirrors opendev.org/starlingx/virt to + github.com/starlingx/virt + vars: + git_mirror_repository: starlingx/virt + secrets: + - name: git_mirror_credentials + secret: stx-virt-github-secret2 + pass-to-parent: true + +- secret: + name: stx-virt-github-secret2 + data: + user: git + host: github.com + # yamllint disable-line rule:line-length + host_key: github.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQCj7ndNxQowgcQnjshcLrqPEiiphnt+VTTvDP6mHBL9j1aNUkY4Ue1gvwnGLVlOhGeYrnZaMgRK6+PKCUXaDbC7qtbW8gIkhL7aGCsOr/C56SJMy/BCZfxd1nWzAOxSDPgVsmerOBYfNqltV9/hWCqBywINIR+5dIg6JTJ72pcEpEjcYgXkE2YEFXV1JHnsKgbLWNlhScqb2UmyRkQyytRLtL+38TGxkxCflmO+5Z8CSSNY7GidjMIZ7Q4zMjA2n1nGrlTDkzwDCsw+wqFPGQA179cnfGWOWRVruj16z6XyvxvjJwbz0wQZ75XK5tKSb7FNyeIEs4TT4jk+S4dhPeAUC5y+bDYirYgM4GC7uEnztnZyaVWQ7B381AK4Qdrwt51ZqExKbQpTUNn+EjqoTwvqNj4kqx5QUCI0ThS/YkOxJCXmPUWZbhjpCg56i+2aB6CmK2JGhn57K5mj0MNdBXA4/WnwH6XoPWJzK5Nyu2zB3nAZp+S5hpQs+p1vN1/wsjk= + ssh_key: !encrypted/pkcs1-oaep + - icjzXfndPsxGxPnrCl7OTVU91K290gQbSS7jvP4DtbwDjz42WOORSwlMgKS7qtN7c1IZd + belENEJimK+Yf3Wc/72xxA+hjZ5nCU1MmZiNNqMqpKbtzMS8jbnZquyHu1tYSTldOfsAn + 1kAt4SZD5ho9S3pulkbcN5CKLiPaPJaGgIBq9KGJikkH45GcgEFBQHJIoaZ7HY4C+0ahr + mM7Dzd5WMffFlW7NKm/gdWgt/LzziAplkLKms1FmIox0yJobDCLi+Y7nRWnRarJrcHRKW + m4MHTt1mIMXKfYCNDAJopqCxXm7xSAX/J8slcyypQRUH/jDOxZJLC4ZuqkHxUxUDHBOG0 + 8XCgO8QwHsUuybbaxvcMSTTp7JRw9yiWu98a5IOQ6Uuuen+HvsYVFGmL/P24mmkqrNzUD + osVE6c/AwhhYt0sE3TxQgysPOiktS3hVzdlDAb6UyC7/4S7Jy7uE/zW1hD1sIcmFKYosQ + 56ldoYm5p6BCoQC6HTh5BgQYCf6YXct05TJnDXWEAm+z19JjQawlYMp1jGVvbIfhfbMF6 + FeWFJyg+XEbr9RYmaZFNw90uCZjy4PurfVj71PLsTq32e+20HpPae7yan8PHwECRkPfwJ + AU9fcBx9p/4857XZItXTDvnvYVw2XaP+7YkM1nmIE2kM0mYi2qqVkDvJ+cV0/c= + - YNtnZ/zTzkYa0ebNwoUyJWB6WMxKTwbG3mBQDn3IC1l/Hbrw7XeS6Lf0rws3hTxrPoMJT + zpWnXekFK+iv6dGcbb0OXzEnn6anjigwIGq3T8HeWzLODPYS9+W+IwOd8RV8TkzDhknC9 + dOT+81rWcLLkQbDKjHgsnntXkY1S0VWSoKulrewRk4jzWd6wvLhi03UkhyO22F8hPFjcx + QDVS5MIhif662wmYO+OorhYQJbmRda8VZXsEGeTBefMk4f/Y54U3673uqWPM4/SHR0vha + izPAKaB9S92tHNyeuDAIrTfWtbpN5MYsc7U3bZs5SEdAjOOEhD0CUbSSL0qaz7nkcE47j + N0zJgchqis1Dev7QdZYvns4A5kaKKoUtg1xvRBF+pb/YyTYcpC3ILeB5XQ7/vVCkfER3t + E6htIXP7yD/Lvydjx1uuAwWELYqdCQhdU8MvQ/e48EGy2BNRAUQ+sRonkryRxfRTFiLRw + 1wx7f2RSGcquXanjhulkou7gbEnTzAXcd+RLNo19q/a/xeDBOjRqVyalrSUJdHHZvKr81 + 4ii6oxUPmcJTe7n7jfKpUE8P5Pq0i4Pzyc9sSjyR040LQqT3lxUjAgkgcE2OCsLFKCL7q + EJbfvR5LFwowpm6hleaJ8Bc/ZCjzbmLGAAD3/mRFs4uIvHpK6QgDOKE2ebYTVY= + - Mk9e5qJx58NFlf1hZSyJRIvxHZxa2y/XD+W+H7u1X3mc5UMEPMc4pa++ZrOQ4pVSMtC0M + /hyvsbhg9d4h2v+xTwvA/s6ZqPAy6Y1xFKtdbj1r7yjEtI7vbJDI3TahjDcrqj+cLtfj5 + z1qKvZcA4ElNM44M5QLacOJIpyQ9Lu53kWQ5pNEVixLCYdxyrAIjQlqih+rn/fDYXJHwf + n2ekfLcnOW8o7fhl5Vtb6eNA+PH2MpiWCUqjEgLdPvv1t8QNDRYMMNsVT2sGd2eny1l30 + edDiYH1Nx3lJmjioV2wDRHqFA9LUke8zQ6lO5geEXp0sSeWoFOG85Rm6ohHnR6mQ8TDXc + kUUqZ3GjDvT3xFXaR/0YkGPh4G+yFl/L1CrLNSvOgHcqefj7qHAA/P/JM82N+QdNRtxR5 + kNyo65/31ZbEZzZas/3MslsJv7WgGxg6MljPoArpCO+JiVoqNH4fJFfQ+rPkAauZJGaOS + R4eNedPRyA9PlTEHbCHzJDYdSAdqxo663J4y+OaJkW57vXQVj51AqZSW6Lak+F59jF3cq + hJuRh3K3skZHyzyIv74PRcKEvJIi1N73GHCqdOgu/8gTDU58OUGa6nKlh4o44zrDUBiqs + YTOzFuSAZuJEPG0720CnfgdABgivI5hXqvSPYOLpMLuofdIIB4WTyLhbvUMNvs= + - XgcUS8+UNwPhlSjEU5NMgmlYA2xPfnxl3utsn5UhFfWsgW61Y6+Y5d4OHkUyHDZwK6fX2 + /a8gDpoFc1Tffc/fWufKZ2+hwhFFhUrbLCu05z74lcAwEF0p111L9GQu7gyEjJg6dcISF + DSn4AkY92cIKx2YAj6BxAaN1j6kONptwRChYWX6dmlyVPEb08zAwKnvxwZ514/QiJi8NA + G4lGVDKbttjihggmneFIhAXAU6yr3nPaYXjESeeGC6LlZ+E2ZfP9nY78lnle0EHJkFnF4 + xIwpGlpK+WhSxwZlF+qxlazXcG0gxN2gV8O1dRMv3ebPk0RiTmYnqN+sClNtRN8/XtZxU + gWyCt90OnDhafeOu/bbcdyrI2TpHUb2QmCB0ru44a7GPT1VHrb6Q1E3JXHyrIPdRWfH0o + TJkkcwHh2qsS0fL5FV6oJ8E4JpWbTc8FfTPxHh7bpRTWTUDd3zA6TOp3qoMN+VQk94b5L + KEFC9BDrcH4TryY9Sq4g2+1uGTimB4ybkhOzdEOATVqeX9epXK7XQQ/xZTv9D7gemYZoa + 67fEOiqyOM3M54hbTJ33GGbDkaNN4q2/bjhMoeyGJyIqpjxcxHFo4YyGppmVKih6Pm9wP + HqD1Qz7xL4OP9PXUagHTmQrpIRTur6p9RJu2MwYLYix/5TMsQoxAStZPEnJxcs= + - CC5qETnzzvPx/l7dI5wTysZw3mP81a51Lo077EMxqc1T8jj2S+pxvGsAAdX45aWKHnU/K + rEG5QD92xT4gNvpZphXu0hPAfMdhqpMvrj4HetnYRnFt6f2lUdJSbWhjPq5fhFTDkDEVm + YmVWYTOq/mbIPAO2IjNyET7bL4DQrDt7sqLBMUuXjvZ7yUM1pLSYiE4M8jDM3RhPvlkdR + 1ps5o9EVf52T/GdistIY/Aq27RCGphqTqC63Wo1uILr108o/lySs7Oi1Ka2s82jrboBhY + k8f1exEd5ea4TykRzvTa574Sc9AD/9oRpG1kgkrCKBPjAqvDYXGQJg232iiZwtU32oyaf + eu6sP3hbdCMARaNEJoaeX0Z/marsOD7Wq5r2DO5Ozy5KBLZ8yT4f2eM6rzuqe849v2mkW + Iz6CJBswf2MRAi+fTsv69kDocnoCFqXB9j1j/Qv4vpWvl26bxWfiGvn8wdJ5OPjl9MTo0 + 71A7f5czZ495XAjswm4OJIP+FdMnlLz0aeDNwylQ/8aR1+V4Cg0VXcmpl86RASBezshzR + WIB5toLzcQE5/85Wv/KjadWBkah4BonnZEZXLqWUSP0Q3h+AbQRtyWk6h3AKOQ9IJJpcV + 8/hwfx5ExVJA1hoKnaKPOqHbeSpS7gYkEPQoEnLJoQZe0Xb9qFOfgPlZWUeIOs= + - d2CvahkxKFwqKxHh70QNrS4nvjxr7mPAun0qJTlw5i8iozvbFccGJv+j/D0O5KS9yktE8 + jIkjeLt1r8ug2CrYe0OoXwdUZ5XFcUnd6VS2g7pLJTJv6SUxw51i8VjuPcsElYe/uNOgm + 9aEqegDkACLH3SnoH0j9mk+EGKE1LlSBFNDxqW/CF+4/OKR8Io68jy2c7x9wBCXpfXJEJ + KX2vCkvgWfTNKhE+iv8ghmpEHM1a4gbuJpP77EUlqtLEyfE63qwHQwjNsunDG9A+H8VBN + Td+Tb4rFIygtgO8XXuPyqNIViz2JpBmcTFXgwl6cNnd5kHYypvVphl61Vqqpl/VhJDWqy + cPZHFn3ECekBdGiyl+6wELVujsjVBgcWd+03gd8bALTJiYEmvLUH2c7N3LYDvidNrCw1Y + 8hI4nT2GUSc6MXuKRNiEf3tjiGpRoBx/YkOM6gATw7FkNLt1v01cFTmNXjBzfiK03ToIy + xhiY00giU90SjI+Pw811jxMpZ70mBPnfCzk1LRhHMF0fqVv41x8o9hdVCk5z8Ovo7exe5 + GBzQHthL+X3eTxSwwnzvl8XL5YwM3tgv6WFUeAdsPnbkvVUf5MJgkDKlAm8SIBCE0Sqij + bLbZ8GVJmay33wKIqIX0yZA/2ky5UmumYysAYaI8BD8B3nlCzUIEuw/fDhGj/k= + - aO+7lYZQ0YJ8lhK+efX0iGFe9x7eEWCUZYZxnTsSiWqDs84ZaBqRNV/+nf0d8bLpbx2sY + W9elpqbI92829rTYWFm9+HHTZL/JNVnR7n70W2fjdQsXKMwojMfsACt11f/AKDBGrJsQj + O6DtfcTP+k5snmckiRNhU2v5kWAjMlBh6XWguLbwjiVY1syQIXVSc8oqOrZZHE0/HvGYF + XHj3nAjZuQB06DTKCDcspvrEei3ivkfX/GZzb+w3DQiz0H6UUnlqLFUnZO1c7gX8xm/aO + sjMI9/0taO1/97cXJbbT9TizP4YQxvcA3iiEOAUx2F+6Xf5Edbr/A3SmCWLZKl9isx5Da + RJqKvmLkgt7TQKRxvVHqCLqpxgZYUAFcDr/zCfI8T8KsmvziZrtzfb9qL+nPsa7G32sWB + /xaCuzqs2SNTIRgYVJO5x4Vv4p2gG/Gn5ZGQEvL+9Oj+aSvs6FlJfrKyP1aLVmhHO5nzL + 36I+7c0J8+ZE4WjIzyN0A2y79StA73UWUg/CRMLVujMl/kVyf5QVobqyAqdW1EnuCL3vR + xLRYxys7fu87VzdWML4BpmeE3GTn+y/LBhj62i4X20pHstlq3BN5X/19PXzRjsZzkzaCN + oQohM9fqgggckruk4RlpxH77NoNqhI/r2fTL24FX5x5tg6UAbIsuEaM6Hs38FM= diff --git a/centos_build_layer.cfg b/centos_build_layer.cfg new file mode 100644 index 0000000..0e09331 --- /dev/null +++ b/centos_build_layer.cfg @@ -0,0 +1 @@ +distro diff --git a/debian_build_layer.cfg b/debian_build_layer.cfg new file mode 100644 index 0000000..0e09331 --- /dev/null +++ b/debian_build_layer.cfg @@ -0,0 +1 @@ +distro diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 0000000..f9f7a73 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,5 @@ +sphinx>=2.0.0,!=2.1.0 # BSD +openstackdocstheme>=2.2.1 # Apache-2.0 + +# Release Notes documentation +reno>=3.1.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 0000000..5875c6e --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,160 @@ +# -*- coding: utf-8 -*- +# +# SPDX-License-Identifier: Apache-2.0 + +# Configuration file for the Sphinx documentation builder. +# +# This file does only contain a selection of the most common options. For a +# full list see the documentation: +# http://www.sphinx-doc.org/en/master/config + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another +# directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown +# here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = u'StarlingX Virtualization' +copyright = u'2018, StarlingX' +author = u'StarlingX' + +# -- General configuration --------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'openstackdocstheme', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/virt' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False + + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path . +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'native' + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'starlingxdocs' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# The default sidebars (for documents that don't match any pattern) are +# defined by theme itself. Builtin themes are using these templates by +# default: ``['localtoc.html', 'relations.html', 'sourcelink.html', +# 'searchbox.html']``. +# +# html_sidebars = {} + + +# -- Options for HTMLHelp output --------------------------------------------- + +# Output file base name for HTML help builder. +htmlhelp_basename = 'stx-virtdoc' + + +# -- Options for LaTeX output ------------------------------------------------ + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'stx-virt.tex', u'stx-virt Documentation', + u'StarlingX', 'manual'), +] + + +# -- Options for manual page output ------------------------------------------ + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'stx-virt', u'stx-virt Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ---------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'stx-virt', u'stx-virt Documentation', + author, 'stx-virt', 'StarlingX Virtualization.', + 'Miscellaneous'), +] diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..e5dcdef --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,26 @@ +=================================== +StarlingX Virtualization Project +=================================== + +The starlingx/virt project provides virtualization for StarlingX. + +------------- +Release notes +------------- + +.. toctree:: + :maxdepth: 1 + + Release notes + +----- +Links +----- + +* Source: `starlingx/virt`_ +* Code review: `Gerrit`_ +* Project tracking: `Storyboard`_ + +.. _starlingx/virt: https://opendev.org/starlingx/virt +.. _Gerrit: https://review.opendev.org/#/q/project:starlingx/virt +.. _Storyboard: https://storyboard.openstack.org/#!/project/starlingx/virt diff --git a/libvirt/debian/meta_data.yaml b/libvirt/debian/meta_data.yaml index 6f978b7..159160a 100644 --- a/libvirt/debian/meta_data.yaml +++ b/libvirt/debian/meta_data.yaml @@ -13,4 +13,5 @@ src_files: - libvirt/hooks/qemu revision: dist: $STX_DIST - PKG_GITREVCOUNT: true + GITREVCOUNT: + BASE_SRCREV: 365de7ff2a68fff20d124fe90a90546e3f7e824f diff --git a/qemu/debian/meta_data.yaml b/qemu/debian/meta_data.yaml index 79f24b2..46f6451 100644 --- a/qemu/debian/meta_data.yaml +++ b/qemu/debian/meta_data.yaml @@ -4,4 +4,5 @@ debver: 5.2+dfsg-11+deb11u2 archive: https://snapshot.debian.org/archive/debian/20221109T211529Z/pool/main/q/qemu/ revision: dist: $STX_DIST - PKG_GITREVCOUNT: true + GITREVCOUNT: + BASE_SRCREV: 6c31d19c898a666c597a439cd70d431ca52fd9e3 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py new file mode 100644 index 0000000..9a3a9f4 --- /dev/null +++ b/releasenotes/source/conf.py @@ -0,0 +1,257 @@ +# -*- coding: utf-8 -*- +# +# SPDX-License-Identifier: Apache-2.0 + +# stx-virt Release Notes documentation build configuration file. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'openstackdocstheme', + 'reno.sphinxext', +] + +# openstackdocstheme options +openstackdocs_repo_name = 'starlingx/virt' +openstackdocs_use_storyboard = True +openstackdocs_auto_name = False + +# Add any paths that contain templates here, relative to this directory. +# templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +project = u'StarlingX Integration' + +# Release notes are version independent, no need to set version and release +release = '' +version = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'native' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'starlingxdocs' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +# html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +# html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +# html_extra_path = [] + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'stx-virtreleasenotesdoc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'stx-virtreleasenotes.tex', u'stx-virt Release Notes', + u'StarlingX', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'stx-virtreleasenotes', u'stx-virt Release Notes', + [u'StarlingX'], 1) +] + +# If true, show URL addresses after external links. +# man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'stx-virtReleaseNotes', u'stx-virt Release Notes', + u'StarlingX', 'stx-virtreleasenotes', + 'StarlingX Integration and Packaging', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +# texinfo_appendices = [] + +# If false, no module index is generated. +# texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +# texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +# texinfo_no_detailmenu = False + +# -- Options for Internationalization output ------------------------------ +locale_dirs = ['locale/'] diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst new file mode 100644 index 0000000..606ab2c --- /dev/null +++ b/releasenotes/source/index.rst @@ -0,0 +1,8 @@ +====================================== +StarlingX Virtualization Release Notes +====================================== + +.. toctree:: + :maxdepth: 2 + + unreleased diff --git a/releasenotes/source/unreleased.rst b/releasenotes/source/unreleased.rst new file mode 100644 index 0000000..875030f --- /dev/null +++ b/releasenotes/source/unreleased.rst @@ -0,0 +1,5 @@ +============================ +Current Series Release Notes +============================ + +.. release-notes:: diff --git a/test-requirements.txt b/test-requirements.txt new file mode 100644 index 0000000..47d1aec --- /dev/null +++ b/test-requirements.txt @@ -0,0 +1,3 @@ +bashate >= 0.2 +PyYAML >= 3.1.0 +yamllint >= 0.5.2 diff --git a/tox.ini b/tox.ini index 00bc2d2..4ae07e7 100644 --- a/tox.ini +++ b/tox.ini @@ -26,8 +26,6 @@ allowlist_externals = bash #E044 Use [[ for non-POSIX comparisions commands = bash -c "find {toxinidir} \ - -path {toxinidir}/kubernetes/plugins/isolcpus-device-plugin/files/vendor -prune -o \ - -path {toxinidir}/tools/kexec-tools/files -prune -o \ -not \( -type d -name .?\* -prune \) \ -type f \ -not -name \*~ \ @@ -89,15 +87,6 @@ deps = commands = flake8 -[testenv:pylint] -basepython = python3 -deps = -r{toxinidir}/test-requirements.txt - -e{[tox]stxdir}/config/sysinv/cgts-client/cgts-client - pylint - -# Currently only one python module with a setup.py file -commands = pylint --rcfile=./pylint.rc \ - tools/storage-topology/storage-topology/storage_topology [testenv:venv] basepython = python3