https://github.com/rawkode/crossplane-provider-rediscloud
https://github.com/rawkode/crossplane-provider-rediscloud
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rawkode/crossplane-provider-rediscloud
- Owner: rawkode
- License: apache-2.0
- Created: 2025-07-22T23:44:56.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-09-02T14:50:26.000Z (9 months ago)
- Last Synced: 2025-10-12T07:33:24.712Z (8 months ago)
- Language: Makefile
- Size: 229 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Provider RedisCloud
`provider-rediscloud` is a [Crossplane](https://crossplane.io/) provider that
is built using [Upjet](https://github.com/crossplane/upjet) code
generation tools and exposes XRM-conformant managed resources for the
RedisCloud API.
## Overview
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
## Getting Started
### Prerequisites
1. [Kubernetes](https://kubernetes.io/) cluster (1.26+)
2. [Crossplane](https://crossplane.io/) installed
3. RedisCloud API credentials
### Installation
Install the provider by using the following command after changing the image tag
to the [latest release](https://marketplace.upbound.io/providers/RedisLabs/provider-rediscloud):
```bash
kubectl crossplane install provider xpkg.crossplane.io/RedisLabs/provider-rediscloud:v0.1.0
```
Alternatively, you can use declarative installation:
```yaml
apiVersion: pkg.crossplane.io/v1
kind: Provider
metadata:
name: provider-rediscloud
spec:
package: xpkg.crossplane.io/RedisLabs/provider-rediscloud:v0.1.0
```
### Configuration
1. Create a secret with your RedisCloud credentials:
```bash
kubectl create secret generic rediscloud-creds \
--namespace crossplane-system \
--from-literal=credentials='{"api_key":"YOUR_API_KEY","secret_key":"YOUR_SECRET_KEY"}'
```
2. Create a ProviderConfig:
```yaml
apiVersion: rediscloud.redis.io/v1beta1
kind: ProviderConfig
metadata:
name: default
spec:
credentials:
source: Secret
secretRef:
name: rediscloud-creds
namespace: crossplane-system
key: credentials
```
### Usage Example
Create an Essentials subscription:
```yaml
apiVersion: essentials.redis.io/v1alpha1
kind: Subscription
metadata:
name: my-redis-subscription
spec:
forProvider:
name: "My Redis Subscription"
planId: 1 # Free plan
providerConfigRef:
name: default
```
## Developing
### Prerequisites
- Go 1.21+
- Docker or Podman
- Make
### Development Environment
This project uses [devenv](https://devenv.sh/) for development environment management. To enter the development shell:
```bash
devenv shell
```
### Building
Generate CRDs and controllers:
```bash
make generate
```
Build the provider:
```bash
make build
```
### Testing
Run the test harness (uses podman by default):
```bash
./scripts/test-provider.sh
```
For detailed testing instructions, see [TESTING.md](TESTING.md).
### Local Development
Run against a Kubernetes cluster:
```bash
make run
```
Deploy locally for testing:
```bash
make local-deploy
```
## Documentation
- [Testing Guide](TESTING.md) - Instructions for testing the provider
- [API Reference](https://doc.crds.dev/github.com/RedisLabs/provider-rediscloud) - Generated CRD documentation
## Contributing
We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
## License
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
## Report a Bug
For filing bugs, suggesting improvements, or requesting new features, please
open an [issue](https://github.com/RedisLabs/provider-rediscloud/issues).