provider-rediscloud is a Crossplane provider that
is built using Upjet code
generation tools and exposes XRM-conformant managed resources for the
RedisCloud API.
Repository vocabulary is in GLOSSARY.md.
This provider enables management of RedisCloud resources through Kubernetes Custom Resources. It includes support for:
- ACL Management - Roles, Rules, and Users
- Active-Active Databases - Multi-region deployments
- Cloud Accounts - AWS and GCP integrations
- Essentials Tier - Free and fixed plans
- Pro Subscriptions - Full-featured Redis deployments
- Private Connectivity - VPC peering and private endpoints
- Transit Gateways - AWS Transit Gateway attachments
- Kubernetes cluster (1.26+)
- Crossplane installed
- RedisCloud API credentials
This provider has no published package. Do not install
xpkg.crossplane.io/RedisLabs/provider-rediscloud:v0.1.0. That image does not
exist. Build from this repository with the Developing steps below, then load
the image into the cluster you use for testing.
Managed resources are stored and reconciled as v1beta1. v1alpha1 stays served for those kinds. ProviderConfig is v1beta1. Lookups stay v1alpha1.
- Create a secret with your RedisCloud credentials:
kubectl create secret generic rediscloud-creds \
--namespace crossplane-system \
--from-literal=credentials='{"api_key":"YOUR_API_KEY","secret_key":"YOUR_SECRET_KEY"}'
# Optional third JSON field, only for a non-default API endpoint: "url"- Create a ProviderConfig:
apiVersion: rediscloud.redis.io/v1beta1
kind: ProviderConfig
metadata:
name: default
spec:
credentials:
source: Secret
secretRef:
name: rediscloud-creds
namespace: crossplane-system
key: credentialsSynthetic examples for every managed resource are in USAGE.md.
Create an Essentials subscription:
apiVersion: essentials.redis.io/v1beta1
kind: Subscription
metadata:
name: my-redis-subscription
spec:
forProvider:
name: "My Redis Subscription"
# Copy status.atProvider.id from an EssentialsPlan lookup.
# The lookup manifest is examples/lookup/essentialsplan.yaml.
planId: 123456
providerConfigRef:
name: default- Go 1.21+
- Docker or Podman
- Make
This project uses devenv for development environment management. To enter the development shell:
devenv shellGenerate CRDs and controllers:
make generateBuild the provider:
make buildRun the unit tests:
make testmake local-deploy installs the provider into a local control plane in the
upbound-system namespace. End-to-end tests create Redis Cloud resources. A
reviewer starts them with a /test-examples="<path>" comment on the pull
request. The steps are in TESTING.md.
Run against a Kubernetes cluster:
make runDeploy locally for testing:
make local-deploy- Usage - Synthetic example for every managed resource
- Release - How a tag, a package, and a Terraform pin pull request are produced
- Terraform Alignment - Alignment with Redis Cloud Terraform provider v2.19.2
- Architecture decisions - Why the provider follows Upjet v2
- Testing Guide - Instructions for testing the provider
- API Reference - Generated CRD documentation
We welcome contributions! Please see our Contributing Guide for details.
This project is licensed under the Apache 2.0 License - see the LICENSE file for details.
For filing bugs, suggesting improvements, or requesting new features, please open an issue.