Skip to main content

Overview

What is a source?​

In the context of Overmind, a source is a configuration entity that defines how Overmind accesses and interacts with your cloud infrastructure. Sources are essential for Overmind to discover, map, and analyse the resources and dependencies in your environment.

Purpose of a Source​

A source instructs Overmind on how to connect to and retrieve information about your infrastructure resources. This includes specifying the cloud provider, credentials, and any relevant configuration details needed to perform analysis and risk assessments.

Types of Sources​

Overmind supports multiple types of sources, each corresponding to different cloud environments or infrastructure setups. Common types of sources include:

  • AWS Source: Used to configure and access resources in Amazon Web Services (AWS).
  • Kubernetes Source: Configured to access Kubernetes clusters and their associated resources.
  • Stdlib Source: Overmind has a source called stdlib which allows you to run query's on public information without entering any source credentials.
  • Custom Sources: User-defined sources for other environments or specific configurations.

Components of a Source​

A source configuration typically includes the following components:

  • Cloud Provider Information: Specifies the type of cloud environment (e.g., AWS, Kubernetes).
  • Credentials: Securely stored credentials that Overmind uses to authenticate and access your cloud environment.
  • Connection Details: Endpoint URLs, regions, or any other necessary connection details required to access the resources.
  • Access Permissions: Permissions defining the level of access Overmind has to your cloud resources. These are read-only to ensure security and privacy.

Setting Up a Source​

Setting up a source involves providing Overmind with the necessary configuration details. Here are the general steps:

  1. Select Cloud Provider: Choose the appropriate cloud provider for the source you want to configure.
  2. Provide Credentials: Supply the credentials required for Overmind to access the resources. This may involve setting up API keys, roles, or other authentication mechanisms.
  3. Configure Access: Define the scope of access Overmind will have, often limited to read-only for security purposes. Specify any additional configuration details such as regions or specific endpoints.
  4. Verification: Overmind verifies the provided configuration by attempting to connect and retrieve information from the specified source. If verification is successful, the source is added to your Overmind configuration.

Managing Sources​

Once configured, sources can be managed through the Overmind console or CLI:

  • Add New Sources: Additional sources can be configured to expand the scope of infrastructure resources Overmind monitors.
  • Update Existing Sources: Modify credentials, permissions, or other configuration details as needed to ensure continued access and accurate analysis.
  • Remove Sources: Decommission sources that are no longer needed or relevant to reduce unnecessary monitoring and potential security risks.

Utilization of Sources​

Overmind utilizes sources to perform various functions:

  • Discovery: Continuously discover and map resources and dependencies in the specified cloud environment.
  • Impact Analysis: Evaluate the potential impact of proposed infrastructure changes, leveraging the comprehensive data collected from the source.
  • Risk Assessment: Identify and analyze potential risks associated with changes, providing real-time feedback based on up-to-date information from the source.
  • Visualization: Provide a detailed visualization of the infrastructure, including dependencies and configuration details, based on the data retrieved from the source.

Security and Privacy​

Overmind prioritizes security and privacy when configuring sources:

  • Read-Only Access: Sources are typically configured with read-only access to ensure that Overmind can monitor and analyze without making changes to your infrastructure.
  • Credential Management: Credentials provided for sources are securely stored and managed to prevent unauthorized access.
  • Compliance: Overmind ensures that the configuration and use of sources comply with security and privacy standards.