Here is a detailed matrix for the containers required for Onify Hub.
Note: Elasticseach could also be hosted outside the Onify Hub.
| APP | API | WORKER | AGENT-SERVER | FUNCTIONS | ELASTICSEARCH | |
|---|---|---|---|---|---|---|
| -- DEPLOYMENT -- | ||||||
| Service | app | api | worker | agent-server | functions | elasticsearch |
| Optional | No | No | No | No | Yes | No |
| Ports | 3000 | 8181 | n/a | 8080 | 8282 | 9200 |
| Public | Yes | Optional | n/a | Yes | Yes | No |
| Stateless | Yes | Yes | Yes | Yes | Yes | No |
| Internet access | No | Yes | Yes | No | Maybe | No |
| Depends on | api | elasticearch, agent-server | elasticearch, agent-server | n/a | n/a | n/a |
| Pods | 1+ | 1+ | 1+ | 1 | 1+ | 1 |
| Source | Node.js | Node.js | Node.js | Golang | Node.js | Java |
| DNS name | Yes | Optional | No | Yes | Yes | No |
| SSL cert | Yes | Optional | n/a | Yes | Yes | n/a |
| Image | eu.gcr.io/onify-images/hub/app:{version} | eu.gcr.io/onify-images/hub/api:{version} | eu.gcr.io/onify-images/hub/api:{version} | eu.gcr.io/onify-images/hub/agent-server:{version} | eu.gcr.io/onify-images/hub/functions:{version} | docker.elastic.co/elasticsearch/elasticsearch:{version} |
| -- ENVIRONMENT -- | ||||||
| ES_JAVA_OPTS | n/a | n/a | n/a | n/a | n/a | -Xms1g -Xmx1g |
| discovery.type | n/a | n/a | n/a | n/a | n/a | single-node |
| cluster.name | n/a | n/a | n/a | n/a | n/a | onify |
| NODE_ENV | production | production | production | n/a | n/a | n/a |
| ENV_PREFIX | ONIFY_ | ONIFY_ | ONIFY_ | n/a | n/a | n/a |
| INTERPRET_CHAR_AS_DOT | _ | _ | _ | n/a | n/a | n/a |
| ONIFY_autoinstall | n/a | TRUE | TRUE | n/a | n/a | n/a |
| ONIFY_db_elasticsearch_host | n/a | http://{elasticsearch}:9200 | http://{elasticsearch}:9200 | n/a | n/a | n/a |
| ONIFY_db_indexPrefix | n/a | onify | onify | n/a | n/a | n/a |
| ONIFY_client_secret | n/a | *** | *** | n/a | n/a | n/a |
| ONIFY_client_code | n/a | {CLIENT CODE}* | {CLIENT CODE}* | n/a | n/a | n/a |
| ONIFY_client_instance | n/a | {INSTANCE CODE}* | {INSTANCE CODE}* | n/a | n/a | n/a |
| ONIFY_initialLicense | n/a | {LICENSE}* | {LICENSE}* | n/a | n/a | n/a |
| ONIFY_adminUser_username | n/a | admin | admin | n/a | n/a | n/a |
| ONIFY_adminUser_password | n/a | *** | *** | n/a | n/a | n/a |
| ONIFY_adminUser_email | n/a | noreply@onify.co | noreply@onify.co | n/a | n/a | n/a |
| ONIFY_apiTokens_app_secret | n/a | *** | *** | n/a | n/a | n/a |
| ONIFY_resources_baseDir | n/a | ./data/resources | ./data/resources | n/a | n/a | n/a |
| ONIFY_resources_tempDir | n/a | ./data/storage | ./data/storage | n/a | n/a | n/a |
| ONIFY_websockets_agent_url | n/a | ws://{agent-server}:8080/hub | ws://{agent-server}:8080/hub | n/a | n/a | n/a |
| ONIFY_worker_cleanupInterval | n/a | n/a | 30 | n/a | n/a | n/a |
| ONIFY_api_admintoken | Bearer {base64(app:{ONIFY_apiTokens_app_secret})} | n/a | n/a | n/a | n/a | n/a |
| ONIFY_api_internalUrl | http://{api}:8181/api/v2 | n/a | n/a | n/a | n/a | n/a |
| ONIFY_api_externalUrl | /api/v2 | n/a | n/a | n/a | n/a | n/a |
* Please contact your local partner or Onify (support@onify.co) to get
LICENSE,CLIENT CODEandINSTANCE CODE.
Here we explain the meaning of the different DEPLOYMENT settings.
| What | Meaning |
|---|---|
| Service | Name of the service |
| Optional | If the service is optional or not |
| Ports | What ports that are used for the container. These should be forwarded to port 80 or 443. |
| Public | If the container should be exposed outside the cluster. |
| Stateless | Neither reads nor stores information about its state from one time that it is run to the next. |
| Internet access | The service requires internet access. Mostly used for Git communication. |
| Depends on | What other containers/services that it depends on (or links to). |
| Pods | If the container can be scaled or not. |
| Source | Source code for logging purposes. |
| DNS name | Does the service need a seperate DNS name or not. |
| SSL cert | Does the service need a SSL certificate. Related to DNS name. |
| Image | Container (Docker) image. |