Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add scheduled refresh settings cache from DB #969

Merged
merged 2 commits into from
Feb 13, 2025
Merged

Add scheduled refresh settings cache from DB #969

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ada10ea
Add scheduled refresh settings cache from DB
lubomirw Feb 13, 2025
9a88812
Update README and fix test to preload settings cache in setting servi…
lubomirw Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,28 +62,29 @@ Operations can be automated by the `Core`, but also can be performed manually by

`Core` is provided as a Docker container. Use the `czertainly/czertainly-core:tagname` to pull the required image from the repository. It can be configured using the following environment variables:

| Variable | Description | Required | Default value |
|---------------------------|-----------------------------------------------------------------------|----------------------------------------------------|---------------------|
| `JDBC_URL` | JDBC URL for database access | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `JDBC_USERNAME` | Username to access the database | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `JDBC_PASSWORD` | Password to access the database | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `DB_SCHEMA` | Database schema to use | ![](https://img.shields.io/badge/-NO-red.svg) | `core` |
| `PORT` | Port where the service is exposed | ![](https://img.shields.io/badge/-NO-red.svg) | `8080` |
| `HEADER_NAME` | Name of the header where the certificate of the client can be found | ![](https://img.shields.io/badge/-NO-red.svg) | `X-APP-CERTIFICATE` |
| `HEADER_ENABLED` | True if the certificate should be get from the header | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `TS_PASSWORD` | Password for the trusted certificate store | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `OPA_BASE_URL` | Base URL of the Open Policy Agent | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `AUTH_SERVICE_BASE_URL` | Base URL of the authentication service | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `AUTH_TOKEN_HEADER_NAME` | Name of the header for the JSON ID content | ![](https://img.shields.io/badge/-NO-red.svg) | `X-USERINFO` |
| `SCHEDULED_TASKS_ENABLED` | Scheduled certificate status update enable / disable | ![](https://img.shields.io/badge/-NO-red.svg) | `true` |
| `JAVA_OPTS` | Customize Java system properties for running application | ![](https://img.shields.io/badge/-NO-red.svg) | `N/A` |
| `TRUSTED_CERTIFICATES` | List of PEM encoded additional trusted certificates | ![](https://img.shields.io/badge/-NO-red.svg) | `N/A` |
| `SCHEDULER_BASE_URL` | Base URL of the scheduler service | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_HOST` | RabbitMQ messaging host | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_PORT` | RabbitMQ messaging port | ![](https://img.shields.io/badge/-NO-red.svg) | `5672` |
| `RABBITMQ_USERNAME` | RabbitMQ messaging username | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_PASSWORD` | RabbitMQ messaging password | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_VHOST` | RabbitMQ messaging virtual host | ![](https://img.shields.io/badge/-NO-red.svg) | `czertainly` |
| Variable | Description | Required | Default value |
|-----------------------------------|---------------------------------------------------------------------|----------------------------------------------------|---------------------|
| `JDBC_URL` | JDBC URL for database access | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `JDBC_USERNAME` | Username to access the database | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `JDBC_PASSWORD` | Password to access the database | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `DB_SCHEMA` | Database schema to use | ![](https://img.shields.io/badge/-NO-red.svg) | `core` |
| `PORT` | Port where the service is exposed | ![](https://img.shields.io/badge/-NO-red.svg) | `8080` |
| `HEADER_NAME` | Name of the header where the certificate of the client can be found | ![](https://img.shields.io/badge/-NO-red.svg) | `X-APP-CERTIFICATE` |
| `HEADER_ENABLED` | True if the certificate should be get from the header | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `TS_PASSWORD` | Password for the trusted certificate store | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `OPA_BASE_URL` | Base URL of the Open Policy Agent | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `AUTH_SERVICE_BASE_URL` | Base URL of the authentication service | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `AUTH_TOKEN_HEADER_NAME` | Name of the header for the JSON ID content | ![](https://img.shields.io/badge/-NO-red.svg) | `X-USERINFO` |
| `SCHEDULED_TASKS_ENABLED` | Scheduled certificate status update enable / disable | ![](https://img.shields.io/badge/-NO-red.svg) | `true` |
| `JAVA_OPTS` | Customize Java system properties for running application | ![](https://img.shields.io/badge/-NO-red.svg) | `N/A` |
| `TRUSTED_CERTIFICATES` | List of PEM encoded additional trusted certificates | ![](https://img.shields.io/badge/-NO-red.svg) | `N/A` |
| `SCHEDULER_BASE_URL` | Base URL of the scheduler service | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_HOST` | RabbitMQ messaging host | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_PORT` | RabbitMQ messaging port | ![](https://img.shields.io/badge/-NO-red.svg) | `5672` |
| `RABBITMQ_USERNAME` | RabbitMQ messaging username | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_PASSWORD` | RabbitMQ messaging password | ![](https://img.shields.io/badge/-YES-success.svg) | `N/A` |
| `RABBITMQ_VHOST` | RabbitMQ messaging virtual host | ![](https://img.shields.io/badge/-NO-red.svg) | `czertainly` |
| `SETTINGS_CACHE_REFRESH_INTERVAL` | Interval of scheduled settings cache refresh from DB (in seconds) | ![](https://img.shields.io/badge/-NO-red.svg) | 30 |)

### OpenTelemetry settings

Expand Down
8 changes: 8 additions & 0 deletions src/main/java/com/czertainly/core/service/impl/SettingServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,17 @@
import jakarta.transaction.Transactional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.slf4j.MarkerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.io.InputStream;
import java.net.*;
import java.text.ParseException;
import java.util.*;
import java.util.concurrent.TimeUnit;

@Service
@Transactional
Expand All @@ -61,6 +64,11 @@ public SettingServiceImpl(SettingsCache settingsCache, SettingRepository setting
this.settingsCache = settingsCache;
this.settingRepository = settingRepository;

refreshCache();
}

@Scheduled(fixedRateString = "${settings.cache.refresh-interval}", timeUnit = TimeUnit.SECONDS, initialDelayString = "${settings.cache.refresh-interval}")
public void refreshCache() {
settingsCache.cacheSettings(SettingsSection.PLATFORM, getPlatformSettings());
settingsCache.cacheSettings(SettingsSection.LOGGING, getLoggingSettings());
settingsCache.cacheSettings(SettingsSection.NOTIFICATIONS, getNotificationSettings());
Expand Down
3 changes: 3 additions & 0 deletions src/main/resources/application.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ auth-service.base-url=${AUTH_SERVICE_BASE_URL}
opa.base-url=${OPA_BASE_URL}
scheduler.base-url=${SCHEDULER_BASE_URL}

# Settings
settings.cache.refresh-interval=${SETTINGS_CACHE_REFRESH_INTERVAL:30}

spring.jpa.properties.hibernate.jdbc.batch_size=500
spring.jpa.properties.hibernate.order_updates=true
spring.jpa.properties.hibernate.order_inserts=true
Expand Down
Loading