{"id":26233966,"url":"https://github.com/teragrep/cfe_18","last_synced_at":"2025-04-22T12:11:36.234Z","repository":{"id":197788414,"uuid":"699318859","full_name":"teragrep/cfe_18","owner":"teragrep","description":"Integration main data management for Teragrep","archived":false,"fork":false,"pushed_at":"2025-04-17T13:43:29.000Z","size":271,"stargazers_count":0,"open_issues_count":52,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-18T04:23:02.832Z","etag":null,"topics":["centralized-logging","data-management","integration-platform","log-management","teragrep"],"latest_commit_sha":null,"homepage":"https://teragrep.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teragrep.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-10-02T11:57:51.000Z","updated_at":"2025-04-17T13:43:33.000Z","dependencies_parsed_at":"2025-01-08T12:29:14.434Z","dependency_job_id":"657aaf07-6db2-44ca-bcab-f36cb78a8d58","html_url":"https://github.com/teragrep/cfe_18","commit_stats":null,"previous_names":["teragrep/cfe_18"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teragrep%2Fcfe_18","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teragrep%2Fcfe_18/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teragrep%2Fcfe_18/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teragrep%2Fcfe_18/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teragrep","download_url":"https://codeload.github.com/teragrep/cfe_18/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250237834,"owners_count":21397401,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["centralized-logging","data-management","integration-platform","log-management","teragrep"],"created_at":"2025-03-13T01:18:18.670Z","updated_at":"2025-04-22T12:11:36.213Z","avatar_url":"https://github.com/teragrep.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"= CFE_18, Integration main data management for Teragrep\n\nCFE_18 takes advantage of relational-database standardization and MariaDB system-versioning through creating database schema according to integration data needs.\n\nThe project uses the Flyway migration strategy to ensure fault-free deployment and presents data through Swagger UI via RESTful endpoints. CFE_18 does have Spring Boot framework built-in which utilizes the framework only through endpoints. MyBatis works as a mapper between Spring boot and MariaDB database and creates queries specified within said mappers.\n\n== Features\n\n* CFE_18 can be used to manage integrations\n* Schema structure can be modified to accommodate user needs\n\n== Documentation\n\nSee the official documentation on https://docs.teragrep.com[docs.teragrep.com].\n\n== Limitations\n\n* Java 8\n\n== How to Use\n\n. Setup database according to end-user needs\n. Can be deployed using https://tomcat.apache.org/tomcat-9.0-doc/deployer-howto.html[tomcat]/JBoss\n\n== How to Run in a Container?\n\n\nNOTE: Files are stored under `quadlet/docker` directory. They are viable for containerized deployment without Quadlet.\n\n\nThe project requires an external database to use. CFE_18 image uses https://docs.docker.com/build/building/multi-stage/[multi-stage] to build Rocky Linux 9 during the first stage as base image and installs Apache Tomcat on top of the previous stage. CFE_18.war is deployed via using Apache Tomcat.\n\nExpected files are:\n\n* `/etc/tomcat/Catalina/localhost/cfe-18/application.properties`\n* `/etc/tomcat/Catalina/localhost/cfe-18/log4j2.xml`\n\nExample files for configuration are:\n\n* `/quadlet/docker/application.properties`\n* `/quadlet/docker/log4j2.xml`\n\n/quadlet/docker/application.properties requires configuring:\n\n* spring.datasource.url = jdbc:mariadb://127.0.0.1:3306/cfe_18\n* spring.datasource.username = username\n* spring.datasource.password = password\n* spring.datasource.driver-class-name = org.mariadb.jdbc.Driver\n\nMariaDB must be used as the database solution for CFE_18 containerized deployment, when using CFE_18 image. It is required since CFE_18 takes advantage of MariaDB's https://mariadb.com/kb/en/system-versioned-tables/[system-versioned tables].\n\n.Example run command\n[source,console]\n----\n$ docker run -ti  -v /quadlet/docker/application.properties:/etc/tomcat/Catalina/localhost/cfe-18/application.properties:ro -v /quadlet/docker/log4j2.xml:/etc/tomcat/Catalina/localhost/cfe-18/log4j2.xml:ro  -p 8080:8080 ghcr.io/teragrep/cfe_18:latest\n----\nPlease notice that in the example command above:\n\n1. `application.properties` and `log4j2.xml` are mounted accordingly.\n2. 8080:8080 are for external and internal ports.\n3. ghcr.io/teragrep/cfe_18:latest image from Githubs image repository\n\n\n\n=== How to run container with Quadlet\n\nhttps://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html[See also the Quadlet's documentation.]\n\nIMPORTANT: This is the recommended deployment style for containerized deployment. Running Podman containers without Quadlets results them not starting independently after host reboots.\n\n\n==== Docker directory\n\nFiles inside the directory are required for Apache Tomcat to deploy CFE_18. They are explained in the section `How to Run in a Container?`\n\n==== docker-entrypoint-initdb.d directory\n\nFiles inside the directory are required for MariaDB to initialize with the correct databases intact.\nSee also MariaDB https://hub.docker.com/_/mariadb[initialization script documentation for initializing the database contents].\n\n==== cfe18.container\n\nThe following Quadlet file is required to deploy CFE_18 Podman container as a system service. The example below is from `quadlet/cfe18.container`.\n\nThe following Quadlet file is inserted under `/etc/containers/systemd` on the host machine. See more on https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html[Podman Quadlet docs].\n\n.Quadlet file for CFE_18 container\n----\n[Unit]\nDescription=CFE_18 container\nRequires=cfe18mariadb.service\n\n[Container]\nImage=ghcr.io/teragrep/cfe_18:latest\nVolume=/opt/teragrep/cfe_18/app:/etc/tomcat/Catalina/localhost/cfe_18:Z\nPublishPort=8080:8080\n# Static IP for cfe_18\nIP=10.88.0.3\n\n[Install]\n# Start by default on boot\nWantedBy=multi-user.target default.target\n----\n\nKeywords explained\n\n- Requires -- Needs to have MariaDB service running before starting cfe18 container\n- Image -- Pulls image from gchr.io to be used for container deployment\n- Volume -- Mounts contents of  `quadlet/docker` under Tomcat configuration (`application.properties` and `log4j2.xml`)\n- PublishPort -- Opens an internal and an external port for accessing CFE_18\n- IP -- Declare IP in Podman subnet\n\n==== cfe18mariadb.container\n\nThe following Quadlet file is required to deploy MariaDB Podman container as system service. Example below is from `quadlet/cfe18mariadb.container`.\n\nThe following Quadlet file is inserted under `/etc/containers/systemd` on the host machine. See more on https://docs.podman.io/en/latest/markdown/podman-systemd.unit.5.html[Podman Quadlet docs].\n\n.Quadlet file for MariaDB container\n----\n[Unit]\nDescription=Database container for CFE_18\n\n[Container]\nImage=docker.io/mariadb:11.5\nSecurityLabelDisable=true\n# Should be stored as a secret when actually using to deploy.\nEnvironment=MARIADB_ROOT_PASSWORD=password\n# Static IP for cfe_18 to connect to\nIP=10.88.0.2\n# DB initialization script\nVolume=/opt/teragrep/cfe_18/database/init:/docker-entrypoint-initdb.d\n# Persistent Storage\nVolume=/opt/teragrep/cfe_18/database/data:/var/lib/mysql\n\n[Install]\nWantedBy=multi-user.target default.target\n----\nKeywords explained\n\n- Image -- Pulls image from gchr.io to be used for container deployment\n- SecurityLabelDisable -- Turns off SELinux labeling\n- Environment -- Env variable which is required by MariaDB image to install MariaDB inside the container\n- IP -- Declare IP in Podman subnet\n- Volume(1) -- Mounts contents of  `quadlet/docker-entrypoint-inidb.d` into the container for MariaDB to start database initialization\n- Volume(2) -- Creates persistent storage which is saved on host under `/opt/teragrep/cfe_18/database/data`\n\n\n== Contributing\n\nYou can involve yourself with our project by https://github.com/teragrep/cfe_18/issues/new/choose[opening an issue] or submitting a pull request.\n\nContribution requirements:\n\n. *All changes must be accompanied by a new or changed test.* If you think testing is not required in your pull request, include a sufficient explanation as why you think so.\n. Security checks must pass\n. Pull requests must align with the principles and http://www.extremeprogramming.org/values.html[values] of extreme programming.\n. Pull requests must follow the principles of Object Thinking and Elegant Objects (EO).\n\nRead more in our https://github.com/teragrep/teragrep/blob/main/contributing.adoc[Contributing Guideline].\n\n=== Contributor License Agreement\n\nContributors must sign https://github.com/teragrep/teragrep/blob/main/cla.adoc[Teragrep Contributor License Agreement] before a pull request is accepted to organization's repositories.\n\nYou need to submit the CLA only once.\nAfter submitting the CLA you can contribute to all Teragrep's repositories.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteragrep%2Fcfe_18","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteragrep%2Fcfe_18","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteragrep%2Fcfe_18/lists"}