diff options
| -rw-r--r-- | doc/source/admin/image-building.rst | 92 | ||||
| -rw-r--r-- | docker/macros.j2 | 3 | ||||
| -rw-r--r-- | kolla/image/kolla_worker.py | 13 | ||||
| -rw-r--r-- | kolla/template/methods.py | 6 | ||||
| -rw-r--r-- | releasenotes/notes/bring-configure_user-macro-to-custom-templates-61c143326a35c7ed.yaml | 9 | ||||
| -rw-r--r-- | tests/playbooks/run.yml | 17 | ||||
| -rw-r--r-- | tests/templates/docker/releaser/Dockerfile.j2 | 25 | ||||
| -rw-r--r-- | tests/templates/docker/releaser/extend_start.sh | 11 |
8 files changed, 175 insertions, 1 deletions
diff --git a/doc/source/admin/image-building.rst b/doc/source/admin/image-building.rst index 3f7de30e7..d3639e0e6 100644 --- a/doc/source/admin/image-building.rst +++ b/doc/source/admin/image-building.rst @@ -525,6 +525,98 @@ The template becomes now: RUN cp /additions/jenkins/jenkins.json /jenkins.json {% endblock %} +Custom docker templates +----------------------- + +In order to unify the process of managing OpenStack-related projects, Kolla +provides a way of building images for external 'non-built-in' projects. + +If the template for a 'non-built-in' project meets Kolla template standards, +an operator can provide a root directory with a template via the +``--docker-dir`` CLI option (can be specified multiple times). + +All Kolla's jinja2 macros should be available the same as for built-in +projects with some notes: + +- The ``configure_user`` macro. As the 'non-built-in' user is unknown to Kolla, + there are no default values for user ID and group ID to use. + To use this macro, an operator should specify "non-default" user details + with ``<custom_user_name>-user`` configuration section and include info + for ``uid`` and ``gid`` at least. + +Let's look into how an operator can build an image for an in-house project +with Kolla using `openstack/releases <https://opendev.org/openstack/releases>`_ +project. + +First, create a ``Dockerfile.j2`` template for the project. + +.. path /home/kolla/custom-kolla-docker-templates/releaser/Dockerfile.j2 +.. code-block:: jinja + + FROM {{ namespace }}/{{ image_prefix }}openstack-base:{{ tag }} + + {% block labels %} + LABEL maintainer="{{ maintainer }}" name="{{ image_name }}" build-date="{{ build_date }}" + {% endblock %} + + {% block releaser_header %}{% endblock %} + + {% import "macros.j2" as macros with context %} + + {{ macros.configure_user(name='releaser') }} + + RUN ln -s releaser-source/* /releaser \ + && {{ macros.install_pip(['/releaser-source'] | customizable("pip_packages")) }} \ + && mkdir -p /etc/releaser \ + && chown -R releaser: /etc/releaser \ + && chmod 750 /etc/sudoers.d \ + && touch /usr/local/bin/kolla_releaser_extend_start \ + && chmod 644 /usr/local/bin/kolla_extend_start /usr/local/bin/kolla_releaser_extend_start + + {% block footer %}{% endblock %} + +Suggested directory structure: + +.. code-block:: console + + custom-kolla-docker-templates + |__ releaser + |__ Dockerfile.j2 + +Then, modify Kolla's configuration so the engine can download sources and +configure users. + +.. path /etc/kolla/kolla-build.conf +.. code-block:: ini + + [releaser] + type = git + location = https://opendev.org/openstack/releases + reference = master + + [releaser-user] + uid = 53001 + gid = 53001 + +Last pre-check before building a new image - ensure that the new template +is visible for Kolla: + +.. code-block:: console + + $ kolla-build --list-images --docker-dir custom-kolla-docker-templates "^releaser$" + 1 : base + 2 : releaser + 3 : openstack-base + +And finally, build the ``releaser`` image, passing the ``--docker-dir`` +argument: + +.. code-block:: console + + kolla-build --docker-dir custom-kolla-docker-templates "^releaser$" + +Can I use the ``--template-override`` option for custom templates? Yes! + Custom repos ------------ diff --git a/docker/macros.j2 b/docker/macros.j2 index 48c56208c..34d67335c 100644 --- a/docker/macros.j2 +++ b/docker/macros.j2 @@ -43,6 +43,9 @@ {% endmacro %} {% macro configure_user(name, groups=None, shell=None, homedir=None) %} +{%- if name not in users %} +{{ raise_error("Failed to find configuration for '" + name + "' user. Try specifying '" + name + "-user' config section.") }} +{%- endif %} {% set user=users[name] %} {%- if not homedir %} {% set homedir='/var/lib/' + name %} diff --git a/kolla/image/kolla_worker.py b/kolla/image/kolla_worker.py index 798c8eaa7..3a78a7f35 100644 --- a/kolla/image/kolla_worker.py +++ b/kolla/image/kolla_worker.py @@ -271,6 +271,7 @@ class KollaWorker(object): return { 'debian_package_install': jinja_methods.debian_package_install, 'handle_repos': jinja_methods.handle_repos, + 'raise_error': jinja_methods.raise_error, } def get_users(self): @@ -280,7 +281,17 @@ class KollaWorker(object): for section in all_sections: match = re.search('^.*-user$', section) if match: - user = self.conf[match.group(0)] + cfg_group_name = match.group(0) + + if cfg_group_name not in self.conf._groups: + self.conf.register_opts( + common_config.get_user_opts( + None, None, + # cut `-user` suffix + group=cfg_group_name[:-5]), + group=cfg_group_name + ) + user = self.conf[cfg_group_name] ret[match.group(0)[:-5]] = { 'uid': user.uid, 'gid': user.gid, diff --git a/kolla/template/methods.py b/kolla/template/methods.py index 6747504fa..e9edbfeb0 100644 --- a/kolla/template/methods.py +++ b/kolla/template/methods.py @@ -11,6 +11,8 @@ # limitations under the License. import os +import typing as t + import yaml from jinja2 import pass_context @@ -150,3 +152,7 @@ def handle_repos(context, reponames, mode): commands = "RUN %s" % commands return commands + + +def raise_error(msg: str) -> t.NoReturn: + raise Exception(msg) diff --git a/releasenotes/notes/bring-configure_user-macro-to-custom-templates-61c143326a35c7ed.yaml b/releasenotes/notes/bring-configure_user-macro-to-custom-templates-61c143326a35c7ed.yaml new file mode 100644 index 000000000..ca7c6559e --- /dev/null +++ b/releasenotes/notes/bring-configure_user-macro-to-custom-templates-61c143326a35c7ed.yaml @@ -0,0 +1,9 @@ +--- +features: + - | + Extends the support of externally-managed projects provided by the + ``--docker-dir`` option with an ability to use ``configure_user`` + jinja2 macros like Kolla built-in projects. + The operator should specify "non-default" user details with + ``<custom_user_name>-user`` configuration section and include info for + ``uid`` and ``gid`` at least. diff --git a/tests/playbooks/run.yml b/tests/playbooks/run.yml index f21de9f33..238b2f7bd 100644 --- a/tests/playbooks/run.yml +++ b/tests/playbooks/run.yml @@ -44,6 +44,23 @@ when: - publisher + - name: Add external docker dir config + vars: + kolla_build_external_docker_config: + DEFAULT: + docker_dir: "{{ ansible_user_dir }}/{{ zuul.project.src_dir }}/tests/templates/docker" + releaser: + type: git + reference: master + location: "https://opendev.org/openstack/releases.git" + releaser-user: + uid: 56000 + gid: 56000 + set_fact: + kolla_build_config: "{{ kolla_build_config | combine(kolla_build_external_docker_config, recursive=True) }}" + when: + - not publisher + - import_role: name: kolla-build-config diff --git a/tests/templates/docker/releaser/Dockerfile.j2 b/tests/templates/docker/releaser/Dockerfile.j2 new file mode 100644 index 000000000..665302534 --- /dev/null +++ b/tests/templates/docker/releaser/Dockerfile.j2 @@ -0,0 +1,25 @@ +FROM {{ namespace }}/{{ image_prefix }}openstack-base:{{ tag }} + +{% block labels %} +LABEL maintainer="{{ maintainer }}" name="{{ image_name }}" build-date="{{ build_date }}" +{% endblock %} + +{% block releaser_header %}{% endblock %} + +{% import "macros.j2" as macros with context %} + +{{ macros.configure_user(name='releaser') }} + +COPY extend_start.sh /usr/local/bin/kolla_extend_start + +ADD releaser-archive /releaser-source + +RUN ln -s releaser-source/* /releaser \ + && {{ macros.install_pip(['/releaser'] | customizable("pip_packages")) }} \ + && mkdir -p /etc/releaser \ + && chown -R releaser: /etc/releaser \ + && chmod 750 /etc/sudoers.d \ + && touch /usr/local/bin/kolla_releaser_extend_start \ + && chmod 644 /usr/local/bin/kolla_extend_start /usr/local/bin/kolla_releaser_extend_start + +{% block footer %}{% endblock %} diff --git a/tests/templates/docker/releaser/extend_start.sh b/tests/templates/docker/releaser/extend_start.sh new file mode 100644 index 000000000..5d5c3b041 --- /dev/null +++ b/tests/templates/docker/releaser/extend_start.sh @@ -0,0 +1,11 @@ +#!/bin/bash + +if [[ ! -d "/var/log/kolla/releaser" ]]; then + mkdir -p /var/log/kolla/releaser +fi + +if [[ $(stat -c %a /var/log/kolla/releaser) != "755" ]]; then + chmod 755 /var/log/kolla/releaser +fi + +. /usr/local/bin/kolla_releaser_extend_start |