Руководство прикладного разработчика#

     server:
       port: 8787                                    # порт приложения
     grpc:
       maxMessageSizeInMb: 8                         # максимальный размер сообщения в мегабайтах
       server:
         server-port: 5454                           # порт gRPC сервера 
         threadpool:
           maxconcurrentconsumers: 20                # максимальное количество потоков обработки gRPC-запросов, которое может использовать сервер
           concurrentconsumers: 15                   # количество потоков обработки gRPC-запросов при старте сервера  
           threadkeepaliveseconds: 30                # параметр, который определяет сколько времени (в секундах) неиспользуемые потоки будут оставаться в памяти  
       client:
         settings:
           default:
             hostname: <hostname>                    # имя клиента gRPC
             port: 5454                              # порт клиента gRPC
     service:
       settings:
         enable-param-logging: false                 # логический параметр, отвечающий за журналирование IN/OUT-параметров, передаваемых и получаемых из хранимых процедур
     scheduler:
       enabled: true                                 # логический параметр, отвечающий за отправку метрик жизненного цикла сертификата
       initial-delay: 1000                           # начальная задержка перед отправкой метрик жизненного цикла сертификата в миллисекундах
       check-interval: 10000                         # периодичность отправки метрик жизненного цикла сертификата в миллисекундах
     datasource:
       jdbc-url: <hostname БД>:<port>/<database>     # подключения к базе данных
       maximum-pool-size: 2                          # максимальное количество подключений в пуле базы данных
       pool-name: HHHGGGFFFF                         # имя пула базы данных
       username: <username>                          # логин пользователя базы данных
     ds:
       prop:
 	  	tlsprotocol: TLSv1.2                        # требуемая версия TLS протокола JVM
 	  	cipherSuites: TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 # требуемый алгоритм шифрования JVM
         ssl: true                                   # логический параметр, отвечающий за включение ssl соединения
         sslmode: verify-full                        # метод аутентификации при заданном параметре ssl: true
         sslhostnameverifier: com.sbt.synapse.dnverify.DnHostnameVerifier # проверка всего DN серверного сертиката (работает при sslmode=verify-full)
 		sslalloweddn: 'CN=10.xx.xx.xx, O=SBRF, C=RU' # разрешенный список DN серверных сертификатов в формате строки
         dnmaxcount: 1                               # параметр, указывающий максимальное количество разрешенных DN
         sslrootcert: /deployments/config/db/ca.crt  # путь к корневому сертификату
         sslcert: /deployments/config/db/cert.crt    # путь к клиентскому сертификату
         sslkey: /deployments/config/db/key.pk8      # путь к файлу клиентского ключа
     crypto:
       enabled: true                                 # логический параметр, отвечающий за включение/выключение поддержки шифрования
       keyExpirationHours: 24                        # интервал обновления симметричного ключа (в часах)
       keySize: 256                                  # размер симметричного ключа в битах
       asymmetricAlgorithmName: RSA                  # алгоритм ассиметричного шифрования
       asymmetricMode: ECB                           # режим ассиметричного шифрования
       asymmetricPadding: PKCS1Padding               # схема заполнения для ассиметричного шифрования
       symmetricAlgorithmName: AES                   # алгоритм симметричного шифрования
       symmetricMode: GCM                            # режим симметричного шифрования
       symmetricPadding: PKCS7Padding                # схема заполнения для ассиметричного шифрования
       provider: BC                                  # крипто провайдер
       returnAsIsOnError: true                       # если true и при расшифровке сообщения возникнет ошибка Шлюз БД вернет сообщение в исходном виде
                                                     # если он равен false, то при возникновении ошибки выбросит exception и обработка сообщения прекратится
                                                     # флаг нужен для одновременной работы с зашифрованными и незашифрованными данными
     secman:
       role: "role-ga-secman-syte"                   # роль HashiCorp Vault в кластере
       vault-addr: "t.secrets.delta.sbrf.ru"         # стенд HashiCorp Vault
       os-addr: "dev-gen2.delta.sbrf.ru"             # стенд кластера
       vault-path: "CI01994970_CI02129749/A/SNPS/OSH/IFT/KV/CRYPTOCIPHER"   # путь в HashiCorp Vault, где лежат сертификаты шифратора (Важно! Ключи в секрете должны быть названы pem и key)
       vault-ns: "CI01994970_CI02129749"             # имя хранилища в HashiCorp Vault

 entity:
   entityName: "test"                           # название справочника
   schema: "SRD_LOG"                            # название схемы, в которой хранятся процедуры/функции
   actions:
       - name: "getOrderId"                     # название для связи процедуры с запросом. В запросе записывается в поле `Entity.Action`            
         packageName:                           # название пакета, в котором хранится процедура. Может быть пустым
         functionName: "getorderbyid"           # название функции в базе данных
         commit: true                           # логический параметр, обозначающий фиксацию транзакции (необязательный параметр, требуется для функций с курсорами)
         fields:
           - type: "INTEGER"                    # тип параметра. Поддерживаются типы: `STRING`, `NUMBER`, `DATA`, `TIMESTAMP`, `CLOB`, `BLOB`, `CURSOR`, `INTEGER`, `DOUBLE`, `TEXT`, `BYTEA`, `BIGINT`, `DECIMAL`, `BOOLEAN`.
             name: "orderId"                    # название параметра для связи параметра с запросом.
             nameInProcedure: "order_id"        # название параметра процедуры/функции в базе данных.
             input: true                        # параметр логического типа, обозначающий входящие и исходящие параметры процедур/функций.
             encrypt: false                     # при значении true, входящий параметр отправится в базу данных в зашифрованном виде, а исходящий параметр расшифруется из базы данных
           - type: "CURSOR"
             name: "out_result"
             nameInProcedure: "OUT_CURSOR"
             input: false
             encrypt: true                      # для параметров типа CURSOR, нужно указывать значение шифратора
             cursorColumns:                     # для параметра типа `CURSOR` задается описание каждого столбца курсора.
               - type: "INTEGER"                # тип поля курсора. Поддерживаются типы: `STRING`, `NUMBER`, `DATA`, `TIMESTAMP`, `CLOB`, `BLOB`, `INTEGER`, `DOUBLE`, `TEXT`, `BYTEA`, `BIGINT`, `DECIMAL`, `BOOLEAN`.
                 name: "id"                     # название столбца курсора. Используется для связи с описанием при обращении к полям в Proto-сообщении.
                 nameInProcedure: "id"          # название столбца курсора в процедуре/функции базы данных.
               - type: "INTEGER"
                 name: "customerid"
                 nameInProcedure: "customerid"
               - type: "TIMESTAMP"
                 name: "orderdate"
                 nameInProcedure: "orderdate"
               - type: "NUMBER"
                 name: "totalprice"
                 nameInProcedure: "totalprice"
               - type: "TEXT"
                 name: "description"
                 nameInProcedure: "description"
                 encrypt: true
       - name: "get"
         packageName:
         procedureName: "GETAGGREGATION"      # название процедуры в базе данных
         fields:
           - type: "STRING"
             name: "msgId"
             nameInProcedure: "IN_MSG_ID"
             input: true
           - type: "STRING"
             name: "aggId"
             nameInProcedure: "IN_AGGR_ID"
             input: true
           - type: "CLOB"
             name: "message"
             nameInProcedure: "OUT_MSG_BODY"
             input: false

     apiVersion: networking.istio.io/v1alpha3
     kind: ServiceEntry
     metadata:
         name: db-service-entry
         labels:
           app: db-gateway
     spec:
         exportTo: 
             -.
         hosts:
           - <hostname БД>             # хост для подключения к базе данных
         ports:
           - name: tcp
             number: 1523              # порт для подключения к базе данных
             protocol: tcp
         resolution: DNS

 kind: Deployment
 apiVersion: apps/v1
 metadata:
   name: service-db-module
   labels:
     app: service-db-module
     secman-injector: enabled                                                          
 spec:
   replicas: 2
   selector:
     matchLabels:
       app: service-db-module
   strategy:
 	type: RollingUpdate
 	rollingUpdate:
       maxUnavailable: 0
 	  maxSurge: 25%
   template:
     metadata:
       labels:
         app: service-db-module
         name: service-db-module
         secman-injector: enabled                                                              # включение сайдкара vault-agenta ФП HashiCorp Vault         
       annotations:
         sidecar.istio.io/inject: 'true'                                                       # включение/отключение контейнера Компонента «Сервисный прокси» (например, true/false)          
         sidecar.istio.io/proxyCPU: 500m                                                       # ресурсы для cpu request для контейнера Компонента «Сервисный прокси» (например, 500m)
         sidecar.istio.io/proxyCPULimit: 500m                                                  # ресурсы для cpu limit для контейнера Компонента «Сервисный прокси» (например, 500m)
         sidecar.istio.io/proxyMemory: 512Mi                                                   # ресурсы для memory request для контейнера Компонента «Сервисный прокси» (например, 512m)
         sidecar.istio.io/proxyMemoryLimit: 512Mi                                              # ресурсы для memory limit для контейнера Компонента «Сервисный прокси» (например, 512m)

         vault.hashicorp.com/agent-inject: 'true'                                              # включение/отключение sidecar HashiCorp Vault
 		vault.hashicorp.com/namespace: <NAMESPACE_VAULT>                                      # имя созданного хранилища в HashiCorp Vault (например, CI01994970_CI02129749)
 		vault.hashicorp.com/role: <SECMAN_ROLE>                                               # имя полученной роли в HashiCorp Vault (например, ci01994970_ci02129749_a_snps_osh_ift_ac)
 		vault.hashicorp.com/secret-volume-path: <SECMAN_MOUNT_PATH>                           # путь для загрузки секретов в файловой системе Pod (например, /deployments/config/db/certs)
 		vault.hashicorp.com/agent-inject-secret-cert.crt: 'true'                              # включить чтение секрета cert.crt
         vault.hashicorp.com/agent-inject-template-cert.crt: |                                 # создается файл cert.crt в файловой системе
           {{- with secret <SECRET_PATH> -}}                                                   # путь до секрета в HashiCorp Vault (например, CI01994970_CI02129749/A/SNPS/OSH/IFT/KV/JDBC)
           {{ base64Decode .Data.cert }}                                                       # значение из HashiCorp Vault по ключу cert, переведенное из base64
           {{- end }}                                                   
         vault.hashicorp.com/agent-inject-secret-ca.crt: 'true'                                # включить чтение секрета ca.crt
         vault.hashicorp.com/agent-inject-template-ca.crt: |                                   # создается файл ca.crt
           {{- with secret <SECRET_PATH> -}}                                                   # путь до секрета в HashiCorp Vault (например, CI01994970_CI02129749/A/SNPS/OSH/IFT/KV/JDBC)
           {{ base64Decode .Data.ca }}                                                         # значение из HashiCorp Vault по ключу ca, переведенное из base64
           {{- end }}
         vault.hashicorp.com/agent-inject-secret-key.pk8: 'true'                               # включить чтение секрета key.pk8
         vault.hashicorp.com/agent-inject-template-key.pk8: |                                  # создается файл key.pk8 в файловой системе
           {{- with secret <SECRET_PATH> -}}                                                   # путь до секрета в HashiCorp Vault (например, CI01994970_CI02129749/A/SNPS/OSH/IFT/KV/JDBC)
           {{ base64Decode .Data.key }}                                                        # значение из HashiCorp Vault по ключу key, переведенное из base64
           {{- end }}
         vault.hashicorp.com/agent-inject-secret-db-secret.yml: 'true'                         # включить чтение секрета db-secret.yml
         vault.hashicorp.com/agent-inject-template-db-secret.yml: |                            # создается файл db-secret.yml
           {{- with secret <SECRET_PATH> -}}                                                   # путь до секрета (например, CI01994970_CI02129749/A/SNPS/OSH/IFT/KV/JDBC)
           {{ base64Decode .Data.secret }}                                                     # значение из HashiCorp Vault по ключу db-secret.yml, переведенное из base64
           {{- end }}
 	  	prometheus.io/path: /actuator/prometheus											  # путь контроллера, с которого собирать метрики
 		prometheus.io/scheme: http															  # схема работы, по которой будет отправлять метрики prometheus
 		prometheus.io/port: '8787'															  # порт, на котором доступен web server для prometheus
     spec:
       volumes:
         - name: application-config
           configMap:
             name: service-db-module-app-config                                               # ConfigMap c параметрами конфигурации Шлюза БД
             items:
               - key: application.yml
                 path: application.yml
             defaultMode: 256
         - name: entity-config
           configMap:
             name: service-db-module-entity-config                                           # ConfigMap c параметрами вызова процедур/функций в базе данных
             items:
               - key: db_explorer.yml
                 path: db_explorer.yml
             defaultMode: 256
         - name: synapselogs
           emptyDir: {}
         - name: db-postgre-secman
           configMap:
             name: db-postgre-secman                                                         # ConfigMap со списком секретов, которые нужно ждать из HashiCorp Vault
             items:
               - key: secman.txt
                 path: secman.txt
             defaultMode: 256
       containers:
         - resources:
             limits:
               cpu: 500m                                                                   # cpu limit для контейнера приложения (например, 500m)
               memory: 700Mi                                                               # memory limit для контейнера приложения (например, 700Mi)
             requests:
               cpu: 500m                                                                   # cpu request для контейнера приложения (например, 500m)
               memory: 700Mi                                                               # memory request для контейнера приложения (например, 700Mi)
           readinessProbe:
             httpGet:
               path: /actuator/health/readiness
               port: 8787
               scheme: HTTP
             initialDelaySeconds: 60
             timeoutSeconds: 5
             periodSeconds: 10
             successThreshold: 1
             failureThreshold: 3
           terminationMessagePath: /dev/termination-log
           securityContext:
 		  	capabilities:
 			  drop:
 				- ALL
 		  	privileged: false
             runAsNonRoot: true
             readOnlyRootFilesystem: true
           name: service-db-module
           livenessProbe:
             httpGet:
               path: /actuator/health/liveness
               port: 8787
               scheme: HTTP
             initialDelaySeconds: 60
             timeoutSeconds: 5
             periodSeconds: 10
             successThreshold: 1
             failureThreshold: 5
           env:
             - name: TZ
               value: Europe/Moscow
             - name: PROJECT_NAME
               valueFrom:
                 fieldRef:
                   apiVersion: v1
                   fieldPath: metadata.namespace
             - name: JAVA_OPTS
               value: '-XX:+UseG1GC -XX:+ExitOnOutOfMemoryError'                             # параметры запуска JVM (например, -XX:+UseG1GC -XX:+ExitOnOutOfMemoryError)
           ports:
             - containerPort: 5454
               protocol: TCP
             - containerPort: 8787
               protocol: TCP
           imagePullPolicy: Always
           volumeMounts:
             - name: application-config
               readOnly: true
               mountPath: /deployments/config
             - name: entity-config
               readOnly: true
               mountPath: /deployments/config/entity
             - name: synapselogs
               mountPath: /opt/synapse/logs
             - name: db-postgre-secman
               readOnly: true
               mountPath: /tmp/secman/config
           terminationMessagePolicy: File
           image: >-
             <ссылка на Docker-образ Шлюза БД в целевом репозитории>                       # ссылка на Docker-образ Шлюза БД
       restartPolicy: Always
       terminationGracePeriodSeconds: 60
       dnsPolicy: ClusterFirst

 apiVersion: v1
 kind: Service
 metadata:  
   name: service-db-module
   labels: { app: service-db-module }
 spec:
   selector: { app: service-db-module}                                                   # Селектор для подключения приложения Шлюза БД 
   ports:																				# Порт для подключения приложения Шлюза БД                                         
 	- name: grpc
 	  port: 5454
 	  targetPort: 5454
 	- name: http
 	  protocol: TCP
 	  port: 8787
 	  targetPort: 8787

grpc:
  client:
    settings:
      channelName:
      hostname: <grpc server host>                # имя хоста grpc сервера Шлюза БД, указанное в Service Шлюза БД   
      port: <grpc server port>                    # порт grpc сервера Шлюза БД, указанный в Service Шлюза БД

    entity:
      entityName: "test"
      schema: synapse
      actions:
          - name: "createOrder"
            packageName:
            functionName: "createordercipherreturnid"
            commit: true
            fields:
              - type: "INTEGER"
                name: "customerid"
                nameInProcedure: "customer_id"
                input: true
              - type: "NUMBER"
                name: "totalprice"
                nameInProcedure: "total_price"
                input: true
              - type: "TEXT"
                name: "description"
                nameInProcedure: "descr"
                input: true
                encrypt: true
              - type: "INTEGER"
                name: "orderid"
                nameInProcedure: "order_id"
                input: false