Providers
Nitric can declare and interact with cloud features in a way that is decoupled from any particular cloud provider. Nitric providers are the abstraction layer that enables this.
Providers are separate plugins comprised of two components—a Deployment Engine, which automatically deploys your cloud resources and a Runtime Adapter, which handles requests from the SDKs forwarding them to appropriate cloud service APIs.
How it works
Applications built with Nitric declare resources, services, and permissions directly in the application code. The following example defines an API named main
, a bucket named images
, and permissions for the service to read
and write
from the bucket.
import { api, bucket } from '@nitric/sdk'
const images = bucket('images').allow('read', 'write')
const mainApi = api('main')
The chosen language SDKs forward these resource requests to the Nitric CLI, which compiles a graph of the required resources and their connections. The graph of cloud resources is then sent the chosen provider for deployment. The provider convert this declaration graph into any cloud resources it wishes that fulfill the developers intentions, typically using Infrastructure as Code tools like Pulumi or Terraform.
The specific cloud services that Nitric's out-of-the-box providers use for each resource is listed in the table below.
mainApi.get('/', async (ctx) => {
const imageContents = await images.file('cat.png').read()
ctx.res.body = imageContents
return ctx
})
The runtime adapter acts as a Nitric protocol compliant server, accepting runtime calls made by a Nitric client (such as one of the Nitric language SDKs), for example calling .read()
on a file in a bucket. The runtime adapter translates these requests into cloud-specific API requests, typically abstracting common boilerplate such as locating SDK credentials for the cloud specific SDK.
This allows your functions to be built, testing and run independent of any underlying cloud service. The end result is code that's faster to write, easier to test and remains portable between cloud services and cloud providers.
It also significantly reduces the burden of writing project specific Infrastructure as Code and ensures the application and its deployment automation don't drift apart as development continues.
You can find out more about how the Nitric CLI and SDK interact with providers on our concepts page.
Standard Providers
Nitric publishes standard providers for AWS, GCP, and Azure, which are available as part of the core open-source repository on GitHub. These providers enable deploying and running code across AWS, Google Cloud, and Azure. The following is a description of the underlying cloud services that each of the standard providers use:
Resource | AWS | Azure | Google Cloud | Local |
---|---|---|---|---|
APIs | API Gateway | API Management | API Gateway | Custom |
Key Value Stores | DynamoDB | Table Storage | FireStore | BoltDB |
Messaging: Topics | SNS | Event Grid | PubSub | Custom |
Messaging: Queues | SQS | Storage Queues | PubSub | Custom |
Schedules | CloudWatch Event Bridge | Dapr Binding | Cloud Scheduler | Custom |
Secrets | Secrets Manager | Key Vault | Secret Manager | Custom |
Storage | S3 | Blob Storage | Cloud Storage | SeaweedFS |
Services | Lambda | Container Apps | CloudRun | Docker |
Our code is completely open-source on our GitHub, so you can know exactly how your resources are being deployed and handled at runtime.
Custom Providers
Because Nitric providers are plugins you're able to create or extend them to meet your specific deployment requirements. Common reasons for custom provider development include:
- Using a language other than Go to develop a provider (Nitric providers can be written in many other languages).
- Using a specific Infrastructure as Code engine, e.g. using Terraform or AWS CDK instead of Pulumi.
- Changing the way resources are deployed to use a preferred service or meet regulatory or policy requirements within your organization.
- Reusing existing work on infrastructure automation, such using existing Terraform Modules for deployment with Nitric.
- Deployments to another cloud provider or on-premises deployments. You can read more about building custom providers here.