diff options
| author | Michal Nasiadka <mnasiadka@gmail.com> | 2020-02-14 11:03:02 +0100 |
|---|---|---|
| committer | Radosław Piliszek <radoslaw.piliszek@gmail.com> | 2020-05-20 11:53:24 +0200 |
| commit | f3f471b41e6702d30ff45b4fb25b8b84bb030b52 (patch) | |
| tree | 1c6e9ca9940f53368b11708ab002902a4206d24b /doc/source/contributor/CONTRIBUTING.rst | |
| parent | 629a2955f4c7838aae526f5af8c81db96f34a8b4 (diff) | |
| download | kolla-f3f471b41e6702d30ff45b4fb25b8b84bb030b52.tar.gz kolla-f3f471b41e6702d30ff45b4fb25b8b84bb030b52.zip | |
[Community goal] Update the contributor guide
Co-authored-by: Radosław Piliszek <radoslaw.piliszek@gmail.com>
Change-Id: I50e2bf6aac38624851edb15ecb108cade469ddad
Story: #2007236
Task: #38531
Diffstat (limited to 'doc/source/contributor/CONTRIBUTING.rst')
| -rw-r--r-- | doc/source/contributor/CONTRIBUTING.rst | 136 |
1 files changed, 0 insertions, 136 deletions
diff --git a/doc/source/contributor/CONTRIBUTING.rst b/doc/source/contributor/CONTRIBUTING.rst deleted file mode 100644 index b598178bc..000000000 --- a/doc/source/contributor/CONTRIBUTING.rst +++ /dev/null @@ -1,136 +0,0 @@ -================= -How To Contribute -================= - -Basics -====== - -#. Our source code is hosted on `OpenDev Kolla Git - <https://opendev.org/openstack/kolla/>`_. Bugs should be filed on - `launchpad <https://bugs.launchpad.net/kolla>`_. - -#. Please follow OpenStack `Gerrit Workflow - <https://docs.openstack.org/infra/manual/developers.html#development-workflow>`__ - to contribute to Kolla. - -#. Note the branch you're proposing changes to. ``master`` is the current focus - of development. Kolla project has a strict policy of only allowing backports - in ``stable/branch``, unless when not applicable. A bug in a - ``stable/branch`` will first have to be fixed in ``master``. - -#. Please file a `blueprint of kolla <https://blueprints.launchpad.net/kolla>`__ - for any significant code change and a bug - for any significant bug fix. See how to reference a bug or a blueprint in - the `commit message <https://wiki.openstack.org/wiki/GitCommitMessages>`_. - For simple changes, contributors may optionally add the text "TrivialFix" to - the commit message footer to indicate to reviewers a bug is not required. - -#. We use a `whiteboard <https://etherpad.openstack.org/p/KollaWhiteBoard>`__ - to keep track of CI gate status, release status, stable backports, planning - and feature development status. - -Please use the existing sandbox repository, available at `sandbox -<https://opendev.org/openstack-dev/sandbox>`_, -for learning, understanding and testing the `Gerrit Workflow -<https://docs.openstack.org/infra/manual/developers.html#development-workflow>`_. - -Adding a release note -===================== - -Kolla uses the following release notes sections: - -- ``features`` --- for new features or functionality; these should ideally - refer to the blueprint being implemented; -- ``fixes`` --- for fixes closing bugs; these must refer to the bug being - closed; -- ``upgrade`` --- for notes relevant when upgrading from previous version; - these should ideally be added only between major versions; required when - the proposed change affects behaviour in a non-backwards compatible way or - generally changes something impactful; -- ``deprecations`` --- to track deprecated features; relevant changes may - consist of only the commit message and the release note; -- ``prelude`` --- filled in by the PTL before each release or RC. - -Other release note types may be applied per common sense. -Each change should include a release note unless being a ``TrivialFix`` -change or affecting only docs or CI. Such changes should `not` include -a release note to avoid confusion. -Remember release notes are mostly for end users which, in case of Kolla, -are OpenStack administrators/operators. -In case of doubt, the core team will let you know what is required. - -To add a release note, run the following command: - -.. code-block:: console - - tox -e venv -- reno new <summary-line-with-dashes> - -All release notes can be inspected by browsing ``releasenotes/notes`` -directory. - -To generate release notes in HTML format in ``releasenotes/build``, run: - -.. code-block:: console - - tox -e releasenotes - -Note this requires the release note to be tracked by ``git`` so you -have to at least add it to the ``git``'s staging area. - -Adding a new service -==================== - -Kolla aims to both containerise and deploy all services within the OpenStack -ecosystem. This is a constantly moving target as the ecosystem grows, so these -guidelines aim to help make adding a new service to Kolla a smooth experience. - -The image ---------- - -Kolla follows `Best practices for writing Dockerfiles -<https://docs.docker.com/engine/userguide/eng-image/dockerfile_best-practices/>`__ -when designing and implementing services where at all possible. - -We use ``jinja2`` templating syntax to help manage the volume and complexity -that comes with maintaining multiple Dockerfiles for multiple different base -operating systems. - -Images should be created under the ``docker`` directory. OpenStack services -should inherit from the provided ``openstack-base`` image, while supporting and -infrastructure services (for example, mongodb) should inherit from ``base``. - -Services consisting of only one service should be placed in an image named the -same as that service, for example, ``horizon``. Services that consist of -multiple processes generally use a base image and child images, for example, -``glance-base``, ``glance-api``, and ``glance-registry``. - -Jinja2 'blocks' are employed throughout the Dockerfile's to help operators -customise various stages of the build (refer to :ref:`Dockerfile Customisation -<dockerfile-customisation>`) - -Some of these blocks are free form however, there are a subset that should be -common to every Dockerfile. The overall structure for a multi container service -is as follows: - -.. code-block:: console - - FROM {{ namespace }}/{{ image_prefix }}openstack-base:{{ tag }} - LABEL maintainer="{{ maintainer }}" name="{{ image_name }}" build-date="{{ build_date }}" - - {% block << service >>_header %}{% endblock %} - - {% import "macros.j2" as macros with context %} - - << binary specific steps >> - - << source specific steps >> - - << common steps >> - - {% block << service >>_footer %}{% endblock %} - {% block footer %}{% endblock %} - -.. note:: - - The generic footer block ``{% block footer %}{% endblock %}`` should not be - included in base images (for example, glance-base). |
