feat(initContainer): Tune start-up process

[kiblik]

Previous implementation used initialDelaySeconds set to 120s which might be fine for standard (default resource allocation), first-time starting (with empty database) instances. Mentioned fact is problematic for:

• instances that are "under-resourced" and start-ups might be longer and 120s might not be enough
• instances that are "over-resourced" and start-ups might be much shorter and 120s might be wasting of time (to wait until the instance is marked as Ready)
• instances that are already deployed and just need upgrade (with no or only just a couple of migrations). In this case, it is wasting of time again.
• instances with multiple replicas when each replica needs to wait 2 minutes without the reason. Waisting of time again.

This solution does not solve #10197 but at least do not silently allow full rollout until the database is fully migrated.

This solution might be solved as well #10141

[dryrunsecurity]

Hi there 👋, @DryRunSecurity here, below is a summary of our analysis and findings.

DryRun Security	Status	Findings
Configured Codepaths Analyzer	✅	0 findings
IDOR Analyzer	✅	0 findings
Sensitive Files Analyzer	✅	0 findings
Server-Side Request Forgery Analyzer	✅	0 findings
SQL Injection Analyzer	✅	0 findings
Authn/Authz Analyzer	✅	0 findings
Secrets Analyzer	✅	0 findings

Note

🟢 Risk threshold not exceeded.

Change Summary (click to expand)

The following is a summary of changes in this pull request made by me, your security buddy 🤖. Note that this summary is auto-generated and not meant to be a definitive list of security issues but rather a helpful summary from a security perspective.

Summary:

The code changes in this pull request are focused on improving the security and reliability of the DefectDojo application's deployment using Helm. The key changes include the addition of a database migration checker, the use of Kubernetes Secrets to store sensitive information, and the implementation of security-related configurations such as session and CSRF cookie security, security contexts, and resource limits.

The database migration checker is a particularly noteworthy addition, as it helps ensure that the application's database is in a valid state before the main containers start. This can prevent issues related to database schema changes or migrations, which is an important security consideration.

Additionally, the use of Kubernetes Secrets to store sensitive information, such as database passwords and the application's secret key, follows security best practices and helps prevent the accidental exposure of sensitive data. The code also sets appropriate security-related configurations, such as session and CSRF cookie security, which can help mitigate common web application vulnerabilities.

Overall, the changes in this pull request appear to be focused on improving the security and reliability of the DefectDojo application's deployment, which is a positive step from an application security perspective.

Files Changed:

1. helm/defectdojo/templates/_helpers.tpl:

   • Added a new template called "dbMigrationChecker" to define a container that periodically checks if the database has been migrated to the latest state.
   • The container retrieves the database password from a secret and sets the DD_DEBUG environment variable based on the django.uwsgi.enable_debug configuration.
   • The container can be configured with a security context and resource limits.

2. helm/defectdojo/templates/celery-beat-deployment.yaml:

   • Included an optional dbMigrationChecker initContainer to check the database migration status before the main Celery Beat container starts.
   • Securely retrieved sensitive information, such as the Celery broker password, database password, and secret key, from Kubernetes secrets.
   • Specified a security context for the Celery Beat container, including running the container as a non-root user.

3. helm/defectdojo/templates/celery-worker-deployment.yaml:

   • Introduced a database migration checker initContainer to ensure the database is in a valid state before the main containers start.
   • Included a cloudsql-proxy container to securely connect to a Cloud SQL database.
   • Updated the environment variables to use Kubernetes secrets for sensitive values, such as the Celery broker and database passwords.
   • Added annotations to the pod template to trigger pod restarts when the application's configuration changes.

4. helm/defectdojo/templates/django-deployment.yaml:

   • Added an initContainer to perform database migration checks before the main containers start.
   • Used Kubernetes Secrets to store sensitive environment variables, such as the database password, Celery broker password, and the application's secret key.
   • Set the DD_SESSION_COOKIE_SECURE and DD_CSRF_COOKIE_SECURE environment variables to "True" if TLS is enabled.
   • Included liveness and readiness probes for the Django and Nginx containers.
   • Set security context configurations for the Django and Nginx containers, including running the containers as a non-root user.

5. helm/defectdojo/values.yaml:

   • Reduced the initial delay for the liveness probe from 120 seconds to 3 seconds.
   • Enabled the database migration checker feature.
   • Allowed for the mounting of additional volumes, such as configuration files or certificates.
   • Provided sections for adding extra environment variables and secrets.

Powered by DryRun Security

[fcecagno]

I believe you forgot to add the startupProbe to the deployment. I was expecting to see the startupProbe just after https://github.com/DefectDojo/django-DefectDojo/blob/dev/helm/defectdojo/templates/django-deployment.yaml#L210-L223, along with default values for it.
As far as I understand, this PR tries to solve two different issues that are unrelated: probes and migration. I'd suggest to split it into two different PRs, this one looks good for migration, I'd just revert https://github.com/DefectDojo/django-DefectDojo/pull/10454/files#diff-62fee928ffe25d7f0d884b137db6f0ad7ffd1fb15d4fb217b922e3ef201f2e37L223-R223 and leave the whole probes modification to a new PR.

[mtesauro]

Approved

[kiblik]

I believe you forgot to add the startupProbe to the deployment. I was expecting to see the startupProbe just after https://github.com/DefectDojo/django-DefectDojo/blob/dev/helm/defectdojo/templates/django-deployment.yaml#L210-L223, along with default values for it. As far as I understand, this PR tries to solve two different issues that are unrelated: probes and migration. I'd suggest to split it into two different PRs, this one looks good for migration, I'd just revert https://github.com/DefectDojo/django-DefectDojo/pull/10454/files#diff-62fee928ffe25d7f0d884b137db6f0ad7ffd1fb15d4fb217b922e3ef201f2e37L223-R223 and leave the whole probes modification to a new PR.

@fcecagno, thank you for your feedback.
TBH, originally, I planned to use startupProbe. However, during testing, I found out it is not the best approach in my opinion.
Based on my experience, until now, probes have been failing because the application has not been ready (mandatory migrations have not been finished).
The previous implementation was trying to "solve" it with 2 minutes long initial period. However, this is not the best (check the reasoning in the description of this PR)
Using startupProbe would be usable however it would be necessary to add it to both containers. I wanted to avoid starting redundant probes and using initContainer has the same outcome = liveness and readiness probes are not started until initContainers are not Completed.
But please tell me if you see it otherwise. Or if you have a different experience.

[fcecagno]

Hi @kiblik , thanks for your reply. IMO this PR improves the current state.

[mtesauro]

@kiblik Got a new/different opinion of this one? Wanted to double check since we're getting close to 4 approvals.

[kiblik]

@kiblik Got a new/different opinion of this one? Wanted to double check since we're getting close to 4 approvals.

I still see it as useful. I saw also @fcecagno's proposal #10506 and I believe that both of them are beneficial, they can coexist and help to improve smoother deployments.

[cneill]

I'd put this either at the top of values.yaml (somewhere near podLabels) or at the bottom (somewhere near extraConfigs). It's likely to be missed where it is right now sandwiched between the blocks configuring individual services.

[kiblik]

Sorry, I missed your comment. I hope it is on better position now.

[dryrunsecurity]

DryRun Security Summary

The pull request focuses on improving the security and reliability of the DefectDojo application deployment, particularly in the areas of database management, cloud-based database integration, and Celery worker deployment, through changes such as database migration checking, Cloud SQL Proxy configuration, secure storage of sensitive information, and the setting of appropriate security contexts and probes.

Expand for full summary

Summary:

The code changes in this pull request are focused on improving the security and reliability of the DefectDojo application deployment, particularly in the areas of database management, cloud-based database integration, and Celery worker deployment.

The key security-related changes include:

1. Database Migration Checking: The introduction of a "dbMigrationChecker" initContainer to ensure the database is properly migrated before the application starts.
2. Cloud SQL Proxy: The configuration of the Cloud SQL Proxy to securely connect the application to a Cloud SQL database instance.
3. Secure Storage of Sensitive Information: The use of Kubernetes Secrets to store sensitive information like passwords and the Django secret key.
4. Security Context and Probes: The setting of appropriate security contexts and the inclusion of liveness and readiness probes to ensure the containers are running securely and responding correctly.

Overall, these changes demonstrate a focus on implementing best practices for securing the application's deployment, which is a positive step from an application security perspective. However, it's important to review the entire application stack and configuration to ensure there are no other potential security issues.

Files Changed:

1. helm/defectdojo/templates/celery-beat-deployment.yaml:

   • Adds an optional dbMigrationChecker initContainer to check the database migration status before starting Celery Beat.
   • Includes the configuration for the Cloud SQL Proxy container.
   • Sets various environment variables, including the Celery broker password and the Django secret key.

2. helm/defectdojo/templates/_helpers.tpl:

   • Introduces a new "dbMigrationChecker" Helm template to define a container that checks the database migration status.
   • The container runs with the same image as the main Django application, which could introduce security risks if not properly secured.

3. helm/defectdojo/templates/django-deployment.yaml:

   • Retrieves database credentials from Kubernetes secrets.
   • Sets security-related environment variables for session and CSRF cookie security.
   • Includes liveness and readiness probes and sets appropriate security contexts for the containers.

4. helm/defectdojo/templates/celery-worker-deployment.yaml:

   • Introduces the dbMigrationChecker initContainer to ensure the database is properly migrated before the Celery worker starts.
   • Configures the Cloud SQL Proxy container for secure database connectivity.
   • Sets environment variables for sensitive information, such as the Celery broker password and the Django secret key.

5. helm/defectdojo/values.yaml:

   • Enables the dbMigrationChecker feature.
   • Reduces the initialDelaySeconds for the Django UWSGI container's liveness probe, which can help detect issues sooner.

Code Analysis

We ran 9 analyzers against 5 files and 0 analyzers had findings. 9 analyzers had no findings.

Riskiness

🟢 Risk threshold not exceeded.

View PR in the DryRun Dashboard.