Rules engine for cloud security, cost optimization, and governance, DSL in yaml for policies to query, filter, and take actions on resources
Permalink
Failed to load latest commit information.
.vscode c7n_azure - filters running against azure resources (#2172) Mar 28, 2018
c7n aws.apigw - rest-stage tag augment (#3133) Nov 15, 2018
docs azure - resize app service plan action and refactor off hours (#3130) Nov 13, 2018
tests aws.apigw - rest-stage tag augment (#3133) Nov 15, 2018
tools outputs - always log to blob storage irrespective of -l usage (#3136) Nov 14, 2018
.coveragerc vendor ipaddress.py to address py2/py3 mismatches (py3 cli->py2 run) (#… Dec 21, 2017
.dockerignore tools/ops/policystream - org-stream subcommand, change to py package,… Oct 25, 2018
.drone.yml ci - switch out to python:2.7 for drone ci build and doc build (#2238) Apr 16, 2018
.gitignore azure - enable xplat azure functions (#3084) Nov 12, 2018
.travis.yml core - python 3.7 support and 3.7 now in ci runs (#2608) Jul 8, 2018
Dockerfile ci - docker python image switch and lower default log level on urllib3 ( Sep 4, 2018
LICENSE.txt update copyright in license addendum example (#1541) Sep 6, 2017
Makefile core - refactor outputs add policy api/processs stats and tracing (#2844 Oct 4, 2018
README.rst tools/ops/policystream - org-stream subcommand, change to py package,… Oct 25, 2018
requirements-dev.txt tools/c7n_org - dockerfile, disambiguate cache and output path, captu… Oct 31, 2018
requirements.txt gcp serverless foundation (#2542) Jul 2, 2018
setup.py 0.8.32.0 - release & version increments (#3124) Nov 14, 2018
tox.ini azure - enable xplat azure functions (#3084) Nov 12, 2018

README.rst

Join the chat at https://gitter.im/capitalone/cloud-custodian Build Status License Coverage Requirements Status

Cloud Custodian

Cloud Custodian is a rules engine for managing public cloud accounts and resources. It allows users to define policies to enable a well managed cloud infrastructure, that's both secure and cost optimized. It consolidates many of the adhoc scripts organizations have into a lightweight and flexible tool, with unified metrics and reporting.

Custodian can be used to manage AWS, Azure, and GCP environments by ensuring real time compliance to security policies (like encryption and access requirements), tag policies, and cost management via garbage collection of unused resources and off-hours resource management.

Custodian policies are written in simple YAML configuration files that enable users to specify policies on a resource type (EC2, ASG, Redshift, CosmosDB, PubSub Topic) and are constructed from a vocabulary of filters and actions.

It integrates with the cloud native serverless capabilities of each provider to provide for real time enforcement of policies with builtin provisioning. Or it can be run as a simple cron job on a server to execute against large existing fleets.

Engineering the Next Generation of Cloud Governance” by @drewfirment

Features

  • Comprehensive support for public cloud services and resources with a rich library of actions and filters to build policies with.
  • Supports arbitrary filtering on resources with nested boolean conditions.
  • Dry run any policy to see what it would do.
  • Automatically provisions serverless functions and event sources ( AWS CloudWatchEvents, AWS Config Rules, Azure EventGrid, GCP AuditLog & Pub/Sub, etc)
  • Cloud provider native metrics outputs on resources that matched a policy
  • Structured outputs into cloud native object storage of which resources matched a policy.
  • Intelligent cache usage to minimize api calls.
  • Supports multi-account/subscription/project usage.
  • Battle-tested - in production on some very large cloud environments.

Links

Quick Install

$ virtualenv --python=python2 custodian
$ source custodian/bin/activate
(custodian) $ pip install c7n

Usage

First a policy file needs to be created in YAML format, as an example:

policies:
- name: remediate-extant-keys
  description: |
    Scan through all s3 buckets in an account and ensure all objects
    are encrypted (default to AES256).
  resource: aws.s3
  actions:
    - encrypt-keys

- name: ec2-require-non-public-and-encrypted-volumes
  resource: ec2
  description: |
    Provision a lambda and cloud watch event target
    that looks at all new instances and terminates those with
    unencrypted volumes.
  mode:
    type: cloudtrail
    events:
        - RunInstances
  filters:
    - type: aws.ebs
      key: Encrypted
      value: false
  actions:
    - terminate

- name: tag-compliance
  resource: ec2
  description: |
    Schedule a resource that does not meet tag compliance policies
    to be stopped in four days.
  filters:
    - State.Name: running
    - "tag:Environment": absent
    - "tag:AppId": absent
    - or:
      - "tag:OwnerContact": absent
      - "tag:DeptID": absent
  actions:
    - type: mark-for-op
      op: stop
      days: 4

Given that, you can run Cloud Custodian with:

# Validate the configuration (note this happens by default on run)
$ custodian validate policy.yml

# Dryrun on the policies (no actions executed) to see what resources
# match each policy.
$ custodian run --dryrun -s out policy.yml

# Run the policy
$ custodian run -s out policy.yml

Custodian supports a few other useful subcommands and options, including outputs to S3, Cloudwatch metrics, STS role assumption. Policies go together like Lego bricks with actions and filters.

Consult the documentation for additional information, or reach out on gitter.

Get Involved

Mailing List - https://groups.google.com/forum/#!forum/cloud-custodian

Gitter - https://gitter.im/capitalone/cloud-custodian

Additional Tools

The Custodian project also develops and maintains a suite of additional tools here https://github.com/capitalone/cloud-custodian/tree/master/tools:

Org
Multi-account policy execution.
PolicyStream
Git history as stream of logical policy changes.
Salactus
Scale out s3 scanning.
Mailer
A reference implementation of sending messages to users to notify them.
TrailDB
Cloudtrail indexing and timeseries generation for dashboarding.
LogExporter
Cloud watch log exporting to s3
Index
Indexing of custodian metrics and outputs for dashboarding
Sentry
Cloudwatch Log parsing for python tracebacks to integrate with https://sentry.io/welcome/

Contributors

We welcome Your interest in Capital One’s Open Source Projects (the “Project”). Any Contributor to the Project must accept and sign an Agreement indicating agreement to the license terms below. Except for the license granted in this Agreement to Capital One and to recipients of software distributed by Capital One, You reserve all right, title, and interest in and to Your Contributions; this Agreement does not impact Your rights to use Your own Contributions for any other purpose.

Sign the Individual Agreement

Sign the Corporate Agreement

Code of Conduct

This project adheres to the Open Code of Conduct. By participating, you are expected to honor this code.