Metadata-Version: 2.1
Name: opsbox-elb-checks
Version: 0.1.2
Summary: Collection of ELB checks for opsbox
Requires-Python: ==3.11.*
Description-Content-Type: text/markdown
License-File: LICENCE.txt
Requires-Dist: opsbox-elb-provider>=0.1.2
Requires-Dist: opsbox-rego-handler>=0.1.2

# OpsBox Rego Checks for AWS ELB

This package contains various Rego check plugins related to AWS's Elastic Load Balancing (ELB) service, including:

- **Low Request Count Load Balancers (`low_request_counts`)**
- **High Error Rate Load Balancers (`high_error_rate`)**
- **Inactive Load Balancers (`inactive_load_balancers`)**

---

## Plugin Descriptions

### Low Request Count Load Balancers (`low_request_counts`)
Identifies load balancers with low request counts, providing performance insights and opportunities to optimize or decommission underutilized resources.

### High Error Rate Load Balancers (`high_error_rate`)
Detects load balancers with high error rates, helping identify and address performance issues or misconfigurations to improve application reliability.

### Inactive Load Balancers (`inactive_load_balancers`)
Finds load balancers that are inactive, offering recommendations to decommission these resources to reduce unnecessary costs.

## Common Configuration

All plugins share the following AWS configuration:

- **aws_access_key_id**: AWS access key ID
- **aws_secret_access_key**: AWS secret access key
- **aws_region**: AWS region (optional)

```yaml
aws_access_key_id: your_access_key_id
aws_secret_access_key: your_secret_access_key
aws_region: your_aws_region
```

---

To access more info about each check, install `mkdocs` and run `mkdocs serve` at the root of the package directory.

This will pull up a webpage with more complete documentation.
