feat:[PAGOPA-2362] Manage schema v1

.github/workflows/code_review.yml

@@ -40,8 +40,8 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           sonar_token: ${{ secrets.SONAR_TOKEN }}
           project_key: ${{env.PROJECT_KEY}}
-          coverage_exclusions: "**/config/*,**/*Mock*,**/model/**,**/entity/*"
-          cpd_exclusions: "**/model/**,**/entity/*"
+          coverage_exclusions: "**/config/*,**/*Mock*,**/model/**,**/entity/*,**/mapper/**"
+          cpd_exclusions: "**/model/**,**/entity/*,**/mapper/**"
           java_version: '17'
 
 #  smoke-test:

.github/workflows/deploy_with_github_runner.yml

@@ -11,6 +11,28 @@ on:
         required: true
         description: The environment target of the job
         type: string
+      pagopa_release:
+        required: true
+        type: string
+        description: release version to deploy for PagoPA microservice
+      pagopa_force:
+        required: false
+        type: boolean
+        description: force re-deploy PagoPA microservice
+        default: false
+      nexi_release:
+        required: true
+        type: string
+        description: release version to deploy for Nexi microservice
+      nexi_force:
+        required: false
+        type: boolean
+        description: force re-deploy Nexi microservice
+        default: false
+      current_release:
+        required: true
+        type: string
+        description: release version of the current deploy
 
 env:
   APP_NAME: cache
@@ -26,26 +48,33 @@ jobs:
     if: ${{ inputs.target == inputs.environment }}
     outputs:
       environment: ${{ steps.get_env.outputs.environment }}
+      pagopa_rel: ${{ steps.get_releases.outputs.pagopa_rel }}
+      nexi_rel: ${{ steps.get_releases.outputs.nexi_rel }}
     steps:
       - name: Get Environment
         id: get_env
         shell: bash
+        run: |         
+          current_env="${{ inputs.environment }}"
+          echo "environment=$current_env" >> $GITHUB_OUTPUT
+
+      - name: Get Releases
+        id: get_releases
+        shell: bash
         run: |
-          current_env="dev"
-          if [[ "${{ inputs.environment }}" == *"nexi"* ]]; then
-            if [[ "${{ inputs.environment }}" == *"dev"* ]]; then
-              current_env="dev"
-            elif [[ "${{ inputs.environment }}" == *"sit"* ]]; then
-              current_env="dev"
-            else
-              current_env="uat"
-            fi
-          elif [[ "${{ inputs.environment }}" == "prf" ]]; then
-            current_env="uat"
-          else
-            current_env="${{ inputs.environment }}"
+          pagopa_version=${{ inputs.current_release }}
+          nexi_version=${{ inputs.current_release }}
+
+          if [[ "${{ inputs.nexi_release }}" != "" ]]; then            
+            nexi_version=${{ inputs.nexi_release }}
           fi
-          echo "environment=$current_env" >> $GITHUB_OUTPUT
+
+          if [[ "${{ inputs.pagopa_release }}" != "" ]]; then            
+            pagopa_version=${{ inputs.pagopa_release }}
+          fi
+
+          echo "pagopa_rel=$pagopa_version" >> $GITHUB_OUTPUT
+          echo "nexi_rel=$nexi_version" >> $GITHUB_OUTPUT
 
   create_runner:
     needs: [ setting_env ]
@@ -78,7 +107,7 @@ jobs:
     environment: ${{ needs.setting_env.outputs.environment }}
     steps:
 
-      - name: Deploy DEV for PagoPA (Oracle or Postgres)
+      - name: Deploy DEV
         uses: pagopa/github-actions-template/aks-deploy@5db4c9108164a07d96527978da1c3febec934f22 #v1.11.1
         if: ${{ inputs.environment == 'dev' }}
         with:
@@ -91,9 +120,9 @@ jobs:
           cluster_name: ${{ vars.CLUSTER_NAME }}
           resource_group: ${{ vars.CLUSTER_RESOURCE_GROUP }}
           app_name: ${{ env.APP_NAME }}
-          helm_upgrade_options: ' --debug --set postgresql.enabled=true --set postgresql.forceRedeploy=true --set postgresql-replica.forceRedeploy=false --set postgresql-nexi.forceRedeploy=false --set oracle.enabled=true --set oracle.forceRedeploy=true --set oracledev.enabled=true --set oracledev.forceRedeploy=false --set oracleprod.enabled=true --set oracleprod.forceRedeploy=false'
+          helm_upgrade_options: ' --debug --set postgresql.forceRedeploy=${{ inputs.pagopa_force }} --set postgresql.image.tag=${{ needs.setting_env.outputs.pagopa_rel }} --set postgresql-nexi.forceRedeploy=${{ inputs.nexi_force }} --set postgresql-nexi.image.tag=${{ needs.setting_env.outputs.nexi_rel }}'
 
-      - name: Deploy UAT for PagoPA (Oracle or Postgres)
+      - name: Deploy UAT
         uses: pagopa/github-actions-template/aks-deploy@5db4c9108164a07d96527978da1c3febec934f22 #v1.11.1
         if: ${{ inputs.environment == 'uat' }}
         with:
@@ -106,24 +135,9 @@ jobs:
           cluster_name: ${{ vars.CLUSTER_NAME }}
           resource_group: ${{ vars.CLUSTER_RESOURCE_GROUP }}
           app_name: ${{ env.APP_NAME }}
-          helm_upgrade_options: ' --debug --set postgresql.enabled=true --set oracle.enabled=true'
-
-      - name: Deploy PRF for PagoPA (Oracle or Postgres)
-        uses: pagopa/github-actions-template/aks-deploy@5db4c9108164a07d96527978da1c3febec934f22 #v1.11.1
-        if: ${{ inputs.environment == 'prf' }}
-        with:
-          branch: ${{ github.ref_name }}
-          client_id: ${{ secrets.CD_CLIENT_ID }}
-          subscription_id: ${{ secrets.SUBSCRIPTION_ID }}
-          tenant_id: ${{ secrets.TENANT_ID }}
-          env: ${{ needs.setting_env.outputs.environment }}
-          namespace: ${{ vars.NAMESPACE }}
-          cluster_name: ${{ vars.CLUSTER_NAME }}
-          resource_group: ${{ vars.CLUSTER_RESOURCE_GROUP }}
-          app_name: ${{ env.APP_NAME }}
-          helm_upgrade_options: ' --debug --set postgresql-replica.enabled=true --set oracledev.enabled=true '
+          helm_upgrade_options: ' --debug --set postgresql.forceRedeploy=${{ inputs.pagopa_force }} --set postgresql.image.tag=${{ needs.setting_env.outputs.pagopa_rel }} --set postgresql-replica.forceRedeploy=${{ inputs.pagopa_force }} --set postgresql-replica.image.tag=${{ needs.setting_env.outputs.pagopa_rel }} --set postgresql-nexi.forceRedeploy=${{ inputs.nexi_force }} --set postgresql-nexi.image.tag=${{ needs.setting_env.outputs.nexi_rel }} --set postgresql-replica-nexi.forceRedeploy=${{ inputs.nexi_force }} --set postgresql-replica-nexi.image.tag=${{ needs.setting_env.outputs.nexi_rel }}'
 
-      - name: Deploy PROD for PagoPA (Oracle or Postgres)
+      - name: Deploy PROD
         uses: pagopa/github-actions-template/aks-deploy@5db4c9108164a07d96527978da1c3febec934f22 #v1.11.1
         if: ${{ inputs.environment == 'prod' }}
         with:
@@ -136,22 +150,7 @@ jobs:
           cluster_name: ${{ vars.CLUSTER_NAME }}
           resource_group: ${{ vars.CLUSTER_RESOURCE_GROUP }}
           app_name: ${{ env.APP_NAME }}
-          helm_upgrade_options: ' --debug --set postgresql.enabled=true --set oracle.enabled=true --set postgresql-nexi.enabled=false'
-
-      - name: Deploy for Nexi
-        uses: pagopa/github-actions-template/aks-deploy@main
-        if: ${{ inputs.environment == 'dev_nexi' || inputs.environment == 'sit_nexi' || inputs.environment == 'uat_nexi' || inputs.environment == 'prf_nexi' }}
-        with:
-          branch: ${{ github.ref_name }}
-          client_id: ${{ secrets.CD_CLIENT_ID }}
-          subscription_id: ${{ secrets.SUBSCRIPTION_ID }}
-          tenant_id: ${{ secrets.TENANT_ID }}
-          env: ${{ needs.setting_env.outputs.environment }}
-          namespace: ${{ vars.NAMESPACE }}
-          cluster_name: ${{ vars.CLUSTER_NAME }}
-          resource_group: ${{ vars.CLUSTER_RESOURCE_GROUP }}
-          app_name: ${{ env.APP_NAME }}
-          helm_upgrade_options: ${{ (inputs.environment == 'dev_nexi') && ' --debug --set oracledev.enabled=true --set oracledev.forceRedeploy=true --set oracleprod.enabled=true --set oracleprod.forceRedeploy=false' || (inputs.environment == 'sit_nexi' || inputs.environment == 'uat_nexi') && ' --debug --set postgresql-nexi.enabled=true --set postgresql-nexi.forceRedeploy=true' || inputs.environment == 'prf_nexi' && ' --debug --set postgresql-replica-nexi.enabled=true --set postgresql-replica-nexi.forceRedeploy=true' }}
+          helm_upgrade_options: '--debug --set postgresql.forceRedeploy=${{ inputs.pagopa_force }} --set postgresql.image.tag=${{ needs.setting_env.outputs.pagopa_rel }}'
 
   cleanup_runner:
     name: Cleanup Runner

.github/workflows/release_deploy.yml

@@ -15,12 +15,7 @@ on:
         options:
           - dev
           - uat
-          - prf
           - prod
-          - dev_nexi
-          - sit_nexi
-          - uat_nexi
-          - prf_nexi
       beta:
         required: false
         type: boolean
@@ -31,6 +26,26 @@ on:
         type: boolean
         description: skip the release. Only deploy
         default: false
+      pagopa_release:
+        required: false
+        type: string
+        default: ""
+        description: release version to deploy for PagoPA microservice (if empty then last)
+      pagopa_force:
+        required: false
+        type: boolean
+        description: force re-deploy PagoPA microservice
+        default: false
+      nexi_release:
+        required: false
+        type: string
+        default: "0.9.17"
+        description: release version to deploy for Nexi microservice (if empty then last)
+      nexi_force:
+        required: false
+        type: boolean
+        description: force re-deploy Nexi microservice
+        default: false
 
 
 permissions:
@@ -109,16 +124,8 @@ jobs:
     needs: [ setup, release ]
     name: Build and Push Docker Image
     runs-on: ubuntu-latest
-#    if: ${{ inputs.semver != 'skip' }}
     if: ${{ needs.setup.outputs.semver != 'skip' }}
     steps:
-      #      - name: Build and Push
-      #        id: semver
-      #        uses: pagopa/github-actions-template/[email protected]
-      #        with:
-      #          branch: ${{ github.ref_name}}
-      #          github_token: ${{ secrets.GITHUB_TOKEN }}
-      #          tag: ${{ needs.release.outputs.version }}
       - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b #v4.1.4
         with:
           ref: ${{ github.ref_name }}
@@ -158,11 +165,16 @@ jobs:
     if: ${{ always() && !contains(needs.*.result, 'failure') && !contains(needs.*.result, 'cancelled') }}
     strategy:
       matrix:
-        environment: [ dev, uat, prf, prod, dev_nexi, sit_nexi, uat_nexi, prf_nexi ]
+        environment: [ dev, uat, prod ]
     uses: ./.github/workflows/deploy_with_github_runner.yml
     with:
       environment: ${{ matrix.environment }}
       target: ${{ needs.setup.outputs.environment }}
+      pagopa_release: ${{ inputs.pagopa_release }}
+      pagopa_force: ${{ inputs.pagopa_force }}
+      nexi_release: ${{ inputs.nexi_release }}
+      nexi_force: ${{ inputs.nexi_force }}
+      current_release: ${{ needs.release.outputs.version }}
     secrets: inherit
 
   notify:

.identity/00_data.tf

@@ -57,9 +57,8 @@ data "azurerm_key_vault_secret" "key_vault_slack_webhook_url" {
 }
 
 data "azurerm_key_vault_secret" "key_vault_read_package_token" {
-#  name = "github-token-read-packages-bot"
-  name = "gh-read-pkg-test-francesco"
-  key_vault_id = data.azurerm_key_vault.key_vault.id
+  name = "encrypted-github-token-read-packages-bot"
+  key_vault_id = data.azurerm_key_vault.domain_key_vault.id
 }
 
 data "azurerm_user_assigned_identity" "identity_cd" {

Dockerfile

@@ -7,13 +7,11 @@ COPY . .
 RUN --mount=type=secret,id=GH_TOKEN,dst=/tmp/secret_token export GITHUB_TOKEN_READ_PACKAGES="$(cat /tmp/secret_token)" \
   && mvn clean package -Dmaven.test.skip=true
 
-FROM amazoncorretto:17.0.10-alpine3.19@sha256:180e9c91bdbaad3599fedd2f492bf0d0335a9382835aa64669b2c2a8de7c9a22 as builder
+FROM amazoncorretto:17.0.9-alpine3.18@sha256:df48bf2e183230040890460ddb4359a10aa6c7aad24bd88899482c52053c7e17 AS builder
 COPY --from=buildtime /build/target/*.jar application.jar
 RUN java -Djarmode=layertools -jar application.jar extract
 
-
-FROM ghcr.io/pagopa/docker-base-springboot-openjdk17:v1.1.3@sha256:a4e970ef05ecf2081424a64707e7c20856bbc40ddb3e99b32a24cd74591817c4
-#ADD --chown=spring:spring https://github.com/open-telemetry/opentelemetry-java-instrumentation/releases/download/v1.25.1/opentelemetry-javaagent.jar .
+FROM ghcr.io/pagopa/docker-base-springboot-openjdk17:v2.2.0@sha256:b866656c31f2c6ebe6e78b9437ce930d6c94c0b4bfc8e9ecc1076a780b9dfb18
 
 COPY --chown=spring:spring  --from=builder dependencies/ ./
 COPY --chown=spring:spring  --from=builder snapshot-dependencies/ ./
@@ -24,5 +22,5 @@ COPY --chown=spring:spring  --from=builder application/ ./
 
 EXPOSE 8080
 
-#ENTRYPOINT ["java","-javaagent:opentelemetry-javaagent.jar","--enable-preview","org.springframework.boot.loader.JarLauncher"]
-ENTRYPOINT ["java","--enable-preview","org.springframework.boot.loader.JarLauncher"]
+# this mode is required in order to inject the JAVA_OPTS from environment
+#ENTRYPOINT ["java","--enable-preview","org.springframework.boot.loader.JarLauncher"]

docs/full/scenario_01.puml

@@ -0,0 +1,34 @@
+/'
+Scenario 01:
+  Cache retrieval and no cache is present on Redis
+'/
+@startuml
+participant Client
+participant APIM
+participant "API Config\nCache" as Cache
+
+alt on start-up
+    Cache -x Redis: if <b>preload = true</b>, get <b>apicfg_p_full</b>
+end alt
+
+Client -> APIM: <b>/cache</b>
+APIM -> Cache: <b>/cache</b>
+Cache -> APIM: <i>404 CACHE_NOT_INITIALIZED</i>
+
+Client -> APIM: <b>/cache/refresh</b>
+APIM -> Cache: <b>/cache/refresh</b>
+Cache -x Redis: Get cache data with key <b>apicfg_p_full_in_progress</b>
+Cache -> Redis: Save cache data with key <b>apicfg_p_full_in_progress</b>
+Cache -> Cache: Generate cache data
+alt in progress
+Client -> APIM: <b>/cache/refresh</b>
+APIM -> Cache: <b>/cache/refresh</b>
+Cache -> Redis: Get cache data with key <b>apicfg_p_full_in_progress</b>
+Cache --> APIM: <i>503 SERVICE_UNAVAILABLE</i>
+APIM --> Client: <i>503 SERVICE_UNAVAILABLE</i>
+end alt
+Cache -> Redis: Save cache data with key <b>apicfg_p_full</b>
+Cache -> Redis: Remove cache with key <b>apicfg_p_full_in_progress</b>
+Cache --> APIM: Return cache data
+APIM --> Client: Return cache data
+@enduml

docs/full/scenario_02.puml

@@ -0,0 +1,19 @@
+/'
+Scenario 02:
+  Cache retrieval and it is present on Redis
+'/
+@startuml
+participant Client
+participant APIM
+participant "API Config\nCache" as Cache
+
+alt on start-up
+    Cache -> Redis: if <b>preload = true</b>, get <b>apicfg_p_full</b>
+end alt
+
+Client -> APIM: <b>/cache</b>
+APIM -> Cache: <b>/cache</b>
+Cache --> APIM: Return in-memory cache data
+APIM --> Client: Return cache data
+@enduml
+

docs/full/scenario_03.puml

@@ -0,0 +1,11 @@
+/'
+Scenario 03:
+  Client retrieves last cache version id (analogue for xlsx)
+'/
+@startuml
+Client -> APIM: <b>/cache/id</b>
+APIM -> Cache: <b>/cache/id</b>
+Cache -> Cache: get version from\nin-memory cache data
+Cache --> APIM: Return cache Id data
+APIM --> Client: Return cache Id data
+@enduml

docs/node/scenario_01.puml

@@ -7,6 +7,8 @@ participant Node
 participant APIM
 participant "API Config\nCache" as Cache
 
+/'
+This version is deprecated
 Node -> APIM: <b>/stakeholders/node/cache/schemas/v1</b>
 APIM -> Cache: <b>/stakeholders/node/cache/schemas/v1
 Cache -> Cache: No <b>refresh</b> is required
@@ -17,6 +19,20 @@ end note
 Cache -> Cache: Generate cache data
 Cache -> Redis: Save cache data with key <b>apicfg_*_node_v1</b>
 
+Cache --> APIM: Return cache data
+APIM --> Node: Return cache data
+'/
+Node -> APIM: <b>/stakeholders/node/cache/schemas/v1</b>
+note over Node, Cache
+  <b>v1</b> is the schema version number
+end note
+APIM -> Cache: <b>/stakeholders/node/cache/schemas/v1
+Cache -x Redis: Get cache data with key <b>apicfg_p_node_v1</b>
+
+Cache -> Cache: Generate cache schema v1 from in-memory cache data
+Cache -> Redis: Save cache data with key <b>apicfg_p_node_v1</b>
+Cache -> Redis: Save cache version with key <b>apicfg_p_node_v1_id</b>
+
 Cache --> APIM: Return cache data
 APIM --> Node: Return cache data
 @enduml

docs/node/scenario_02.puml

@@ -2,10 +2,12 @@
 Scenario 02:
   Node retrieves cache, and it is present on Redis
 '/
+
 @startuml
 participant Node
 participant APIM
 participant "API Config\nCache" as Cache
+/'
 Node -> APIM: /stakeholders/node/cache/schemas/v1
 APIM -> Cache: /stakeholders/node/cache/schemas/v1
 Cache -> Redis: Check <b>apicfg_*_node_v1</b> exists
@@ -15,4 +17,18 @@ end note
 Redis --> Cache: Return cache data
 Cache --> APIM: Return cache data
 APIM --> Node: Return cache data
+'/
+Node -> APIM: <b>/stakeholders/node/cache/schemas/v1</b>
+note over Node, Cache
+  <b>v1</b> is the schema version number
+end note
+APIM -> Cache: <b>/stakeholders/node/cache/schemas/v1
+Cache -> Redis: Get cache data with key <b>apicfg_p_node_v1</b>
+Cache -> Cache: Verify if stakeholder cache id is equal to full cache id
+note right Cache
+  if the ids are different no cache is loaded
+  and it is re-generated from in-memory cache data
+end note
+Cache --> APIM: Return cache data
+APIM --> Node: Return cache data
 @enduml