Create the Provider
Our Provider Development documentation is still a work-in-progress. If you're building an Access Provider, join our Community Slack.
Get started by creating a folder for your Access Provider. From the terminal, run
mkdir cf-provider-testvault
cd cf-provider-testvault
By convention, we use cf-provider-<provider name> as a folder name for Common Fate providers. For example, if you are building a provider for AWS CloudWatch Log Groups, you could use the name cf-provider-cloudwatch-log-groups.
Scaffold the provider by running:
pdk init
The pdk CLI should create a file structure similar to the below:
.
├── .venv
├── README.md
├── provider.toml
├── provider_testvault
│ ├── __init__.py
│ └── provider.py
└── requirements.txt
The provider.toml file contains a manifest for the provider with details like the provider name and publisher:
name = "testvault"
publisher = "YOUR_NAME"
version = "v0.1.0"
language = "python3.9"
The requirements.txt file contains a list of Python dependencies for the Provider.
The provider.py contains the Python code to implement your Provider.
Describing the provider
You can verify that the Provider has been scaffolded correctly by running:
pdk run describe
To run pdk run describe successfully, you'll need to create a .env file with the necessary config schema variables. For example, for the CloudWatch logs, the .env file will look like this:
PROVIDER_CONFIG_CLOUDWATCH_READ_ROLE_ARN=arn:aws:iam::XXXXXXXXXXXX:role
PROVIDER_CONFIG_CLOUDWATCH_REGIONS=us-west-2
PROVIDER_CONFIG_SSO_IDENTITY_STORE_ID=d-XXXXXXXXXXXX
PROVIDER_CONFIG_SSO_INSTANCE_ARN=arn:aws:sso:::instance/ssoins-XXXXXXXXXXXX
PROVIDER_CONFIG_SSO_REGION=ap-southeast-2
PROVIDER_CONFIG_SSO_ROLE_ARN=arn:aws:iam::XXXXXXXXXXXX:role
You should see an output similar to the below.
{"config":{},"diagnostics":[],"healthy":true,"provider":{"name":"","publisher":"","version":""},"schema":{"$id":"","$schema":"https://schema.commonfate.io/provider/v1alpha1","config":{},"meta":{"framework":"0.11.0"},"resources":{"loaders":{},"types":{"Resource":{"properties":{"id":{"title":"ID","type":"string"},"name":{"title":"Name","type":"string"}},"required":["id","name"],"title":"Resource","type":"object"}}},"targets":{"Environment":{"properties":{"environment":{"title":"Software Development Environment","type":"string"}},"type":"object"}}}}
The output that you're seeing above is the schema of the Provider. The schema helps Common Fate understand what the provider grants access to, and what configuration variables are required.