Skip to main content

Source

Source is the place where terediX will discover the data. You can add multiple sources in the configuration file. Every source will build a scanner based on the source kind and configuration.

Common source configuration

optiontypedescription
source_nametextKey/name of each source. e.g: github_repositories, aws_resources_rds, aws_s3_one
[source_name].typetextType of the source. See the full list of supported source types
[source_name].configurationkey value pairConfiguration of the source. This configuration is different for different type of source
[source_name].fieldslistAdditional data to store with each resource
[source_name].scheduleintervalSet interval to schedule this source. e.g: @every 10s, @every <br/>24h or any valid cron expression */10 * * * * *

Supported Source Types

source typedescription
aws_s3Discover data from AWS S3. You can use this source to discover data from AWS S3. See configuration for aws_s3 source type.
aws_ec2Discover data from AWS EC2. You can use this source to discover data from AWS EC2. See the configuration for aws_ec2 source type.
aws_rdsDiscover data from AWS RDS. You can use this source to discover data from AWS RDS. See the configuration for aws_rds source type.
aws_ecrDiscover data from AWS ECR. You can use this source to discover data from AWS ECR repository. See the configuration for aws_ecr source type.
file_systemDiscover data from local file system. You can use this source to discover data from local file system. See the configuration for file_system source type.
github_repositoryList of GitHub repositories. See the configuration for github_repository source type

Schedule Format

You can set the schedule for each source. The schedule format is similar to the cron expression.

Valid schedule formats are:

  • @every 10s
  • @every 1m
  • @every 1h
  • @every 1d
  • @every 1w
  • */10 * * * * * # cron expression that will run in every 10 seconds