Skip to content

Developer Guide

This guide provides comprehensive information for developers working with the Kube CINC Secure Scanner platform.

Overview

The developer guide is designed to help you understand, test, deploy, and contribute to the Kube CINC Secure Scanner project. Whether you're setting up a development environment, implementing tests, or preparing for production deployment, this guide provides the necessary information.

Key Areas

The developer guide covers several critical areas:

Testing

The Testing Guide provides information on:

  • Setting up test environments
  • Running automated tests
  • Creating new test cases
  • Testing with different Kubernetes configurations

Deployment

The Deployment Guide covers:

  • Preparing for production deployment
  • Sizing considerations
  • High availability configurations
  • Performance tuning
  • Production security considerations

Development Workflow

The typical development workflow for this project includes:

  1. Environment Setup
  2. Clone the repository
  3. Install dependencies

  4. Set up test environment (typically using Minikube)

  5. Development

  6. Make code changes
  7. Implement tests

  8. Document your changes

  9. Testing

  10. Run unit tests
  11. Run integration tests

  12. Perform security validation

  13. Deployment

  14. Package for deployment
  15. Deploy to target environment
  16. Monitor for issues

Contributing

For details on how to contribute to the project, please see the Contributing Guide.