Skip to main content

ECS Service Discovery

Project description

https://img.shields.io/pypi/v/ecs_service_discovery.svg

Yet another tool to perform ECS API based service discovery. Primarily aimed at gapping the lack of integrations for ECS Anywhere.

Features

  • Creates Prometheus scraping configuration, from scanning ECS clusters & services, based on docker labels

Installation

Docker

Head to Public ECR to obtain the image

docker run --rm -it -v ~/.aws:/root/.aws public.ecr.aws/compose-x/ecs-service-discovery

Python

For your user only

pip install pip --user ecs-service-discovery

Via virtual environment

pip install ecs-service-discovery

Usage

usage: ecs-sd [-h] [-d OUTPUT_DIR] [--profile PROFILE] [-p PROMETHEUS_PORT] [--intervals INTERVALS] [--prometheus-output-format PROMETHEUS_OUTPUT_FORMAT] [_ ...]

positional arguments:
  _

options:
  -h, --help            show this help message and exit
  -d OUTPUT_DIR, --output_dir OUTPUT_DIR
  --profile PROFILE     aws profile to use. Defaults to SDK default behaviour
  -p PROMETHEUS_PORT, --prometheus-port PROMETHEUS_PORT
  --intervals INTERVALS
                        Time between ECS discovery intervals
  --prometheus-output-format PROMETHEUS_OUTPUT_FORMAT
                        Change the format of generated files. JSON or YAML.

Examples

ECS Compose-X

Install ecs-compose-x & deploy to AWS

Docker Compose

After cloning the repository, run docker compose up. It will spin the service discovery, along with prometheus & grafana to run the demo with. You can access prometheus via localhost:9090 and grafana via localhost:3000 (admin:admin by default).

In prometheus, you can look at the configuration and service discovery. You should see the discovered targets that prometheus is going to try to scrape.

AWS Policy requirements

PolicyName: ECSServiceDiscoverySimple
PolicyDocument:
  Version: "2012-10-17"
  Statement:
    - Effect: Allow
      Action:
        - ecs:ListClusters
        - ecs:ListContainerInstances
        - ecs:ListTasks
        - ecs:DescribeContainerInstances
        - ssm:DescribeInstanceInformation
        - ecs:DescribeTasks
        - ecs:DescribeTaskDefinition
      Resource: '*'

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ecs_service_discovery-0.1.4.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

ecs_service_discovery-0.1.4-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file ecs_service_discovery-0.1.4.tar.gz.

File metadata

  • Download URL: ecs_service_discovery-0.1.4.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.12.3 Linux/6.8.10-200.fc39.x86_64

File hashes

Hashes for ecs_service_discovery-0.1.4.tar.gz
Algorithm Hash digest
SHA256 f0c36665dc52d6af254cd280e395780249b5cf13734c5e8fc96380ef54d4daa0
MD5 1a5ca2b80091bb4cbf9cf733ca2700e2
BLAKE2b-256 0956134cf3db71544ff7bd446ce6a3ffe74760bd6c11a0b00cb069605be03aa4

See more details on using hashes here.

File details

Details for the file ecs_service_discovery-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for ecs_service_discovery-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 af2fd10bab5dfd5708fbffa1f76a09e900b26d49cb68bdce8b214b963a6060be
MD5 22541f6ebbbe36359861326c66da26fa
BLAKE2b-256 0f285b702a6cff11d25be4e02514d257ee4ba75e622014128df673dae3585399

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page