Per l'installazione dello smartkit Rest-Api v2 si deve far riferimento alla documentazione operativa presente qui
| Key | Type | Default | Description |
|---|---|---|---|
| restapi.cfg.kokos.a39Key | string | "" |
The API Key for A39 |
| restapi.cfg.kokos.env | string | "" |
Environment used for Kokos connection |
| restapi.cfg.kokos.pwd | string | "" |
Kokos' user password |
| restapi.cfg.kokos.restApiKey | string | "" |
The API Key for RestAPI |
| restapi.cfg.kokos.url | string | "" |
URL to Kokos APIs |
| restapi.cfg.kokos.useActionStorage | bool | true |
Use the local action storage |
| restapi.cfg.kokos.user | string | "" |
User used for Kokos connection |
| Key | Type | Default | Description |
|---|---|---|---|
| restapi.cfg.smeup | object | See values.yaml |
Smeup configurations |
| restapi.cfg.smeup.a39Key | string | "" |
The API Key for A39 Note: needed only if authenticationType is APIKEY: |
| restapi.cfg.smeup.authenticationType | string | "" |
Configure the type of authentication used. Note: the allowed values are: BASIC , APIKEY or USER_SCOPE_APIKEY |
| restapi.cfg.smeup.env | string | "" |
IBM i Environment Note: must be evalueated with the numeric code (e.g. "0001") |
| restapi.cfg.smeup.environment | string | "PRODUCTION" |
Define the environment and log level. Note: the allowed values are: TEST , STAGING , PRODUCTION |
| restapi.cfg.smeup.user | string | "" |
Service user used for IBM i connection |
| restapi.cfg.smeup.password | string | "" |
Service user's password |
| restapi.cfg.smeup.restApiKey | string | "" |
The API Key for RestAPI Note: needed only if authenticationType is APIKEY: |
| restapi.cfg.smeup.server | string | "" |
IBM i DNS |
| restapi.cfg.smeup.ssl | object | See values.yaml |
SSL configurations |
| restapi.cfg.smeup.ssl.acceptSelfSigned | bool | false |
Accept Self-Signed SSL |
| restapi.cfg.smeup.ssl.certs | list | [] |
SSL Certificates used to connect to IBM i |
| restapi.cfg.smeup.ssl.enabled | bool | false |
Enable SSL |
| restapi.cfg.smeup.useActionStorage | bool | false |
Use the local action storage |
| Key | Type | Default | Description |
|---|---|---|---|
| restapi.cfg.sql | object | See values.yaml |
SQL configurations |
| restapi.cfg.sql.a39Key | string | "" |
The API Key for A39 |
| restapi.cfg.sql.dbType | string | "" |
The kind of SQL Database Note: the allowed values are: mysql |
| restapi.cfg.sql.useActionStorage | bool | true |
Use the local action storage |
| Key | Type | Default | Description |
|---|---|---|---|
| restapi.image.repository | string | "100076361442.dkr.ecr.eu-south-1.amazonaws.com/smeup-rest-api" |
Remote image repository |
| restapi.image.tag | string | "3.0.0" |
Image tag |
| restapi.ingress | object | See values.yaml |
Restapi Ingress configurations |
| restapi.ingress.annotations | object | See values.yaml |
Annotations for ingress |
| restapi.ingress.className | string | nil |
Ingress Class Name, leave empty to use the default Ingress for this cluster |
| restapi.ingress.enabled | bool | true |
Enable the creation of ingress resources |
| restapi.ingress.ssl.hostname | string | nil |
the hostname DNS used for routing and for TLS Note: leave empty if DNS is not configured |
| restapi.ingress.ssl.redirectHttps | bool | true |
Redirect HTTP to HTTPS traffic Note: only works with Traefik ingress |
| restapi.livenessProbe | object | See values.yaml |
Liveness probe configurations |
| restapi.logback | string | See values.yaml |
Logback (logging) configurations |
| restapi.persistence | object | {"accessModes":["ReadWriteOnce"],"size":"1Gi","storageClassName":null} |
volumes and persistence configs |
| restapi.replicaCount | int | 1 |
Number of RestAPI replicas |
| restapi.resources | object | {} |
Resource requests and limits |
| restapi.service | object | See values.yaml |
Service configurations |
| restapi.service.annotations | string | nil |
restapi service annotations |
| restapi.startupProbe | object | See values.yaml |
Startup probe configurations |
La procedura di instazione dello smartkit-rest-api è descritta qui.
In questa sezione vengono descritte quelle che sono tutti i possibili parametri di configurazione disponibili all'interno dello smartkit-rest-api (nel file custom.tfvars)
smeup_rest_api_server="xxx" (Indica l'AS400 a cui collegarsi)
smeup_rest_api_user="xxx" (Indica l'utente di collegamento)
smeup_rest_api_password="xxx" (Indica la password dell'utente)
smeup_rest_api_env="xxx" (Indica l'ambiente di collegamento)
smeup_rest_api_authenticationType="APIKEY" (Indica la modalità di configurazione APIKEY o BASIC)
N.B. Solo se l'authenticationType è APIKEY
smeup_rest_api_a39Key="xxx"
smeup_rest_api_restApiKey="xxx"
Per maggiori dettagli riguardanti l'autenticazione all'interno delle smeup-rest-api rimandiamo alla sezione dedicata.
smeup_rest_api_ssl=false (Indica se usare una connessione SSL verso l'AS400)
smeup_rest_api_ssl_accept_selfsigned=false (Indica se accettare certificati selfsigned)
smeup_rest_api_ssl_certs_directory=/opt/payara/etc/smeup-rest-api/security/certs/ (indica il percorso locale dei certificati)
smeup_rest_api_ssl_trust_store_filepath=/opt/payara/etc/smeup-rest-api/security/trustore (Indica il percorso del truststore)
smeup_rest_api_ssl_trust_store_pwd=changeme (Indica la password del truststore)
smeup_rest_api_useActionStorage=false (Indica se leggere le action da file di configurazione smeup.actions)
kokos_user="xxx" (Inidca l'utente di collegamento a Kokos)
kokos_pwd="xxx" (indica la password dell'utente)
kokos_url="http://KOKOS-IP:PORT" (Indica l'indirizzo di Kokos)
kokos_a39Key="xxx" (Indica l'apikey per gli endpoint dell'A39)
kokos_restApiKey="xxx" (Indica l'apikey per gli endpoint delle rest-api)
kokos_useActionStorage=true (Indica se leggere le action da file di configurazione kokos.actions)
sql_a39Key="" (Indica l'apikey per l'accesso agli endpoint)
sql_dbType="" (Indica il tipo di db a cui ci si vuole collegare mysql | db2 | mssqlserver)
sql_host="" (Indica l'indirizzo del db)
sql_port="" (Indica la porta del db)
sql_user="" (Indica l'utente di collegamento al db)
sql_pwd="" (Indica la password dell'utente)
sql_scheme="" (indica lo schema del db)
smeup_rest_api_environment="" (Indica l'ambiente dell'installazione delle rest-api, può essere: "TEST" | "STAGING" | "PRODUCTION" )
smeup_rest_api_http_external_port="19996" (Indica la porta sulla quale viene esposta l'applicazione)