When you configure a cluster, an instance, an app, and a default subclient are automatically created.
Before You Begin
The user account must have following privileges:
- Backup (System-level)
- Restore (System-level)
- Create (Database-level): To restore table to existing database (table does not exist)
- Drop (Database and Table level): To restore database or tables to existing database or tables.
Pre-requisites
-
If SSL is configured on the cluster, you need to copy the following to the access node:
-
Certificate Authority (CA) certificate. For more information, see cockroach cert.
-
Client Certificate and key for CockroachDB user (Optional)
-
-
If multiple access nodes are used, then the path to copy has to be the same on all the access nodes.
-
Configuration requirement for CockroachDB deployed on AWS EC2
-
If access node is outside of the CockroachDB or Load balancer (LB) node virtual private cloud (VPC), then complete the following:
-
Create peering connection between the access node VPC and the CockroachDB/LB node VPC.
-
For CockroachDB VPC security group, the cluster port (by default port 26257) needs to be completely opened.
-
From both access node and CockroachDB cluster nodes, it should be able to access the S3 bucket.
-
-
-
To configure CockroachDB instance, you need to make the following entries while adding CockroachDB cluster:
-
Host: Loadbalancer full name or public ip or any CockroachDB host
-
Port Number: The listener port configured on loadbalancer (if LB configured) or the CockroachDB port.
-
-
To use IAM role authentication for S3 bucket, the user needs to have following minimal permission for the IAM role:
{
"Version": "2012-10-17",
"Statement": [ { "Sid": "IAMAssumeRolePrivileges", "Effect": "Allow", "Action":[ "s3:GetObject", "s3:PutObject", "s3:ListBucket", "s3:ListBucketVersions", "s3:DeleteObjectVersion", "s3:DeleteObject", "s3:GetBucketAcl", "s3:GetObjectAcl", "s3:PutBucketAcl", "s3:PutObjectAcl", "s3:PutObjectVersionAcl" ] "Resource": "*" } ] }
For more information about the permissions for the IAM role, refer to Amazon S3 assume role.
Procedure
-
From the Command Center navigation pane, go to Protect > Big data.
The Big data page appears.
-
Click Add cluster.
The Configure Big Data App appears. For further steps, see Configure CockroachDB Cluster (Step 4 onwards).