CMX cluster add-ons (Alpha)

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

Overview

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

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

note

The object store add-on is scoped to the lifecycle of the cluster it was created for. When the cluster is deleted, the bucket is emptied and deleted, along with the IAM roles and service accounts that granted access to it. Objects in the bucket are not retained, and the bucket cannot be reattached to a newly created cluster. The same applies when the add-on is removed with replicated cluster addon rm.

Treat the bucket as ephemeral test storage. To keep any objects, copy them to storage you control before deleting the add-on or the cluster.

Type	Description
Supported Kubernetes Distributions	EKS (AWS S3)
Cost	Flat fee of $0.50 per bucket.
Lifecycle	Deleted with the cluster, including all objects in the bucket. Not durable storage.
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.