Running Foundation¶
If you follow the documentation step by step, at this point you have foundation installed, but it's not running
Sudo access needed.
To proceed with foundation configuration, make sure you have sudo/root access by running:
Video¶
Start¶
Verbosity level
We have decrease the verbosity level of the Foundation Start.
If you need a highest verbosity level, run the command:
INFO[0000] Starting foundation 23.08.11
INFO[0050] [Foundation Core] Starting services
INFO[0055] [Foundation Module] Proxy service created
INFO[0055] [Foundation Module] Storage service created
INFO[0056] [Foundation Module] Supervisor service created
INFO[0056] [Foundation Core] Waiting until foundation core be ready...
INFO[0216] [Foundation Core] Started
INFO[0216] [All modules] Starting
INFO[0178] Starting foundation/engine:23.08.11...
INFO[0184] Started foundation/engine:23.08.11
INFO[0185] Starting foundation/postgres:23.08.11...
INFO[0187] Started foundation/postgres:23.08.11
...
INFO[0319] [All modules] Done
INFO[0319] Foundation started successfully
Fail to start storage
If you don't have the correct permissions, you will receive the error:
======================================
INFO[0000] [Network] Creating overlay network INFO[0000] [Network] Done INFO[0000] [Foundation Core] Starting services INFO[0000] Creating Proxy service with size Pico (120 Mbytes) INFO[0003] [Foundation Module] Proxy started INFO[0003] Creating Supervisor service with size Pico (120 Mbytes) INFO[0006] [Foundation Module] Supervisor started INFO[0006] Creating Storage service with size Pico (120 Mbytes)
Service 'foundation-storage' is slow at starting and is not responding yet. Do you want to wait? (y/n): n
Foundation start process aborted
=====================================
In this case, try again as root (sudo) or fix the permissions.
Access Web App¶
-
Access Keycloak configuration.
-
Access View.
Monitor startup¶
You can monitor foundation startup using commands like:
NAME READY STATUS RESTARTS AGE
foundation-storage-6b985b7c76-wrs4d 1/1 Running 0 5d
foundation-supervisor-847cd77d57-qxdq8 1/1 Running 0 5d
foundation-engine-7b8c75665b-s7p5g 1/1 Running 0 5d
foundation-postgres-78598ffbcd-hzclt 1/1 Running 0 5d
foundation-proxy-d5c7874b-244lk 1/1 Running 1 5d
foundation-keycloak-6b57cbfd57-8dgkp 1/1 Running 0 5d
foundation-view-8cfcd954f-m8s74 1/1 Running 0 5d
foundation-certificates-7b6f4c6df4-f9mct 1/1 Running 0 5d
foundation-licenses-756cf8dbff-4dwxq 1/1 Running 0 5d
foundation-logs-65b945c6d6-nzjnp 1/1 Running 0 5d
Additional modules¶
The foundation core modules are: storage, proxy and supervisor. When they are running, you are ready to add and start other modules.
But you will need some additional modules to support applications.
These files are automatically installed in the server /etc/foundation folder by the *-full.rpm file, but if you installed using other method than the full rpm file, you need to assure the additional modules install manually.
Each module has two files, one small and other bigger. e.g.:
-rw-rw-r-- 1 ggs ggs 139176319 jul 19 17:51 foundation-engine-21.07.30-full.module
-rw-rw-r-- 1 ggs ggs 435 jul 19 17:51 foundation-engine-21.07.30.module
To facilitate understanding of foundation module's name:
Name: foundation-engine-21.07.30.module
Description: appName-moduleName-moduleVersion.module
In this case, if your server has access to foundationregistry.synchro.com.br, you don't need the big file. So you can get the file without -full keyword. Otherwise you will need the big one.
- The big file has a full docker image and does not need to access
foundationregistry.synchro.com.brregistry to download it. - The small file is easy to store and deploy, but at the first module start docker will download the full image from
foundationregistry.synchro.com.br.
Foundation Engine module¶
There is a additional module very important to foundation. The engine was separated just to allow updates to be applied without affecting the foundation core.
The engine module needs to be installed via command-line and will not be successful in web interface (view module).
Foundation Postgres¶
Foundation has a postgres module to simplify multitenancy management. Authlayer module depends on it. So install and start foundation-postgres module before foundation-authlayer.
Foundation Authlayer¶
Foundation has a built-in authlayer management module responsible to authenticate user with Keycloak before redirect to applications. This way applications don't need to worry about authentication.
For more information, see foundation-authlayer.
Foundation View¶
Foundation view is a web module, after install you will be able to manage foundation using any HTTP browser.
For more information, see foundation-view.
Foundation Certificates¶
Foundation certificates is a certificate module, after install you will be able to manage KeyStore and TrustStore using any HTTP browser.
For more information, see foundation-certificates.
Foundation Logs¶
Foundation logs is a logs module, after install you will be able to view log module using any HTTP browser.
For more information, see foundation-logs.
Foundation Licenses¶
Licenses is a Foundation's module responsible for providing the information for Synchro customers to license the contracted products into Foundation.
For more information, see foundation-licenses.
Foundation Monitor¶
Unify metrics with log and trace analytics on foundation-monitor managed service. This module integrated, real-time alerting, security Dashboard and more.
- Under Construction
Foundation Keycloak¶
Keycloak is a open source identity and access management for modern applications and services.
For more information, see foundation-keycloak.
Other foundation modules¶
Each application can be additional module requirements. Please check application documentation.
Foundation Commands¶
Foundation provides a few command line features, so you can manage, verify and troubleshoot Foundation and apps.
The features are provided through the binary foundation installed on your on Linux server.
For more information, see command line.