cdk8sredis

README

cdk8s-redis

Redis constructs for cdk8s

Basic implementation of a Redis construct for cdk8s. Contributions are welcome!

Usage

The following will define a Redis cluster with a primary and 2 replicas:

import { Redis } from 'cdk8s-redis';

// inside your chart:
const redis = new Redis(this, 'my-redis');

DNS names can be obtained from redis.primaryHost and redis.replicaHost.

You can specify how many replicas to define:

new Redis(this, 'my-redis', {
  replicas: 4
});

Or, you can specify no replicas:

new Redis(this, 'my-redis', {
  replicas: 0
});

License

Distributed under the Apache 2.0 license.

Documentation

Overview

Basic implementation of a Redis construct for cdk8s.

Index

• func NewRedis_Override(r Redis, scope constructs.Construct, id *string, options *RedisOptions)
• func Redis_IsConstruct(x interface{}) *bool
• type Redis
  • func NewRedis(scope constructs.Construct, id *string, options *RedisOptions) Redis
• type RedisOptions

Functions

func NewRedis_Override

func NewRedis_Override(r Redis, scope constructs.Construct, id *string, options *RedisOptions)

Experimental.

func Redis_IsConstruct

func Redis_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`. Experimental.

Types

type Redis

type Redis interface {
	constructs.Construct
	// The tree node.
	// Experimental.
	Node() constructs.Node
	// The DNS host for the primary service.
	// Experimental.
	PrimaryHost() *string
	// The DNS host for the replica service.
	// Experimental.
	ReplicaHost() *string
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
}

Experimental.

func NewRedis

func NewRedis(scope constructs.Construct, id *string, options *RedisOptions) Redis

Experimental.

type RedisOptions

type RedisOptions struct {
	// Extra labels to associate with resources.
	// Default: - none.
	//
	// Experimental.
	Labels *map[string]*string `field:"optional" json:"labels" yaml:"labels"`
	// Number of replicas.
	// Default: 2.
	//
	// Experimental.
	Replicas *float64 `field:"optional" json:"replicas" yaml:"replicas"`
}

Experimental.