# crossplane-provider-rediscloud

**Repository Path**: mirrors_RedisLabs/crossplane-provider-rediscloud

## Basic Information

- **Project Name**: crossplane-provider-rediscloud
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-20
- **Last Updated**: 2026-10-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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.

Repository vocabulary is in [GLOSSARY.md](GLOSSARY.md).

## 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

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 `v1alpha1`. `ProviderConfig` is `v1beta1`.

### 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"}'
# Optional third JSON field, only for a non-default API endpoint: "url"
```

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"
    # Copy status.atProvider.id from an EssentialsPlan lookup.
    # The lookup manifest is examples/lookup/essentialsplan.yaml.
    planId: 123456
  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 unit tests:

```bash
make test
```

`make 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](TESTING.md).

### Local Development

Run against a Kubernetes cluster:

```bash
make run
```

Deploy locally for testing:

```bash
make local-deploy
```

## Documentation

- [Terraform Alignment](docs/terraform-alignment.md) - Alignment with Redis Cloud Terraform provider v2.19.2
- [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).