Skip to content

global-configuration.md

Latest commit

 

History

History
131 lines (108 loc) · 3.46 KB

global-configuration.md

File metadata and controls

131 lines (108 loc) · 3.46 KB
Raw

Global Configuration

The main configuration file is located at ./config/default.json. This file defines all aspects of your Kexa setup.

Basic Configuration

Here's a basic example of a configuration file:

{
  "azure": [
    {
      "name": "MyAzureSubscription",
      "description": "Production subscription",
      "rules": [
        "security-rules",
        "cost-rules"
      ]
    }
  ],
  "aws": [
    {
      "name": "MyAWSAccount",
      "description": "Development account",
      "rules": [
        "security-rules"
      ],
      "regions": [
        "us-east-1",
        "us-west-2"
      ]
    }
  ]
}

Configuration Options

Provider Configuration

Each provider section can contain multiple projects/environments. For each project, you can specify:

  • name: A unique identifier for the project
  • description: A description of the project
  • rules: List of rule files to apply
  • regions: (Optional) Specific regions to scan (available for GCP & AWS)
  • prefix: (Optional) Prefix for environment variables

Multiple Environments

You can define multiple projects for each provider:

{
  "azure": [
    {
      "name": "Project A",
      "prefix": "PROJECTA_",
      "description": "First subscription",
      "rules": ["security-rules"]
    },
    {
      "name": "Project B",
      "prefix": "PROJECTB_",
      "description": "Second subscription",
      "rules": ["security-rules", "cost-rules"]
    }
  ]
}

Advanced Settings

You can add a general section for advanced settings, for example here we are adding the continuous run mode for Kexa.

{
  "general": {
    "timeout": 1,         // timeout in minutes
    "maxRetry": 2,        // number of retries
    "checkInterval": 120, // interval between checks in seconds
    "alertInterval": 3600 // interval between alerts in seconds
  }
}

You can also add save and/or export modules in this configuration file, save will save all scans results and ressources, while export is made to only export your cloud ressources states.

    "save": [
        {
            "type": "postgre",
            "name": "DB2",
            "description": "Database to save the data in subscription EFQD",
            "urlName": "uri to connect to the database or the name of the var environment where the uri is stored: the format of the uri is : postgres://user:password@host:port/database"
        }
    ],
    "export": [
        {
            "type": "postgre",
            "name": "DB2",
            "description": "Database to save the data in subscription EFQD",
            "urlName": "uri to connect to the database or the name of the var environment where the uri is stored: the format of the uri is : postgres://user:password@host:port/database"
        }
    ]

To know more about save & export fields, refer to Saving Data Documentation:

To know more about save & export possibility, refer to associated documentations:

Custom Configuration Files

You can use multiple configuration files by:

  1. Creating a /config/env/ directory

  2. Adding your configuration files with custom names

  3. Setting the environment variable:

    NODE_CONFIG_TS_ENV=customName

To know more about this check Multiple Environments Documentation