Compatibility Matrix Cluster Add-ons (Alpha)

This topic describes the supported cluster add-ons for Replicated Compatibility Matrix.

Overview

Replicated Compatibility Matrix enables you to extend your cluster with add-ons, to make use of by your application, such as an AWS S3 object store. This allows you to more easily provision dependencies required by your application.

CLI

The Replicated CLI can be used to create, manage and remove cluster add-ons.

Supported Add-ons

This section lists the supported cluster add-ons for clusters created with Compatibility Matrix.

object-store (Alpha)

The Replicated cluster object store add-on can be used to create S3 compatible object store buckets for clusters (currently only AWS S3 is supported for EKS clusters).

Assuming you already have a cluster, run the following command with the cluster ID to create an object store bucket:

$ replicated cluster addon create object-store 4d2f7e70 --bucket-prefix mybucket
05929b24    Object Store    pending         {"bucket_prefix":"mybucket"}
$ replicated cluster addon ls 4d2f7e70
ID          TYPE            STATUS          DATA
05929b24    Object Store    ready           {"bucket_prefix":"mybucket","bucket_name":"mybucket-05929b24-cmx","service_account_namespace":"cmx","service_account_name":"mybucket-05929b24-cmx","service_account_name_read_only":"mybucket-05929b24-cmx-ro"}

This will create two service accounts in a namespace, one read-write and the other read-only access to the object store bucket.

Additional service accounts can be created in any namespace with access to the object store by annotating the new service account with the same eks.amazonaws.com/role-arn annotation found in the predefined ones (service_account_name and service_account_name_read_only).

Type	Description
Supported Kubernetes Distributions	EKS (AWS S3)
Cost	Flat fee per bucket.
Options	bucket_prefix (string): A prefix for the bucket name to be created (required)
Data	bucket_prefix: The prefix specified by the user for the bucket name bucket_name: The actual bucket name service_account_namespace: The namespace in which the service accounts (service_account_name and service_account_name_read_only) have been created. service_account_name: The service account name for read-write access to the bucket. service_account_name_read_only: The service account name for read-only access to the bucket.

Postgres (Alpha)

The Replicated cluster Postgres add-on can be used to create Postgres databases for clusters (currently only AWS RDS Postgres is supported for EKS clusters).

Assuming you already have a cluster, run the following command with the cluster ID to create a Postgres instance:

$ replicated cluster addon create postgres 4d2f7e70
156a8d6d    Object Store    pending          {"version":"16.2","disk_gib":200,"instance_type":"db.t3.micro"}
$ replicated cluster addon ls 4d2f7e70
ID          TYPE            STATUS          DATA
156a8d6d    Object Store    ready           156a8d6d    Postgres    ready           {"version":"16.2","disk_gib":200,"instance_type":"db.t3.micro","uri":"postgres://postgres:0b19d6a121a98d0548b3@cmx-156a8d6d.c8ivk9ghfxau.us-east-1.rds.amazonaws.com:5432/postgres"}

This will create a postgres database, and return the uri which allows you to connect to the instance..

Type	Description
Supported Kubernetes Distributions	EKS (AWS RDS Postgres)
Cost	Flat fee per instance.
Options	version (string): The Postgres version to create. Supported versions: 11, 12, 13, 14, 15, 16, 17 instance-type (string):The type of instance to use for the Postgres database (default "db.t3.micro"). Supported Instance Types: db.t3.micro, db.t3.small, db.t3.medium, db.t3.large, db.t3.xlarge, db.t3.2xlarge, db.m5d.large, db.m5d.xlarge, db.m5d.2xlarge disk (number):Disk Size (GiB) for the Postgres database (default 200)
Data	version: The Postgres version that was created. disk_gib: Disk Size (GiB) for the Postgres database (default 200) instance_type: >The type of instance to use for the Postgres database (default "db.t3.micro"). uri: The URI that can be used to connect with the database.