Skip to content

Commit

Permalink
reworked based on feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
John Dewey committed Nov 6, 2024
1 parent 121af3b commit a414b46
Show file tree
Hide file tree
Showing 26 changed files with 55 additions and 129 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
role-duration-seconds: 1200
- name: Push Files
run: |
aws s3 cp cloud-native-iac/sensor/aws/*.yaml s3://${{ env.S3_BUCKET }}
aws s3 cp cloudformation/*.yaml s3://${{ env.S3_BUCKET }}
permissions:
id-token: write
contents: read
2 changes: 1 addition & 1 deletion .github/workflows/prod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
role-duration-seconds: 1200
- name: Push Files
run: |
aws s3 cp cloud-native-iac/sensor/aws/*.yaml s3://${{ env.S3_BUCKET }}
aws s3 cp cloudformation/*.yaml s3://${{ env.S3_BUCKET }}
permissions:
id-token: write
contents: read
28 changes: 15 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,28 @@

This repository provides sample configurations for deploying Corelight products
across AWS, Azure, and Google Cloud Platform (GCP). The examples offer both
**Terraform-based** and **cloud-native IaC solutions**, allowing users to
choose based on their preferences and platform requirements.
**Terraform-based** and **native IaC solutions**, allowing users to choose
the approach that best fits their platform requirements and preferences.

## Directory Structure
## Directory Structure Overview

### `terraform/`
### `cloudformation/`

Contains **Terraform** modules for deploying Corelight products with consistent
configurations across multiple clouds.
This directory includes **AWS CloudFormation templates** for deploying Corelight
solutions within AWS environments using native AWS IaC. Each template provides
configurations tailored for Corelight.

- **`aws/`**: Terraform modules for AWS deployments.
- **`azure/`**: Terraform modules for Azure deployments.
- **`gcp/`**: Terraform modules for GCP deployments.
### `terraform/`

### `cloud-native-iac/`
The `terraform/` directory contains **Terraform modules** structured by cloud
provider. Each subdirectory under `terraform/` is organized by provider and
service, with individual `README.md` files for specific guidance on deploying
Corelight products within that cloud.

Includes cloud provider-native infrastructure-as-code (IaC) templates for deeper
integration with specific cloud services.
#### Integrations

- **`aws/`**: CloudFormation templates for AWS deployments.
Within `terraform/integrations/`, you’ll find subdirectories for integrating
Corelight products with partner solutions.

## License

Expand Down
21 changes: 0 additions & 21 deletions cloud-native-iac/README.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
# Corelight Sensor Deployment - AWS
# Corelight CloudFormation Templates

This directory provides Cloud Formation code for deploying Corelight's Sensor
on **AWS**.
This directory contains AWS CloudFormation templates for deploying Corelight
solutions within AWS environments.

## Templates

- **`autoscaling-sensor.yaml`**: Sets up an Auto Scaling group for Corelight Sensors,
enabling automatic scaling based on demand.

## Usage

Expand Down Expand Up @@ -43,5 +48,3 @@ aws cloudformation update-stack --region <AWS_REGION> \
ParameterKey=KeyPairName,ParameterValue=<SENSOR_KEY_PAIR_NAME> \
--template-body file://cfn.yaml
```

[awscli]: https://aws.amazon.com/cli/
File renamed without changes.
55 changes: 19 additions & 36 deletions terraform/README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,26 @@
# Terraform

This directory contains **Terraform** modules used to deploy Corelight products
This directory contains **Terraform** modules used to deploy Corelight solutions
across multiple cloud providers.

## Corelight Sensor

Terraform modules for deploying Corelight Sensors in the following cloud
environments:

- **AWS**

- [Terraform Module](./sensor/aws/README.md)

- **Azure**

- [Terraform Module](./sensor/azure/README.md)

- **GCP**

- [Terraform Module](./sensor/gcp/README.md)

## Cloud Enrichment Service

Modules for deploying Corelight's Cloud Enrichment services, enabling data
enrichment across cloud ecosystems:

- **AWS**

- [Terraform Module](./cloud-enrichment/aws/README.md)

- **Azure**

- [Terraform Module](./cloud-enrichment/azure/README.md)

- **GCP**

- [Terraform Module](./cloud-enrichment/gcp/README.md)
#### Subdirectories

- **`aws-autoscaling-sensor/`**: Contains Terraform files for deploying an
autoscaling sensor within AWS, including `main.tf` and `versions.tf` files for configuration.
- **`aws-cloud-enrichment/`**: A Terraform module for setting up cloud enrichment
services on AWS.
- **`azure-cloud-enrichment/`**: Module to configure cloud enrichment capabilities
on Azure.
- **`azure-scaleset-sensor/`**: Azure Terraform configuration to deploy Corelight
sensors on a Virtual Machine Scale Set.
- **`gcp-mig-sensor/`**: A Terraform module for deploying a sensor with GCP’s
Managed Instance Groups (MIG).
- **`gcp-cloud-enrichment/`**: GCP-specific Terraform module for configuring cloud
enrichment services.
- **`integrations/`**: Subdirectories for integrating Corelight products with
partner solutions.

## How to Use

Navigate into the appropriate cloud provider's directory and follow the
instructions provided in the `README.md` for each module.
Navigate into the appropriate directory and follow the instructions provided in
the `README.md` for each module.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,3 @@ This deployment uses the [terraform-aws-sensor][] module, which simplifies the
setup of Corelight Sensors by automating the provisioning of AWS resources.

[terraform-aws-sensor]: https://github.com/corelight/terraform-aws-sensor/

## Examples Directory

The `examples/` directory demonstrates how to use the Terraform module with
various configurations. These examples showcase best practices and common
deployment scenarios.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,3 @@ This deployment uses the [terraform-aws-enrichment][] module, which simplifies t
setup of Corelight Cloud Enrichment by automating the provisioning of AWS resources.

[terraform-aws-enrichment]: https://github.com/corelight/terraform-aws-enrichment/

## Examples Directory

The `examples/` directory demonstrates how to use the Terraform module with
various configurations. These examples showcase best practices and common
deployment scenarios.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,3 @@ This deployment uses the [terraform-azure-enrichment][] module, which simplifies
setup of Corelight Cloud Enrichment by automating the provisioning of Azure resources.

[terraform-azure-enrichment]: https://github.com/corelight/terraform-azure-enrichment/

## Examples Directory

The `examples/` directory demonstrates how to use the Terraform module with
various configurations. These examples showcase best practices and common
deployment scenarios.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,3 @@ This deployment uses the [terraform-azure-sensor][] module, which simplifies the
setup of Corelight Sensors by automating the provisioning of AWS resources.

[terraform-azure-sensor]: https://github.com/corelight/terraform-azure-sensor/

## Examples Directory

The `examples/` directory demonstrates how to use the Terraform module with
various configurations. These examples showcase best practices and common
deployment scenarios.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,3 @@ This deployment uses the [terraform-gcp-enrichment][] module, which simplifies t
setup of Corelight Cloud Enrichment by automating the provisioning of GCP resources.

[terraform-gcp-enrichment]: https://github.com/corelight/terraform-gcp-enrichment/

## Examples Directory

The `examples/` directory demonstrates how to use the Terraform module with
various configurations. These examples showcase best practices and common
deployment scenarios.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,3 @@ This deployment uses the [terraform-gcp-sensor][] module, which simplifies the
setup of Corelight Sensors by automating the provisioning of AWS resources.

[terraform-gcp-sensor]: https://github.com/corelight/terraform-gcp-sensor/

## Examples Directory

The `examples/` directory demonstrates how to use the Terraform module with
various configurations. These examples showcase best practices and common
deployment scenarios.
File renamed without changes.
File renamed without changes.
11 changes: 11 additions & 0 deletions terraform/integrations/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Integrations

This directory contains Terraform modules designed to integrate Corelight
solutions with third-party platforms.

## Available Integrations

## How to Use

Navigate into the appropriate directory and follow the instructions provided in
the `README.md` for each module.
16 changes: 0 additions & 16 deletions terraform/sensor/azure/examples/deployment/versions.tf

This file was deleted.

0 comments on commit a414b46

Please sign in to comment.