Skip to main content


Project description

Particle Cloud Framework

Particle Cloud Framework is a cloud resource provisioning framework that is fully customizable and extensible, callable by code, and does not require manually maintaining states of resources. Particle Cloud Framework enables the standardization of modeling hierarchical cloud infrastructure, automating deployments, and managing lifecycles of cloud resources.


Docs including quickstart and developer guide


To install particle cloud framework, open an interactive shell and run:

pip install pcf

Import and use a PCF Particle

First import the particles you will use. These can be core particles or custom particles that you created. See examples if you need help creating your config.

from pcf.core.ec2.ec2_instance import EC2Instance
from pcf.core import State

Next we need to pass the desired state definition to the particle.

    ec2_example_definition = {
        "pcf_name": "ec2_example",
        "aws_resource": {
            "ImageId": "ami-xxxxx",
            "InstanceType": "t2.micro",
            "KeyName": "secret-key-xxx",
            "SecurityGroupIds": [
            "SubnetId": "subnet-xxx",
            "userdata_template_file": "",
            "userdata_params": {},
            "IamInstanceProfile": {
              "Arn": "arn:aws:iam::xxxxxxxxx"
            "InstanceInitiatedShutdownBehavior": "stop",
            "tags": {
            "BlockDeviceMappings": [
                "DeviceName": "/dev/sda1",
                "Ebs": {
                  "DeleteOnTermination": true,
                  "VolumeSize": 20,
                  "VolumeType": "gp2"

Now to start the ec2 instance using pcf simply initialize the particle and set the desired state to running and apply.

    particle = EC2Instance(ec2_example_definition)


To terminate simply change the desired state to terminated and apply.


Supported Cloud Services






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.

Project details

Download files

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

Files for pcf, version 0.1.1
Filename, size File type Python version Upload date Hashes
Filename, size pcf-0.1.1-py3-none-any.whl (116.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size pcf-0.1.1.tar.gz (55.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page