As a DevSecOps, I would like to integrate DevOps tools for "Nachet", "Finesse" and "Fertiscan" applications

[ThomasCardin]

Executive Summary

In an effort to enhance deployment processes and monitoring capabilities for the "Nachet" and "Finesse" applications, there is a need to establish a comprehensive set of DevOps tools. This includes the creation of docker-compose files, Helm charts, Grafana dashboards, and application telemetry. These integrations aim to streamline deployments, improve observability, and enable efficient scaling and management of application environments.

Context

The "Nachet" and "Finesse" applications currently lack deployment and observability tools, which makes it challenging to manage their lifecycle and monitor their performance efficiently. The creation of docker-compose and Helm charts will standardize deployment procedures across different environments, ensuring consistency and reliability. Grafana dashboards will provide real-time visualization of metrics, facilitating proactive management. Moreover, integrating telemetry will enhance troubleshooting capabilities and allow for performance optimization based on empirical data.

TODO

Nachet assigned to: @SonOfLope Finesse assigned to: @SonOfLope Fertiscan: @ThomasCardin

• [ ] Develop docker-compose files:

  • Create separate docker-compose configurations for both the frontend and backend components of each application.
  • A docker-compose should include the following:
    • The application backend
    • The application frontend
    • Grafana
    • Loki
    • Prometheus
    • Alloy
    • Tempo
    • Ingress NGINX
  • Ensure that all necessary services and their dependencies are correctly defined and integrated.
    • [x] #248
    • [x] #268
    • [x] #274
    • [x] #275
    • [ ] #271
    • [ ] #272

• [ ] Create Helm charts:

  • Develop Helm charts for each application to facilitate their deployment into Kubernetes clusters.
    • [ ] Fertiscan helm chart
    • [ ] Nachet helm chart
    • [ ] Finesse helm chart
  • Include necessary templates for deployments, services, and ingress rules.
  • Test Helm chart deployments in a controlled staging environment.

• [ ] Design Grafana dashboards:

  • Define key performance indicators (KPIs) for each application to monitor.
  • Create Grafana dashboards that visualize these KPIs in an intuitive and actionable manner.
  • Ensure dashboards are configurable to cater to different environments and use cases.
    • [ ] Fertiscan dashboard
    • [ ] Nachet dashboard
    • [ ] Finesse dashboard

• [ ] Implement application telemetry (OTEL):

  • Integrate telemetry tools suitable for each application to collect metrics, logs, and traces.
    • [ ] Finesse telemetry
    • [ ] Nachet telemetry
    • [ ] #269
  • Configure the collection agents to ensure comprehensive data gathering without significant performance overhead.
  • Establish a pipeline for telemetry data to be consumed by monitoring tools and dashboards.

• [ ] Documentation and knowledge sharing:

  • Document the entire setup process, including docker-compose files, Helm charts, Grafana dashboard configurations, and telemetry integration.
    • [ ] #270
    • [ ] Finesse DevOps tool documentation
    • [ ] Nachet DevOps tool documentation
  • Organize training sessions for development and operations teams to familiarize them with the new tools and practices.

• [ ] Testing and validation:

  • Conduct thorough testing to ensure that all components work together seamlessly.
    • [ ] Conduct tests on fertiscan docker-compose and helm chart
    • [ ] Conduct tests on nachet docker-compose and helm chart
    • [ ] Conduct tests on finesse docker-compose and helm chart
  • Validate that the docker-compose and Helm chart setups are robust and performant under different scenarios.
  • Review Grafana dashboard efficacy in real-time monitoring and ensure telemetry data aids in meaningful insights.