The Redis Cloud Resource Provider lets you manage Redis Cloud resources. The provider is used to interact with the resources supported by Redis Enterprise Cloud. It covers Pro (Flexible) and Annual subscriptions, Essentials (Fixed and Free) plans, Active-Active, ACL, cloud accounts, private service connect, private link, and transit gateway attachments. The schema matches terraform-provider-rediscloud v2.20.0. USAGE.md has a complete example for every shipped resource.
This package is available for several languages/platforms:
To use from JavaScript or TypeScript in Node.js, install using either npm:
npm install @rediscloud/pulumi-rediscloudor yarn:
yarn add @rediscloud/pulumi-rediscloudTo use from Python, install using pip:
pip install pulumi_rediscloudTo use from Go, use go get to grab the latest version of the library:
go get github.com/RedisLabs/pulumi-rediscloud/sdk/go/...The following configuration points are available for the rediscloud provider:
apiKey(environment:REDISCLOUD_ACCESS_KEY, thenREDISCLOUD_API_KEY) - This is the Redis Enterprise Cloud API account key.REDISCLOUD_API_KEYstill works whenREDISCLOUD_ACCESS_KEYis unset.secretKey(environment:REDISCLOUD_SECRET_KEY) - This is the Redis Enterprise Cloud API secret key. It must be provided but can also be set by the environment variable.url(environment:REDISCLOUD_URL) - Optional Cloud API base URL. Defaults to the production Cloud API when unset.
See USAGE.md for a complete quickstart that configures credentials, creates a Pro subscription and database, explains which Pulumi command triggers Cloud API operations, and tears the resources down safely. The same guide includes every other shipped resource. A provider release is described in RELEASE.md.
The QA nightly acceptance workflow tests the
provider against a non-production Redis Cloud account. It creates an ACL rule,
one Pro subscription, and one database through Pulumi, waits for the cloud
resources to become active, and then destroys them. The final checks require the
subscription and database to return HTTP 404.
The workflow runs nightly and can also be started manually. It is not a pull request check and does not block merges.
Add a repository Actions secret named REDISCLOUD_QA. Its value is a JSON
object containing credentials and the Cloud API URL for a QA account:
{
"api_key": "<qa-account-api-key>",
"secret_key": "<qa-account-secret-key>",
"url": "https://<qa-cloud-api-host>/v1"
}The URL is required. The runner refuses the production
api.redislabs.com host and any of its subdomains. Never commit this JSON or
print it in logs.
- Open Actions in this repository.
- Select QA nightly acceptance.
- Select Run workflow and use the
mainbranch. - Choose
AWSorGCP. - Enter a region, or leave it blank to use
us-east-1for AWS orus-central1for GCP. - Set Hold active resources for evidence capture to
0for a normal run, or up to1800seconds when screenshots are required. - Start the workflow and follow the QA create and delete job.
AWS example:
gh workflow run qa-live.yaml \
--repo RedisLabs/pulumi-rediscloud \
--ref main \
-f cloud_provider=AWS \
-f region=us-east-1 \
-f evidence_hold_seconds=300GCP example:
gh workflow run qa-live.yaml \
--repo RedisLabs/pulumi-rediscloud \
--ref main \
-f cloud_provider=GCP \
-f region=us-central1 \
-f evidence_hold_seconds=300Find the new run and watch it:
gh run list \
--repo RedisLabs/pulumi-rediscloud \
--workflow qa-live.yaml \
--limit 1
gh run watch <run-id> \
--repo RedisLabs/pulumi-rediscloudEvery resource is named pulumi-ci-<run-id>. During the optional hold:
- Find
active evidence checkpointin the workflow log. It includes the subscription ID, database ID, cloud provider, and region. - Open that subscription and database in the Redis Cloud SM UI.
- Capture the workflow trigger and target, the active subscription, the active database, and the provider/region.
- After the run finishes, capture the successful destroy and the database and subscription HTTP 404 checks.
The cleanup step runs even when an earlier workflow step fails. A later run also
removes leftover subscriptions whose names start with pulumi-ci- before it
creates new resources.
The AWS and GCP acceptance proof for this workflow is recorded in RED-225329.
For detailed reference documentation, please visit the Pulumi registry.
Repository vocabulary is in GLOSSARY.md.