Aller au contenu principal

Topologie de l'application

L'application GitGuardian est constituée de plusieurs ressources Kubernetes. Chaque pod nginx exécute un conteneur nginx servant le frontend du dashboard et agissant comme proxy pour le backend, ainsi qu'un certain nombre de conteneurs différents servant toutes les tâches du backend.

KindDeployment NameUsage
FrontnginxFrontend du dashboard et proxy pour le backend
Backendinternal-apiBackend pour le Dashboard
Backendinternal-api-longBackend pour le Dashboard (requêtes longues, sans timeout)
Backendpublic-apiAPI publique et scans ggshield
BackendhookRécepteur d'événements webhooks VCS
Backendapp-exporterExporteur Prometheus pour les métriques applicatives
Backendml-secret-engineMoteur de secrets Machine Learning
Backendapache-tikaScanner de fichiers pour le scan des sources non-VCS
SchedulerbeatPlanificateur de tâches Celery Beat
Workerworker-workerWorker polyvalent gérant les scans en temps réel, les nouvelles tentatives, les tâches honeytoken, les rapports (files : check_run, realtime, realtime_retry, honeytoken, reports, core_default, sources_default, incidents_default, individual_validity_check).
Workerworker-check-runsWorker dédié facultatif pour le traitement des check runs (file : check_run). Désactivé par défaut ; activez-le pour décharger check_run de worker-worker.
Workerworker-check-run-scannersWorker dédié facultatif pour les check runs basés sur le scan (limités aux PR) (file : check_run_scan). Désactivé par défaut ; la file se reporte sur worker-scanners.
Workerworker-emailGère les notifications par e-mail et la messagerie (files : email, notifier).
Workerworker-scannersEffectue les scans historiques pour les dépôts (files : basic_repo_scan, premium_repo_scan, manual_repo_scan, code_fixing).
Workerworker-premium-scanners-retryWorker à haute mémoire facultatif réessayant les scans échoués de grands dépôts (file : premium_repo_scan_retry). Désactivé par défaut ; voir Worker de nouvelle tentative de scan premium.
Workerworker-incidents-diskWorker dédié facultatif recalculant les emplacements des secrets (file : incidents_disk). Désactivé par défaut ; la file se reporte sur worker-scanners.
Workerworker-longTraite les tâches de longue durée telles que les vérifications de validité et l'ingestion NHI (files : background_validity_check, update_sources_state, nhi_ingestion, hmsl, core_long, sources_long, incidents_long, ml_backpopulate, endpoints, core_aspm, team_sync).
Workerworker-automatic-severitiesWorker dédié au calcul automatique de la sévérité (file : automatic_severities). 1 réplique par défaut, autoscaling jusqu'à 3.
Workerworker-realtime-odsGère le traitement en temps réel pour les sources non-VCS telles que Slack et Jira (files : realtime_ods, realtime_retry_ods).
Workerworker-long-odsTraite les tâches de longue durée pour les sources non-VCS (file : long_ods).
Workerworker-long-ods-ioSe concentre sur les tâches de longue durée intensives en IO pour les sources non-VCS (file : long_ods_io).
Workerworker-scanners-odsExécute les scans historiques non-VCS pour Jira, Confluence, etc. (file : ods_scan).
Workerworker-scanners-ods-highdiskGère les tâches à fort stockage pour les sources non-VCS (file : ods_scan_highdisk).
Workerworker-scanners-slackExécute les scans historiques Slack (file : slack_scan).
Workerworker-scanners-db-less-jira-cloudWorker dédié facultatif pour les scans historiques Jira Cloud (file : db_less_scan_jira_cloud). Désactivé par défaut. Lorsqu'il a 0 réplique, worker-scanners-ods consomme la file, ou worker-scanners lorsque worker-scanners-ods a également 0 réplique.
Workerworker-scanners-db-less-confluence-cloudWorker dédié facultatif pour les scans historiques Confluence Cloud (file : db_less_scan_confluence_cloud). Désactivé par défaut. Lorsqu'il a 0 réplique, worker-scanners-ods consomme la file, ou worker-scanners lorsque worker-scanners-ods a également 0 réplique.
Workerworker-container-registriesGère le scan de secrets dans les Container registries (file : container_registries).
Workerworker-public-monitoringGère les scans Public Monitoring (files : public_monitoring, public_monitoring_continuous_scan, public_monitoring_historical_scan, public_monitoring_realtime_scan). Actif uniquement sous licence.
Workerworker-business-contributionGère les tâches de contribution métier (file : business_contribution).
Workerworker-ml-api-priorityPriorise les tâches liées à l'API de machine learning (file : ml_api_priority).
Workerworker-scanners-db-lessWorker facultatif pour les scans ne nécessitant pas d'accès à la base de données : JFrog Package Registries, SharePoint et OneDrive (file : db_less_scan). Désactivé par défaut ; la file se reporte sur worker-scanners.
Jobinapp-analyticsCalcule les métriques et agrège les données pour les dashboards Advanced Analytics.
Jobpre-deployTâche de pré-déploiement effectuant les migrations de base de données
Jobpost-deployTâche de post-déploiement effectuant les longues migrations de données
ReplicatedreplicatedGestion des licences et collecte des données d'usage
ReplicatedkotsadmKOTS Admin Console (installation basée sur KOTS uniquement)
info

Nous avons défini un TTL (Time To Live) de 30 jours pour les tâches pre-deploy et post-deploy afin de permettre la récupération des logs si nécessaire. Il est recommandé de ne pas supprimer ces pods, car ils peuvent être utiles pour le dépannage.