Gecko
System

Update

This document provides information about the update service.

Overview 👀

Logger software uses a microservice based container structure. Each module runs in independent containers and can be updated separately. This approach ensures gradual updates while maintaining system stability.

Container Modules 🐋

Alert Module 🚨

Alertapi: API project for managing and delivering alert notifications within the Alert application. Alert-notifier: Core component responsible for notifying users about alerts based on predefined policies. Filtering-engine: Core component that filters and aggregates incoming alert data based on predefined rules.

Collector Module 🧲

Collectorapi: API project for collecting, filterin data and managing data sources within the Collector application. Filetransfer: Worker description Listener: Worker service project for listening to incoming data streams within the Collector application. Preprocessor: Worker service project for preprocessing data before further processing within the Collector application. Signexporter: Worker service responsible for exporting and signing processed data.

Core Module 🌰

Coreapi: API project for core functionalities and services within the Core application. Identityapi: API project for managing identity and authentication services within the Core application. Layoutapi: API project for managing layout and UI-related services within the Core application.

Gateway Module 🚧

Gatewayapi: API project for managing gateway and reverse proxy services within the Gateway application.

Manager 👨‍💼

Managerapi: API project for managing various services and operations within the Manager application. Updater: Worker service project for updating and maintaining services within the Manager application.

Report 📊

Reportapi: API project for generating and managing reports within the Report application.

Api 🌐

Senderapi: Sender API for handling message dispatching and related operations

Frontend ✨

Frontend: Frontend component responsible for the user interface and client-side interactions of the application. Authentication: Authentication portal component responsible for handling user authentication and authorization. Docs: Documentation component responsible for providing information and guidance on the application.

Update Management ♻️

General Controls 🕹️

Enable Automatic Updates 🟢

  • Description: Global automatic update setting for all containers
  • Usage: It can be activated/passivated with the Toggle button
  • Effect: All containers are automatically updated when activated

Version Type 💡

  • Description: Update type selection
  • Options: Stable, Beta, Alpha versions
  • Recommendations: Use Stable in a production environment

Update Check ✅

  • Description: Checks for updates for all containers
  • Function: Checks and reports new versions
  • Usage: Used for manual control

Update All ♻️

  • Description: Updates all existing containers at once
  • Warning: May cause system-wide outage
  • Recommendations: Use in maintenance windows

Container Based Management 🐋

Container Status 🟢

  • Running: Container is actively running
  • Exited: Container stopped (update may be required)

Version Control 🕹️

  • CURRENT: Current running version
  • LATEST: Latest available version
  • "latest" Tag: Container current status

Individual Container Operations 🛠️

  • Update Button: Updates only that container
  • Enable/Disable Toggle: Container based automatic update control

System İnformation 🛠

The following performance metrics are displayed for each container:

  • CPU: Percent processor utilization
  • MEMORY: Memory usage (MB/GB)
  • DISK I/O: Disk input/output traffic
  • NET I/O: Network input/output traffic
  • UPTIME: Container uptime

Update Strategies 🎯

Production Environment ♻️

  • Gradual Update: Update containers one by one
  • *Test Priority: Start with non-critical modules
  • Backup: Make a system backup before update
  • Monitor: Check system status after each update

Test Environment 🔬

  • Bulk Update: You can use Update All
  • Automatic Update: Enable Automatic Updates
  • Beta Versions: Use beta options in Version Type

Best Practices ✍

Security 🛡️

  • Take a system backup before updating
  • Do not update during critical hours
  • Check the operational status of each container

Performance 📈

  • Update containers with high CPU/Memory usage first
  • Do not update during disk I/O intensive periods
  • Update when network traffic is low

Monitoring 👀

  • Check UPTIME values after update
  • Verify that STATUS is "Running"
  • Review log files for error checking

Troubleshooting 🔧

Container Not Starting ❌

  • If STATUS is "Exited" restart the container
  • Check log files
  • Check system resources (CPU/Memory)

Update Failed ⛔

  • Check update status with Update Check
  • Verify network connectivity
  • Check that disk space is sufficient

Performance Issues ⚠️

  • Detect high CPU/Memory usage
  • Try restarting Container
  • Consider reverting to an older version

Feature Visibility

This document provides information about feature sets.

System Settings

This document provides information about system settings and theme options.