Declare image tags

smecalculus · Dec 9, 2023 · c3acbfa · c3acbfa
1 parent 61c601d
commit c3acbfa
Show file tree

Hide file tree

Showing 18 changed files with 105 additions and 95 deletions.
diff --git a/.github/workflows/beyond-doubt.yaml b/.github/workflows/beyond-doubt.yaml
@@ -42,7 +42,7 @@ jobs:
           GITHUB_ACTOR: ${{ github.actor }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - id: images
-        run: >
+        run: >-
           ansible-playbook images.yaml
           -e binary_storage=${{ env.BINARY_STORAGE }}
           -e image_storage=${{ env.IMAGE_STORAGE }}
@@ -75,7 +75,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        aim: [func]
+        purpose: [func]
         env:
           - dev: godel
             os: ubuntu-20.04
@@ -97,27 +97,27 @@ jobs:
           devenv: ${{ matrix.env.dev }}
           tools: python docker
           token: ${{ secrets.GITHUB_TOKEN }}
-      - run: >
+      - run: >-
           ansible-playbook stacks.yaml -t build
           -e image_storage=${{ env.IMAGE_STORAGE }}
-          -e aim=${{ matrix.aim }}
+          -e purpose=${{ matrix.purpose }}
           -e devenv=${{ matrix.env.dev }}
           -e opsenv=${{ matrix.env.ops }}
         working-directory: bakers/ansible
       - uses: actions/[email protected]
         with:
-          name: solution-${{ matrix.aim }}-${{ matrix.env.ops }}
-          path: stacks/solution/target/context
+          name: solution-${{ matrix.purpose }}-${{ matrix.env.ops }}
+          path: stacks/solution/target/image-context
           if-no-files-found: ignore
 
   stack-testing:
-    name: Stack testing (${{ matrix.shard }}, ${{ matrix.aim }}, ${{ matrix.env.ops }})
+    name: Stack testing (${{ matrix.shard }}, ${{ matrix.purpose }}, ${{ matrix.env.ops }})
     timeout-minutes: 15
     needs: [stack-building]
     strategy:
       fail-fast: false
       matrix:
-        aim: [func]
+        purpose: [func]
         shard: [0, 1]
         env:
           - dev: godel
@@ -143,12 +143,12 @@ jobs:
       - uses: actions/[email protected]
         continue-on-error: true  # it's ok because stack building can be skipped
         with:
-          name: solution-${{ matrix.aim }}-${{ matrix.env.ops }}
-          path: stacks/solution/target/context
-      - run: >
+          name: solution-${{ matrix.purpose }}-${{ matrix.env.ops }}
+          path: stacks/solution/target/image-context
+      - run: >-
           ansible-playbook stacks.yaml -t test
           -e image_storage=${{ env.IMAGE_STORAGE }}
-          -e aim=${{ matrix.aim }}
+          -e purpose=${{ matrix.purpose }}
           -e reminder=${{ matrix.shard }}
           -e modulus=2
           -e devenv=${{ matrix.env.dev }}
@@ -160,18 +160,18 @@ jobs:
       - uses: actions/[email protected]
         if: ${{ !cancelled() }}
         with:
-          name: e2e-test-report-${{ matrix.shard }}-${{ matrix.aim }}-${{ matrix.env.ops }}
+          name: e2e-test-report-${{ matrix.shard }}-${{ matrix.purpose }}-${{ matrix.env.ops }}
           path: tests/e2e/target/surefire-reports/*.xml
           if-no-files-found: ignore
 
   stack-publishing:
-    name: Stack publishing (${{ matrix.aim }}, ${{ matrix.env.ops }})
+    name: Stack publishing (${{ matrix.purpose }}, ${{ matrix.env.ops }})
     timeout-minutes: 5
     needs: [stack-testing]
     strategy:
       fail-fast: false
       matrix:
-        aim: [func]
+        purpose: [func]
         env:
           - dev: godel
             os: ubuntu-20.04
@@ -198,12 +198,12 @@ jobs:
       - uses: actions/[email protected]
         continue-on-error: true  # it's ok because stack building can be skipped
         with:
-          name: solution-${{ matrix.aim }}-${{ matrix.env.ops }}
-          path: stacks/solution/target/context
-      - run: >
+          name: solution-${{ matrix.purpose }}-${{ matrix.env.ops }}
+          path: stacks/solution/target/image-context
+      - run: >-
           ansible-playbook stacks.yaml -t package
           -e image_storage=${{ env.IMAGE_STORAGE }}
-          -e aim=${{ matrix.aim }}
+          -e purpose=${{ matrix.purpose }}
           -e opsenv=${{ matrix.env.ops }}
         working-directory: bakers/ansible
 

diff --git a/.github/workflows/convincing.yaml b/.github/workflows/convincing.yaml
@@ -32,7 +32,7 @@ jobs:
           GITHUB_ACTOR: ${{ github.actor }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - id: images
-        run: >
+        run: >-
           ansible-playbook images.yaml
           -e binary_storage=maven.pkg.github.com
           -e image_storage=ghcr.io

diff --git a/README.adoc b/README.adoc
@@ -55,32 +55,31 @@ ansible-playbook stacks.yaml
 
 === Низкая сложность
 
-- Новая документация для контрибьюторов или потенциальных пользователей шаблона
-- Новый рефакторинг, снижающий сложность и/или повышающий идиоматичность
-- Новая правка, устраняющая ошибку и/или повышающая безопасность
-- Новый тест, увеличивающий покрытие
+- Рефакторинг, снижающий сложность и/или повышающий идиоматичность.
+- Добавление теста, увеличивающего покрытие.
+- Правка ворнинга на любом из этапов сборки.
+- Дополнение или правка документации.
+- Правка ошибки и/или уязвимости.
 
 === Средняя сложность
 
-- Новая метрика качества кодовой базы (в т.ч. новые архитектурные тесты)
-- Новый уровень качества по одной из существующих метрик
-- Новая заморозка версии в dev или ops окружении
-- Новая база данных (сейчас только PostgreSQL)
-- Новое dev или ops окружение
+- Новая метрика качества кодовой базы (в т.ч. архитектурные тесты).
+- Новый уровень качества по одной из существующих метрик.
+- Заморозка версии инструмента в dev или ops окружении.
+- Новая база данных. Сейчас только PostgreSQL.
+- Новое dev или ops окружение.
 
 === Высокая сложность
 
-- Новый фреймворк или инструмент в рамках существующего режима
-- Новый инструмент сборки бинарников (сейчас только Maven)
-- Новый инструмент управления образами (сейчас только Docker)
-- Новый инструмент раскатки стеков (сейчас только Docker Compose)
-- Новая цель использования для существующего стека
-- Новый инструмент построения дерева хешей (сейчас связка Git и Ansible)
+- Новый инструмент сборки бинарников. Сейчас только Apache Maven.
+- Новый инструмент управления образами. Сейчас только Docker Engine.
+- Новый инструмент раскатки стеков. Сейчас только Docker Compose.
+- Новое целевое использование (purpose) существующего стека.
+- Новая обвязка построения дерева хешей. Сейчас связка Git и Ansible.
 
 === Непредсказуемая сложность
 
-- Новый инструмент готовки (сейчас только Ansible)
-- Новый язык программирования (сейчас только Java и Kotlin)
-- Новая операционная система в dev и/или ops окружении (сейчас только Ubuntu)
-- Новый этап конвейера (сейчас только интеграция)
-- Новая схема именования для dev и/или ops окружения
+- Новая обвязка готовки (baker). Сейчас только Ansible.
+- Новый язык программирования. Сейчас только Java и Kotlin.
+- Новая операционная система в dev и/или ops окружении. Сейчас только Ubuntu.
+- Новый этап конвейера (pipeline). Сейчас только интеграция (CI).
diff --git a/apps/pom.xml b/apps/pom.xml
@@ -86,7 +86,7 @@
               <configuration>
                 <includeScope>runtime</includeScope>
                 <excludeGroupIds>${project.groupId}</excludeGroupIds>
-                <outputDirectory>${project.build.directory}/docker-context/lib</outputDirectory>
+                <outputDirectory>${project.build.directory}/image-context/lib</outputDirectory>
               </configuration>
             </execution>
             <execution>
@@ -98,7 +98,7 @@
               <configuration>
                 <includeScope>runtime</includeScope>
                 <includeGroupIds>${project.groupId}</includeGroupIds>
-                <outputDirectory>${project.build.directory}/docker-context/bin</outputDirectory>
+                <outputDirectory>${project.build.directory}/image-context/bin</outputDirectory>
               </configuration>
             </execution>
             <execution>
@@ -113,7 +113,7 @@
                     <groupId>${project.groupId}</groupId>
                     <artifactId>${project.artifactId}</artifactId>
                     <version>${project.version}</version>
-                    <outputDirectory>${project.build.directory}/docker-context/bin</outputDirectory>
+                    <outputDirectory>${project.build.directory}/image-context/bin</outputDirectory>
                   </artifactItem>
                 </artifactItems>
               </configuration>

diff --git a/bakers/ansible/binaries.yaml b/bakers/ansible/binaries.yaml
@@ -3,26 +3,33 @@
   hosts: app
   run_once: true
   tasks:
-    - name: Capture cid's
+    - name: Capture cids
       ansible.builtin.command:
         cmd: git hash-object --stdin
         stdin: |
-          {{ lookup('ansible.builtin.pipe', 'git write-tree --prefix=libs')[:7] }}
-          {{ lookup('ansible.builtin.pipe', 'git write-tree --prefix=apps/' ~ app)[:7] }}
+          {{ lookup('ansible.builtin.pipe', 'git write-tree --prefix=libs') }}
+          {{ lookup('ansible.builtin.pipe', 'git write-tree --prefix=apps/' ~ app) }}
       # TODO: try to choose better name
       register: image_cid
       changed_when: false
       loop: "{{ solution.apps.values()|flatten|map(attribute='binary') }}"
       loop_control:
         loop_var: app
       tags: [always]
-    - name: Declare cid's
+    - name: Declare tags
       ansible.builtin.set_fact:
-        image_cids: "{{ image_cid.results|items2dict(key_name='app', value_name='stdout') }}"
+        image_tags: >-
+          {{ dict(image_cid.results
+            |map(attribute='stdout')
+            |map('truncate', 7, True, '')
+            |map('regex_replace', '^', devenv ~ '-')
+            |zip(image_cid.results|map(attribute='app'))
+            |map('reverse'))
+          }}
       tags: [always]
     - name: Capture statuses
       ansible.builtin.command:
-        cmd: docker {{ docker_entity }} inspect {{ app.image }}:{{ image_cids[app.binary][:7] }}-{{ devenv }}
+        cmd: docker {{ docker_entity }} inspect {{ app.image }}:{{ image_tags[app.binary] }}
       register: image_status
       changed_when:
         - image_status.rc != 0
@@ -39,7 +46,7 @@
       tags: [always]
     - name: Create binaries
       ansible.builtin.command:
-        cmd: >
+        cmd: >-
           mvn
           --no-snapshot-updates
           --fail-fast
@@ -67,7 +74,7 @@
   tasks:
     - name: Create binaries
       ansible.builtin.command:
-        cmd: >
+        cmd: >-
           mvn
           --no-snapshot-updates
           --batch-mode

diff --git a/bakers/ansible/codebase.yaml b/bakers/ansible/codebase.yaml
@@ -5,7 +5,7 @@
   tasks:
     - name: Analyze
       ansible.builtin.command:
-        cmd: >
+        cmd: >-
           mvn
           --no-snapshot-updates
           --batch-mode
@@ -22,7 +22,7 @@
     - name: Analyze
       ansible.builtin.command:
         # list all top level playbooks
-        cmd: >
+        cmd: >-
           ansible-lint
           toolchain.yaml
           codebase.yaml

diff --git a/bakers/ansible/images.yaml b/bakers/ansible/images.yaml
@@ -10,7 +10,7 @@
   tasks:
     - name: Capture statuses
       ansible.builtin.command:
-        cmd: >
+        cmd: >-
           docker
           {{ docker_entity }}
           inspect
@@ -43,7 +43,7 @@
   tasks:
     - name: Analyze coverage
       ansible.builtin.command:
-        cmd: >
+        cmd: >-
           mvn
           --no-snapshot-updates
           --batch-mode
@@ -58,10 +58,10 @@
       ansible.builtin.include_role:
         name: image
       vars:
-        image_tag: "{{ image_cids[app.binary][:7] }}-{{ devenv }}"
+        image_tag: "{{ image_tags[app.binary] }}"
         image_name: "{{ app.image }}"
         image_home: "{{ project.dir }}/apps/{{ app.binary }}"
-        image_context: target/docker-context
+        image_context: target/image-context
         image_push: "{{ image_storage != 'local' }}"
         image_args:
           JAVA_RELEASE: "{{ dev[devenv].jdk.release }}"

diff --git a/bakers/ansible/inventory/group_vars/all/stacks.yaml b/bakers/ansible/inventory/group_vars/all/stacks.yaml
@@ -1,13 +1,10 @@
 ---
 toolchain:
-  image:
-    name: "{{ image_repo }}/stack/toolchain"
+  image: "{{ image_repo }}/stack/toolchain"
 
 solution:
   name: "{{ project.name }}"
-  cid: "{{ lookup('ansible.builtin.pipe', 'git write-tree --prefix=stacks/solution')[:7] }}"
-  image:
-    name: "{{ image_repo }}/stack/solution-{{ aim }}"
+  image: "{{ image_repo }}/stack/solution"
   config:
     file_name: "application.{{ config_exts[ops[opsenv].config.mapping_mode] }}"
     mapping_mode: "{{ ops[opsenv].config.mapping_mode }}"

diff --git a/...nsible/inventory/group_vars/all/aims.yaml → ...sible/inventory/group_vars/all/usage.yaml b/...nsible/inventory/group_vars/all/aims.yaml → ...sible/inventory/group_vars/all/usage.yaml
@@ -1,6 +1,6 @@
 ---
-aim: toy
-aims:
+purpose: toy
+usage:
   toy:
     storage: postgres
     apps:

diff --git a/bakers/ansible/roles/image/tasks/main.yaml b/bakers/ansible/roles/image/tasks/main.yaml
@@ -24,7 +24,7 @@
 
 - name: Build fresh
   ansible.builtin.command:
-    cmd: >
+    cmd: >-
       docker build {{ image_context }}
       -f Dockerfile
       -t {{ image_name }}:{{ image_tag }}

diff --git a/bakers/ansible/stacks.yaml b/bakers/ansible/stacks.yaml
@@ -27,13 +27,13 @@
     - ansible.builtin.import_tasks:  # noqa: name[missing]
         file: tasks/solution/build.yaml
       tags: [build]
-      when: >
+      when: >-
         hostvars.solution.stack_status is changed or
         hostvars.toolchain.stack_status is changed
     - ansible.builtin.import_tasks:  # noqa: name[missing]
         file: tasks/solution/test.yaml
       tags: [test]
-      when: >
+      when: >-
         hostvars.solution.stack_status is changed or
         hostvars.toolchain.stack_status is changed
 

diff --git a/bakers/ansible/tasks/solution/build.yaml b/bakers/ansible/tasks/solution/build.yaml
@@ -6,22 +6,22 @@
 
 - name: Create directories
   ansible.builtin.file:
-    path: "{{ stack_dir }}/target/context"
+    path: "{{ stack_dir }}/target/image-context"
     state: directory
     recurse: true
 
 - name: Build conf
   ansible.builtin.template:
     src: "{{ stack_dir }}/{{ solution.config.mapping_mode }}.j2"
-    dest: "{{ stack_dir }}/target/context/application.{{ config_exts[solution.config.mapping_mode] }}"
+    dest: "{{ stack_dir }}/target/image-context/application.{{ config_exts[solution.config.mapping_mode] }}"
     lstrip_blocks: yes
     trim_blocks: yes
     mode: "644"
 
 - name: Build spec
   ansible.builtin.template:
     src: "{{ stack_dir }}/compose.j2"
-    dest: "{{ stack_dir }}/target/context/compose.yaml"
+    dest: "{{ stack_dir }}/target/image-context/compose.yaml"
     lstrip_blocks: yes
     trim_blocks: yes
     mode: "644"
diff --git a/bakers/ansible/tasks/solution/package.yaml b/bakers/ansible/tasks/solution/package.yaml
@@ -2,8 +2,8 @@
 - ansible.builtin.import_role:  # noqa: name[missing]
     name: image
   vars:
-    image_tag: "{{ stack_cid.stdout[:7] }}-{{ opsenv }}"
-    image_name: "{{ solution.image.name }}"
+    image_tag: "{{ solution_tag }}"
+    image_name: "{{ solution.image }}"
     image_home: "{{ project.dir }}/stacks/solution"
-    image_context: target/context
+    image_context: target/image-context
     image_push: "{{ image_storage != 'local' }}"