Skip to main content

Complete Configurations

Below you'll find all the available configurations for restapi, with the relative default values.

# Default values for restapi.
# This is a YAML-formatted file.

# @ignored -- Global configurations
global:
  # -- Telemetry Configurations
  telemetry:
    # -- Enable Telemetry
    enabled: true
  imagePullSecrets:
    - name: aws-ecr-regcred
  nameOverride: ""
  fullnameOverride: ""

restapi:
  # -- Number of RestAPI replicas
  replicaCount: 1
  # @ignored -- Image settings
  image:
    # -- Remote image repository
    repository: 100076361442.dkr.ecr.eu-south-1.amazonaws.com/smeup-rest-api
    # -- Image tag
    tag: "3.1.5"

  # -- RestAPI application configurations
  # @default -- See `values.yaml`
  cfg:
    # -- Smeup configurations
    # @default -- See `values.yaml`
    smeup:
      # -- (string) IBM i DNS
      server: ""
      # -- (string) Service user used for IBM i connection
      user: ""
      # -- (string) Service user's password
      password: ""
      # -- (string) IBM i Environment
      # Note: must be evalueated with the numeric code (e.g. "0001")
      env: ""
      ## -- IBM i minimum idle connections
      minIdle: "2"
      ## -- IBM i maximum idle connections
      maxIdle: "8"
      ## -- IBM i maximum concurrent connections
      maxTotal: "32"
      # -- Configure the type of authentication used.
      # Note: the allowed values are: BASIC || APIKEY || USER_SCOPE_APIKEY
      authenticationType: ""
      # -- The API Key for A39
      # Note: needed only if authenticationType is APIKEY:
      a39Key: ""
      # -- The API Key for RestAPI
      # Note: needed only if authenticationType is APIKEY:
      restApiKey: ""
      # -- Secret used for authentication
      # Note: needed only if authenticationType is USER_SCOPE_APIKEY:
      apiKeySecret: "apiKeySecret"
      # -- Define the environment and log level.
      # Note: the allowed values are: TEST || STAGING || PRODUCTION
      environment: "PRODUCTION"
      # -- Use the local action storage
      useActionStorage: false

      # -- SSL configurations
      # @default -- See `values.yaml`
      ssl:
        # -- Enable SSL
        enabled: false
        # -- Accept Self-Signed SSL
        acceptSelfSigned: false
        # -- SSL Certificates used to connect to IBM i
        certs: []
          #- name: my-custom-certificate
          #  b64: <BASE64-CERTIFICATE>

    # -- Kokos configurations
    # @default -- See `values.yaml`
    kokos:
      # -- (string) User used for Kokos connection
      user: ""
      # -- (string) Kokos' user password
      pwd: ""
      # -- (string) Environment used for Kokos connection
      env: ""
      # -- (string) URL to Kokos APIs
      url: ""
      # -- The API Key for A39
      a39Key: ""
      # -- The API Key for RestAPI
      restApiKey: ""
      # -- Use the local action storage
      useActionStorage: true

    # -- SQL configurations
    # @default -- See `values.yaml`
    sql:
      # -- The API Key for A39
      a39Key: ""
      # -- The kind of SQL Database
      # Note: the allowed values are: mysql || db2 || mssqlserver
      dbType: ""
      host: ""
      port: ""
      user: ""
      pwd: ""
      scheme: ""
      # -- Use the local action storage
      useActionStorage: true

  # -- volumes and persistence configs
  # @default -- See `values.yaml`
  persistence:
    # leave blank to use cluster default storageClass
    # two most used values are "local-path" for local-path-provisioner on k3s and "efs-sc" for EFS on EKS
    storageClassName:
    # storage size for webup PVC
    # with k3s local storage and AWS EFS this value is not an actual limit, so it can be left as is
    size: 1Gi
    accessModes:
      # access mode for the volume
      # "ReadWriteOnce" works only on single node clusters
      # "ReadWriteMany" works only on multi-node clusters - an appropriate storageClassName must be configured and used (i.e. efs-sc)
      - ReadWriteOnce

  # @ignored -- Restapi Service configurations
  service:
    type: ClusterIP
    port: 80
    # -- restapi service annotations
    annotations:
      # -- EXAMPLE AWS SPECIFIC ANNOTATIONS --
      # -- IF YOU CHANGE THESE CONFIGURATIONS AFTER THE FIRST APPLY YOU WILL NEED TO DELETE THE LOADBALANCER SVC AND RECREATE IT --
      # service.beta.kubernetes.io/aws-load-balancer-type: nlb
      # service.beta.kubernetes.io/aws-load-balancer-ssl-cert: <Replace this with your certificate ARN>
      # service.beta.kubernetes.io/aws-load-balancer-backend-protocol: http
      # service.beta.kubernetes.io/aws-load-balancer-ssl-ports: "443,3500"
      # service.beta.kubernetes.io/aws-load-balancer-proxy-protocol: "*"

  # -- Restapi Ingress configurations
  # @default -- See `values.yaml`
  ingress:
    # -- Enable the creation of ingress resources
    enabled: true
    # -- (string) Ingress Class Name, leave empty to use the default Ingress for this cluster
    className:
    # -- Annotations for ingress
    # @default -- Traefik compatible HTTPS annotations
    annotations:
      traefik.ingress.kubernetes.io/router.entrypoints: websecure
      traefik.ingress.kubernetes.io/router.tls: "true"
    ssl:
      # -- (string) the hostname DNS used for routing and for TLS
      # Note: leave empty if DNS is not configured
      hostname:
      # -- Redirect HTTP to HTTPS traffic
      # Note: only works with Traefik ingress
      redirectHttps: true

  # @ignored Node selector to constrain pod scheduling to nodes with specific labels
  nodeSelector:
    #kubernetes.io/arch: ppc64le
    #node.openshift.io/os_id: rhcos

  # @ignored Custom Deployment Annotations
  customDeploymentAnnotations:
    instrumentation.opentelemetry.io/inject-java: "true"

  # @ignored Pod security context
  podSecurityContext:
    fsGroup: 1000
    runAsUser: 1000
    runAsGroup: 1000

  # -- Resource requests and limits
  resources: {}
    # We usually recommend not to specify default resources and to leave this as a conscious
    # choice for the user. This also increases chances charts run on environments with little
    # resources, such as Minikube. If you do want to specify resources, uncomment the following
    # lines, adjust them as necessary, and remove the curly braces after 'resources:'.
    # limits:
    #   cpu: 2000m
    #   memory: 8Gi
    # requests:
    #   cpu: 1000m
    #   memory: 4Gi

  # @ignored -- Startup probe configurations
  startupProbe:
    enabled: true
    path: /apiservice/api/services/openapi.yaml
    port: application
    initialDelaySeconds: 0
    periodSeconds: 10
    timeoutSeconds: 10
    successThreshold: 1
    failureThreshold: 9

  # @ignored -- Liveness probe configurations
  livenessProbe:
    enabled: true
    path: /apiservice/livez
    port: application
    initialDelaySeconds: 15
    periodSeconds: 300
    timeoutSeconds: 20
    successThreshold: 1
    failureThreshold: 2

  # @ignored -- Readiness probe configurations
  readinessProbe:
    enabled: true
    path: /apiservice/readyz
    port: application
    initialDelaySeconds: 10
    periodSeconds: 10
    timeoutSeconds: 5
    successThreshold: 1
    failureThreshold: 3

  # -- Logback (logging) configurations
  # @default -- See `values.yaml`
  logback:
    <configuration>
      <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
          <!-- encoders are assigned the type
            ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
          <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{70} - %msg %n</pattern>
          </encoder>
      </appender>
      <!--appender name="JSONDB" class="com.smeup.qylog.write.jsondb.QylogJsondbAppender">
          <location>${varRoot}/jsondb</location>
      </appender-->
      <root level="INFO">
          <appender-ref ref="STDOUT" />
          <!--appender-ref ref="JSONDB" /-->
      </root>
    </configuration>