Professional Documents
Culture Documents
Rubrik CDM Version 6.0 Cloud Cluster Setup Guide (Rev. A6)
Rubrik CDM Version 6.0 Cloud Cluster Setup Guide (Rev. A6)
Version 6.0
755-0176-01 Rev A6
Trademarks
Legal Notices
Certain products and features, including the Rubrik-hosted mode of Polaris for Microsoft 365 Protection,
are subject to additional product-specific terms available at https://www.rubrik.com/en/legal.
By using the Rubrik Polaris Sonar application, you understand and acknowledge that Rubrik Polaris Sonar’s
pre-existing Policies and Analyzers contain general suggestions for data elements and formats based on
common data sets and formats. The suggested data elements and formats in Rubrik Polaris Sonar are not
intended to be a comprehensive or exhaustive list of data elements and formats regulated by the GDPR,
CCPA or any other applicable laws and regulations. We also do not guarantee that your Rubrik Polaris
Sonar search results will include every instance of each data element and format within your data set. We
Revision history
Revision Date Description
Rev. A0 May 2021 Early Access 2 release of Rubrik CDM version 6.0.
Rev. A1 June 2021 Directed Availability release of Rubrik CDM version 6.0.
• Added information for using Rubrik Cloud Cluster Elastic Storage
(Cloud Cluster ES) on AWS.
• Updated procedure for removing nodes and decommissioning a
Rubrik Cloud Cluster or Cloud Cluster ES on Azure.
• Added requirement to specify a disk type when creating a Rubrik
Cloud Cluster on Azure.
• Added requirement to specify read/write host caching when
creating a Rubrik Cloud Cluster ES on Azure.
• Updated the bootstrap script for Rubrik Cloud Cluster and Rubrik
Cloud Cluster ES on AWS.
Rev. A2 July 2021 General Availability release of Rubrik CDM version 6.0.
Rev. A3 December 2021 Added information about the workflow for using SSH keys to
authenticate a Rubrik Cloud Cluster on Azure.
Rev. A4 March 2022 • Updated About Rubrik Cloud Clusters.
• Added new section on Rubrik Cloud Cluster sizing.
• Added sections for Rubrik Cloud Cluster and Rubrik Cloud Cluster
ES node requirements.
• Removed bucket requirement for GCP Cloud Cluster setup.
Rev. A5 April 2022 Reverted content about creating and setting up Rubrik Cloud Cluster
for Azure through the marketplace.
Rev.A6 May 2022 Reinstated files that were reverted in revision A5.
Preface 05/12/2022 | iv
Support
Use one of the following methods to contact Rubrik Support.
Related documentation
Rubrik provides documentation that covers a broad range of related concepts, tasks, and reference
information.
• Rubrik Polaris User Guide
• Rubrik Polaris Radar Quick Start Guide
• Rubrik CDM Release Notes
• Rubrik CDM User Guide
• Rubrik CDM Install and Upgrade Guide
• Rubrik CDM Security Guide
• Rubrik CDM Cloud Cluster Setup Guide
• Rubrik CDM Hardware Guide
• Rubrik CDM CLI Guide
• Rubrik CDM Events Guide
• Rubrik Edge Install and Upgrade Guide
• Rubrik Virtual Cluster Install Guide
• Rubrik Compatibility Matrix
Products
To provide comments and suggestions about our products contact Rubrik Support, as described in Support.
Product documentation
To provide comments and suggestions about the product documentation, please send your message by
email to: techpubs@rubrik.com.
Please include the following information about the product documentation to help us to find the content
that is the subject or your comments:
• Full title
• Part number
• Revision
• Relevant pages
Preface 05/12/2022 | v
Rubrik Build
Rubrik hosts community-based tools through the Rubrik Build program and associated GitHub repositories
for community-supplied tools.
Rubrik Build is an open source program that provides access to a growing community of enthusiasts and
experts across a number of languages and tools. Rubrik Build is used to create and improve projects that
simplify monitoring, testing, development, and automated workflows for Rubrik product deployments.
Rubrik Build includes the following resources:
• Software Development Kits
• Tooling Integrations
• Use Cases
• Community Projects
• Rubrik REST API documentation
Important: USE AT YOUR OWN RISK. Rubrik does not officially support the community tools. Carefully
investigate a community tool before using it. Always test a community tool on non-production data before
using the tool with production data.
Contents
Rubrik Cloud Cluster and Rubrik Cloud Cluster Elastic Storage run Rubrik CDM software in a virtual Rubrik
cluster hosted on an AWS, Azure, or GCP virtual private cloud.
Rubrik Cloud Cluster supports standard node or dense node configurations, but does not support mixing
standard nodes with dense nodes. Rubrik Cloud Cluster Elastic Storage (ES) only supports dense node
configurations.
Rubrik Cloud Cluster has the following requirements:
• A minimum of four nodes per cluster
• A minimum of three data disks per node
Rubrik Cloud Cluster ES is hosted on AWS and Azure and has the following requirements:
• A minimum of three nodes per cluster
• One data disk per node
See the Rubrik Compatibility Matrix for AWS, Azure, and GCP configuration requirements.
See the Rubrik CDM User Guide for CDM configuration requirements, including port requirements.
A Rubrik Cloud Cluster protects applications and data by running Rubrik CDM software on Amazon EC2
instances within a virtual private cloud.
A Rubrik Cloud Cluster runs on four or more Amazon EC2 instances, with each instance functioning as a
node of the cluster. Nodes are instantiated through the AWS Management Console, using a Rubrik Amazon
Machine Image (AMI) available from the AWS Marketplace.
For Rubrik Cloud Cluster, data is stored in pre-provisioned block storage on EBS volumes. Reed-Solomon
erasure coding protects data integrity and provides efficient use of storage resources. For Rubrik Cloud
Cluster Elastic Storage (Cloud Cluster ES), data is stored in an S3 bucket.
Requirement Description
AWS account The AWS account must have access to the data sources that the Rubrik Cloud
Cluster will manage and protect.
Rubrik Cloud Cluster A license can be purchased from a Rubrik reseller or from the AWS
license Marketplace.
Web browser Rubrik supports the newest version of Google Chrome and the previous two
versions.
Note: Cloud Cluster ES supports up to 32 TB of storage on Amazon S3. After Cloud Cluster ES reaches
the 32 TB software limitation, create a new Cloud Cluster ES node for additional storage.
Related Tasks
Creating a VPC endpoint for Cloud Cluster ES
Create a VPC endpoint and attach it to the VPC subnet where Rubrik Cloud Cluster ES will be deployed.
Creating an S3 bucket
Create an S3 bucket to store the data for Rubrik Cloud Cluster ES.
Creating an IAM role for S3 access
Create an IAM role to allow the Rubrik Cloud Cluster ES to access the S3 bucket.
Creating a security group
Create a security group with rules that allow all outbound traffic from the Rubrik Cloud Cluster nodes, and
inbound traffic on ports 22 and 443.
Instantiating the nodes for Cloud Cluster ES
Instantiate the Rubrik Cloud Cluster ES nodes using the Rubrik Cloud Cluster Amazon Machine Image
available through the AWS Marketplace.
Setting up Rubrik Cloud Cluster ES for AWS
Context
The VPC endpoint creates a network link between the VPC and S3, which allows the Cloud Cluster Elastic
Storage (Cloud Cluster ES) to access the S3 bucket used for data.
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster
ES.
2. From the list of AWS services, select VPC.
3. From the navigation pane, select Endpoints.
4. Click Create Endpoint.
5. In Service category, select AWS services.
6. In the search field, type s3.
7. Select the S3 service that has type Gateway.
8. In VPC, open the menu and select the VPC where the Cloud Cluster ES will be deployed.
9. Under Configure route tables, select the route table ID that corresponds to the subnet where the
Cloud Cluster ES will be deployed.
10. In Policy, select Full Access.
11. Click Create endpoint.
An information message displays the randomly generated name of the VPC endpoint.
12. Click Close.
AWS creates the new VPC endpoint and adds it to the list of VPC endpoints for the selected region.
Result
The Rubrik Cloud Cluster ES can use the VPC endpoint to access the S3 bucket.
Creating an S3 bucket
Create an S3 bucket to store the data for Rubrik Cloud Cluster ES.
Context
Rubrik Cloud Cluster Elastic Storage (Cloud Cluster ES) uses an S3 bucket instead of EBS volumes to store
data.
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster
ES.
2. From the list of AWS services, select S3.
3. Click Create bucket.
4. In Bucket name, type a name for the S3 bucket.
5. In AWS Region, select the region for the S3 bucket.
The region must be the one where the Cloud Cluster ES will be created.
6. Under Server-side encryption, select Enable.
7. Select Amazon S3 key (SSE-S3).
Result
AWS creates the S3 bucket in the specified region.
Context
The IAM role is used to authenticate the Rubrik Cloud Cluster ES nodes with the S3 bucket.
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster.
2. From the list of AWS services, select IAM.
The Identity and Access Management (IAM) page appears.
3. Under IAM resources, click Roles.
4. Click Create role.
5. Under Select type of trusted entity, select AWS service.
6. Under Choose a use case, select EC2 and click Next: Permissions.
7. Click Create policy.
A new tab opens in the browser window.
8. Click the JSON tab.
The JSON text editor opens.
9. Copy and paste the JSON policy template.
The policy template includes the necessary permissions for accessing the S3 bucket.
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:AbortMultipartUpload",
"s3:DeleteObject*",
"s3:GetObject*",
"s3:ListMultipartUploadParts",
"s3:PutObject*"
],
"Resource": "arn:aws:s3:::<bucket_name>/*"
},
{
"Effect": "Allow",
"Action": [
"s3:GetBucket*",
"s3:ListBucket*"
],
"Resource": "arn:aws:s3:::<bucket_name>"
}
]
}
10. Edit the policy and replace <bucket_name> with the actual name of the S3 bucket.
11. Click Next: Tags.
12. Add tags in the form of key-value pairs.
Result
AWS creates the IAM role that allows the nodes of the Cloud Cluster ES to access the S3 bucket. The IAM
role is specified when the nodes are instantiated.
Related Tasks
Creating a VPC endpoint for Cloud Cluster ES
Create a VPC endpoint and attach it to the VPC subnet where Rubrik Cloud Cluster ES will be deployed.
Creating an S3 bucket
Create an S3 bucket to store the data for Rubrik Cloud Cluster ES.
Creating a security group
Create a security group with rules that allow all outbound traffic from the Rubrik Cloud Cluster nodes, and
inbound traffic on ports 22 and 443.
Instantiating the nodes for Cloud Cluster ES
Instantiate the Rubrik Cloud Cluster ES nodes using the Rubrik Cloud Cluster Amazon Machine Image
available through the AWS Marketplace.
Context
These instructions apply to both Rubrik Cloud Cluster and Rubrik Cloud Cluster Elastic Storage (Cloud
Cluster ES).
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster.
2. In the region list at the top of the dashboard, select a region for the Rubrik Cloud Cluster.
3. Open the Services menu and select EC2.
The EC2 dashboard appears.
4. On the left-side menu, under Network & Security, select Security Groups.
The Security Groups page appears.
5. Click Create security group.
The Create security group modal appears.
6. In Security group name, type a name for the security group.
7. In Description, type a description for the security group.
8. In VPC, select a virtual private cloud.
Result
AWS creates the security group for use with the Rubrik Cloud Cluster.
Related Concepts
Security group rules
The security group for the Rubrik Cloud Cluster requires specific inbound and outbound rules.
Prerequisites
Complete these tasks:
• Purchase a Rubrik Cloud Cluster license from a Rubrik reseller or from the AWS Marketplace.
• Create a VPC endpoint to connect to S3.
• Create an S3 bucket for storing data.
• Create an IAM role specifically for accessing the S3 bucket.
• Create a security group.
• Generate a key pair for connecting to the instances.
Procedure
1. Log in to the AWS account that will manage the Rubrik Cloud Cluster ES.
2. On the AWS services page, click EC2.
The EC2 dashboard appears.
3. In the region list at the top of the dashboard, select a region for the Rubrik Cloud Cluster.
4. Click Launch instance > Launch instance.
The Choose an Amazon Machine Image (AMI) page appears.
5. In the search field, type Rubrik and press return.
The left-side menu populates with matches for the search term.
6. From the left-side menu, select AWS Marketplace.
The Rubrik Cloud Cluster (BYOL) AMI appears.
7. Click Select.
The Rubrik Cloud Cluster (BYOL) dialog box appears.
8. Click Continue.
The Choose an Instance Type page appears.
9. In Filter by, select m5.
10. Select m5.4xlarge as the instance type.
11. Click Next: Configure Instance Details.
12. In Number of instances, type an integer.
A Rubrik Cloud Cluster ES requires a minimum of three instances.
13. In Network, select the VPC where the Rubrik Cloud Cluster ES will be deployed.
14. In Subnet, select the subnet where the Rubrik Cloud Cluster ES will be deployed.
15. In IAM role, select the IAM role that was created to allow access to the S3 bucket.
AWS will attach the IAM role to the instances when they are launched.
16. In Enable termination protection, select Protect against accidental termination.
17. Click Next: Add Storage.
The Add Storage page appears with the root volume specified.
18. Click Add New Volume.
The volume will be used as a staging area disk.
19. In Size (GiB), type 512.
20. In Volume Type, select General Purpose SSD (gp2).
21. Select Delete on Termination.
22. In Encryption, select (default) aws/ebs.
23. Click Next: Add Tags.
24. Optional: Click Add Tag.
A key field and a value field appear.
25. Optional: In Key, type Name.
26. Optional: In Value, type the name of the Rubrik Cloud Cluster ES.
The name helps identify the instances in the EC2 inventory. AWS does not associate this name with
the Rubrik Cloud Cluster ES name.
27. Click Next: Configure Security Group.
28. In Assign a security group, choose Select an existing security group.
A list of security group IDs appears.
29. Select the security group that was created for the Rubrik Cloud Cluster ES.
Result
The Instances page of the EC2 Dashboard appears and AWS launches the Rubrik node instances. When
the instances are fully running, the value in the Instance State column changes to running.
Next task
Set up the Rubrik Cloud Cluster ES through an SSH session on one of the nodes, as described in Setting up
Rubrik Cloud Cluster ES for AWS.
Related Tasks
Creating a VPC endpoint for Cloud Cluster ES
Create a VPC endpoint and attach it to the VPC subnet where Rubrik Cloud Cluster ES will be deployed.
Creating an S3 bucket
Create an S3 bucket to store the data for Rubrik Cloud Cluster ES.
Creating an IAM role for S3 access
Create an IAM role to allow the Rubrik Cloud Cluster ES to access the S3 bucket.
Creating a security group
Create a security group with rules that allow all outbound traffic from the Rubrik Cloud Cluster nodes, and
inbound traffic on ports 22 and 443.
Prerequisites
Complete the tasks described in:
• Creating a VPC endpoint for Cloud Cluster ES
• Creating an S3 bucket
• Creating an IAM role for S3 access
• Creating a security group
• Instantiating the nodes for Cloud Cluster
In addition to these tasks, gather the following information:
• IP addresses for the nodes in the Rubrik Cloud Cluster Elastic Storage (Cloud Cluster ES). The IP
addresses are available from the Instances page in the EC2 dashboard.
• Name of the .pem file that contains the SSH key.
Procedure
1. Log in to a computer with access to the Cloud Cluster ES and the SSH key pair.
2. Use SSH to connect to one of the Cloud Cluster ES nodes.
Result
The Rubrik CLI starts the system setup process. The Bootstrap Progress section appears and the CLI
displays progress messages. When the setup process finishes, the Rubrik Cloud Cluster ES is ready to
register.
Next task
Choose a method to register the Rubrik Cloud Cluster ES, as described in Cloud Cluster registration.
Related Tasks
Creating a security group
Create a security group with rules that allow all outbound traffic from the Rubrik Cloud Cluster nodes, and
inbound traffic on ports 22 and 443.
Instantiating the nodes for Cloud Cluster
Context
These instructions apply to both Rubrik Cloud Cluster and Rubrik Cloud Cluster Elastic Storage (Cloud
Cluster ES).
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster.
2. In the region list at the top of the dashboard, select a region for the Rubrik Cloud Cluster.
3. Open the Services menu and select EC2.
The EC2 dashboard appears.
4. On the left-side menu, under Network & Security, select Security Groups.
The Security Groups page appears.
5. Click Create security group.
The Create security group modal appears.
6. In Security group name, type a name for the security group.
7. In Description, type a description for the security group.
8. In VPC, select a virtual private cloud.
9. Under Inbound rules, click Add rule.
10. In Type, select SSH.
11. In Source, select Custom.
12. In the address field, type a range of IP addresses using CIDR notation.
This range of IP addresses outside the VPC will have access to the Rubrik Cloud Cluster nodes inside
the VPC.
13. Type a description for the SSH inbound rule.
14. Click Add rule.
15. In Type, select HTTPS.
16. In Source, select Custom.
17. In the address field, type a range of IP addresses using CIDR notation.
This range of IP addresses outside the VPC will have access to the Rubrik Cloud Cluster nodes inside
the VPC.
18. Type a description for the HTTPS inbound rule.
19. Under Outbound rules, click Add rule.
20. In Type, select All traffic.
21. In Destination, select Custom.
22. In the address field, select 0.0.0.0/0.
By selecting 0.0.0.0/0, the cluster nodes can communicate with any IP address. As an alternative,
specify a restricted range of IP addresses for outbound communication.
23. Click Create Security Group.
AWS creates the security group and assigns a security group ID.
Result
AWS creates the security group for use with the Rubrik Cloud Cluster.
Related Concepts
Security group rules
The security group for the Rubrik Cloud Cluster requires specific inbound and outbound rules.
Prerequisites
Complete these tasks:
• Purchase a Rubrik Cloud Cluster license from a Rubrik reseller or from the AWS Marketplace.
• Create a security group.
• Generate a key pair for connecting to the instances.
Context
Instantiate a minimum of four nodes in preparation for forming a cluster.
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster.
2. From the list of AWS services, click EC2.
The EC2 dashboard appears.
3. In the region list at the top of the dashboard, select a region for the Rubrik Cloud Cluster.
4. Click Launch instance > Launch instance.
The Choose an Amazon Machine Image (AMI) page appears.
5. In the search field, type Rubrik and press return.
The left-side menu populates with matches for the search term.
6. From the left-side menu, select AWS Marketplace.
The Rubrik Cloud Cluster (BYOL) AMI appears.
7. Click Select.
The Rubrik Cloud Cluster (BYOL) dialog box appears.
8. Click Continue.
The Choose an Instance Type page appears.
9. In Filter by, select m5.
10. Select a type.
Option Description
m5.4xlarge Choose this type for a dense node cluster.
m5.xlarge Choose this type for a standard node cluster.
11. Click Next: Configure Instance Details.
Result
The Instances page of the EC2 Dashboard appears and AWS launches the Rubrik node instances. When
the instances are fully running, the value in the Instance State column changes to running.
Next task
Set up the Rubrik Cloud Cluster through an SSH session on one of the nodes, as described in Setting up
Rubrik Cloud Cluster for AWS.
Related Tasks
Creating a security group
Column Specification
Size (GiB) Type 512, 1024, or 2048. Choose the same number for each volume. For
dense nodes using sc1 disks, type 4096.
Volume Type Select Throughput Optimized HDD (st1) or Cold HDD (sc1). Choose the same
type for each volume. Cold HDD (sc1) is only supported for dense nodes.
Delete on Termination Select this feature.
Encryption Select the (default) aws/ebs KMS key alias to use AWS native encryption on
the EBS volumes. If another key was created for this purpose, select that key
from the menu.
Prerequisites
Complete the tasks described in:
• Creating a security group
• Instantiating the nodes for Cloud Cluster
In addition to these tasks, gather the following information:
• IP addresses for the nodes in the Rubrik Cloud Cluster. The IP addresses are available from the
Instances page in the EC2 dashboard.
• Name of the .pem file that contains the SSH key.
Procedure
1. Log in to a computer with access to the Rubrik Cloud Cluster and the SSH key pair.
2. Use SSH to connect to one of the Rubrik Cloud Cluster nodes.
From a terminal prompt, type: ssh -i path-to-pem-file admin@node-private-ip-
address
Where:
• path-to-pem-file is the path to the file containing the SSH key.
• node-private-ip-address is the private IP address of one of the nodes in the Rubrik Cloud Cluster.
The welcome message appears.
3. At the prompt, type network nslookup www.rubrik.com dns, where dns is the IP address of a
DNS server to be used by the Cloud Cluster.
This command tests the connectivity between the Cloud Cluster node and the DNS servers.
The system setup script uses Google DNS at 8.8.8.8 as the default value.
If the network nslookup request fails to access www.rubrik.com, replace dns with the IP address
of a DNS server that is available to the Cloud Cluster.
4. Repeat the connectivity test for each DNS server used by the Rubrik Cloud Cluster.
Next task
Choose a method to register the Rubrik Cloud Cluster, as described in Cloud Cluster registration.
Procedure
1. On a computer with access to port 443 on one of the nodes of the Rubrik Cloud Cluster, start Google
Chrome.
2. In the address field, type https://Rubrik_Cluster, where Rubrik_Cluster is the resolvable
hostname or private IP address of one of the nodes of the Rubrik Cloud Cluster.
The Welcome page appears.
3. In Username, type admin.
4. In Password, type the password for the admin account.
Use the password for the admin account that was created during system setup.
5. Click Sign In.
Result
The Dashboard page appears.
Prerequisites
Note the ID of the Rubrik Cloud Cluster security group. The security group prevents inbound access to the
Rubrik Cloud Cluster and is only assigned to the Rubrik Cloud Cluster.
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster.
Protocol TCP
Source Custom
9. In the Custom text field, type or paste the ID of the Rubrik Cloud Cluster security group.
10. Click Save.
11. Repeat this task for each security group that controls inbound access to a protected host.
Result
AWS modifies the security groups of the protected hosts to allow inbound access from the Rubrik Cloud
Cluster to the Rubrik Backup Service that is running on the host.
Procedure
1. Log in to the AWS Management Console using an account with administrator privileges.
2. On the AWS services page, click EC2.
The EC2 dashboard appears.
3. In the region list at the top of the dashboard, select the region for the Rubrik Cloud Cluster.
4. From the left-side menu, under Elastic Block Store, select Volumes.
5. Click Create Volume.
The Create Volume page appears.
6. Configure the volume parameters.
Choose the same volume type and size as the existing disks.
7. Click Encryption.
The Master Key field appears.
8. In Master Key, select the default master key from the menu.
9. Click Create Volume.
The Volumes page displays the new volume.
10. Select the new volume, then select Actions > Attach Volume.
The Attach Volume dialog box appears.
Result
The Rubrik cluster formats the new disk and adds it to the specified node of the Rubrik Cloud Cluster.
Prerequisites
Create one or more new EC2 instances from the Rubrik AMI.
• For Rubrik Cloud Cluster Elastic Storage (Cloud Cluster ES), use the procedure described in Instantiating
the nodes for Cloud Cluster ES.
• For Rubrik Cloud Cluster, use the procedure described in Instantiating the nodes for Cloud Cluster.
Note: For Rubrik Cloud Cluster, all nodes on a cluster must have the same number of disks, and each disk
must be the same type and size. Rubrik Cloud Clusters do not support mixing dense nodes and standard
nodes.
Procedure
1. From a computer with network access to the IP address of one of the new nodes, open an SSH
session on that node.
Type ssh admin@node-ip-address, where node-ip-address is the IP address of the new node.
The password prompt appears.
2. Type rubrik.
The Rubrik CLI opens.
3. At the command prompt, type network ifconfig.
Save the node ID and subnet mask for later use.
4. At the command prompt, type network route -n.
Save the default gateway IP address for later use.
5. Open an SSH session on each of the remaining new nodes and obtain their node IDs.
Each new node has the same subnet mask and default gateway IP address. The only unique
information for each node is the node ID.
6. Open the Rubrik REST API playground.
In a web browser, open https://rubrik_cluster/docs/internal/playground/, where
rubrik_cluster is the resolvable hostname or IP address of the Rubrik cloud cluster.
The Rubrik REST API Explorer appears.
{
"nodes": {
"node_id": {
"managementIpConfig": {
"address": "ip-address",
"netmask": "netmask",
"gateway": "gateway"
}
}
},
"ipmiPassword": "NoPassword"
}
Result
The Rubrik REST API server processes the POST request and adds the new nodes to the Rubrik Cloud
Cluster or the Rubrik Cloud Cluster ES.
Related Tasks
Instantiating the nodes for Cloud Cluster ES
Instantiate the Rubrik Cloud Cluster ES nodes using the Rubrik Cloud Cluster Amazon Machine Image
available through the AWS Marketplace.
Instantiating the nodes for Cloud Cluster
Context
Decommissioning a Rubrik Cloud Cluster removes the associated objects from AWS, and permanently
deletes all data that is stored on the Rubrik Cloud Cluster. These instructions apply to both Rubrik Cloud
Cluster and Rubrik Cloud Cluster ES.
Procedure
1. Log in to the AWS Management Console using the account that will manage the Rubrik Cloud Cluster.
2. On the AWS services page, click EC2.
The EC2 dashboard appears.
3. In the navigation pane, under Instances, select Instances.
The Instances page appears.
4. Select one of the Rubrik Cloud Cluster instances.
5. Open the Actions menu and select Instance settings > Change termination protection.
The Change termination protection modal appears.
6. Clear Enable and click Save.
The instance summary on the Details tab shows that termination protection is disabled.
7. Open the Actions menu and select Manage instance state.
8. In Instance state settings, select Terminate.
9. Click Change state.
AWS deletes the instance of the Rubrik Cloud Cluster and removes the EBS root volume.
10. Repeat this process for the remaining instances.
Result
AWS removes the instances from the Rubrik Cloud Cluster.
Next task
For a Rubrik Cloud Cluster ES, complete the decommissioning process by removing the associated S3
bucket and the IAM role, as described in Deleting the S3 bucket and IAM role.
Prerequisites
Remove the instances used as nodes for the Rubrik Cloud Cluster ES, along with their associated
resources, as described in Decommissioning a Cloud Cluster on AWS.
Context
This task completes the decommissioning of a Rubrik Cloud Cluster ES by removing the S3 bucket and the
associated IAM role.
Procedure
1. Log in to the AWS Management Console using the account for the Rubrik Cloud Cluster ES.
Result
The Cloud Cluster ES is completely decommissioned, and AWS removes the S3 bucket and IAM role.
Rubrik CDM on Azure provides the ability to run a Rubrik Cloud Cluster to protect applications and data
within a Microsoft Azure virtual network.
A Rubrik Cloud Cluster runs on four or more virtual machines, with each virtual machine serving as a node
of the cluster.
Rubrik Cloud Cluster stores data in pre-provisioned block storage on Azure data disks. Rubrik Cloud Cluster
Elastic Storage (Cloud Cluster ES) stores data in a container within a storage account.
Requirement Information
Azure subscription account The Azure subscription account must have access to the data sources that
the Rubrik Cloud Cluster will manage and protect.
Rubrik Cloud Cluster license A license can be purchased from a Rubrik reseller or from the Azure
Marketplace.
Secure access Secure access controls which IP addresses can access the Rubrik Cloud
Cluster from outside the virtual network.
Web browser Rubrik supports the newest version of Google Chrome and the previous
two versions.
Note: Cloud Cluster ES supports up to 32 TB of storage on Azure Blob Storage. After Cloud Cluster ES
reaches the 32 TB software limitation, create a new Cloud Cluster ES node for additional storage.
Method Description
Access through a jump Access the public IP of the jump server. From the jump server:
server
• Access the nodes of the Rubrik Cloud Cluster.
• Start a web browser on the jump server and access the Rubrik CDM web
UI of the Rubrik Cloud Cluster through the browser session.
VPN access to the virtual Configure a VPN that includes the virtual network where the Rubrik Cloud
network Cluster is running and the network locations of management hosts. From the
local machine:
• Access the nodes of the Rubrik Cloud Cluster.
• Start a web browser on the local machine and access the Rubrik CDM
web UI of the Rubrik Cloud Cluster through the browser session.
Context
The virtual machines that form the Rubrik Cloud Cluster are deployed and managed from this resource
group.
Procedure
1. Log in to the Azure portal using the subscription account.
2. Under Azure services, select Resource groups.
The Resource groups page appears.
3. Click Create.
The Create a resource group blade appears, with the Basics tab selected.
4. Complete the fields on the blade.
5. Click Next:Tags and supply a name and value for the tag.
Tags can help organize resources by categories.
6. Click Review + create.
A validation message appears.
7. Click Create.
Next task
For Rubrik Cloud Cluster ES, create a service endpoint in the account where the Rubrik Cloud Cluster ES
will be deployed, as described in Creating a service endpoint.
For Rubrik Cloud Cluster, create the virtual machines, as described in Creating Rubrik Cloud Cluster on
Azure.
Related Concepts
Workflow for Rubrik Cloud Cluster ES on Azure
Setting up a Rubrik Cloud Cluster with elastic storage on Azure consists of a sequence of tasks, which must
be performed in the correct order.
Related Tasks
Creating a storage container
Create a storage account with one container to store the data for Rubrik Cloud Cluster ES.
Creating Rubrik Cloud Cluster ES on Azure
Create at least three virtual machines to use as nodes for Rubrik Cloud Cluster ES on Azure.
Setting up Rubrik Cloud Cluster ES for AWS
Use an SSH session to set up Rubrik Cloud Cluster ES for AWS.
Prerequisites
Do the following:
• Complete the steps described in Creating a resource group.
• Create a virtual network with a subnet for Rubrik Cloud Cluster Elastic Storage (Rubrik Cloud Cluster
ES). Azure documentation describes several methods for creating a virtual network.
Context
The service endpoint creates a network link between the virtual network and the storage container.
Procedure
1. Log in to the Azure portal and navigate to the Virtual networks service.
The Virtual networks page displays a list of virtual networks.
2. Click the virtual network where Rubrik Cloud Cluster ES will be deployed.
The overview page for that virtual network appears.
3. From the left-side menu, under Settings, select Subnets.
4. Click the subnet where the Rubrik Cloud Cluster ES will be deployed.
The page with the details for that subnet opens.
5. Under Service Endpoints, in Services, open the menu and select Microsoft.Storage.
6. Click Save.
Result
Azure saves the subnet with the new service endpoint.
Prerequisites
Complete the steps described in Creating a service endpoint.
Context
Create a storage account in the same region where Rubrik Cloud Cluster Elastic Storage (Rubrik Cloud
Cluster ES) will be deployed, then create a container in that storage account.
Procedure
1. Log in to the Azure portal and navigate to Storage accounts.
The Storage accounts page displays a list of storage accounts.
2. Click + Create.
The Create a storage account blade appears, with the Basics tab selected.
3. In Resource group, select the resource group to use for Rubrik Cloud Cluster ES.
4. Under Instance details, in Storage account name, type a name for the storage account.
5. In Region, select the region where Rubrik Cloud Cluster ES will be deployed.
6. In Performance, select Standard.
7. In Redundancy, select Locally-redundant storage (LRS).
8. Click the Networking tab.
9. In Connectivity method, select Public endpoint (selected networks).
10. In Virtual network, select the virtual network for Rubrik Cloud Cluster ES from the menu.
11. In Subnets, select the subnet for Rubrik Cloud Cluster ES.
12. Click Review + create.
A summary appears on the Create a storage account page, along with a validation message.
13. Click Create.
14. Once the storage account is successfully created, navigate to the Storage accounts page and click the
name of the new storage account.
15. From the left-side menu, select Containers.
16. Click + Container.
The New container blade appears.
17. In Name, type a unique name for the container.
18. Click Create.
Result
Azure creates a storage account with the specified container for use with Rubrik Cloud Cluster ES.
Next task
Create Rubrik Cloud Cluster ES, as described in Creating Rubrik Cloud Cluster ES on Azure.
Related Concepts
Workflow for Rubrik Cloud Cluster ES on Azure
Setting up a Rubrik Cloud Cluster with elastic storage on Azure consists of a sequence of tasks, which must
be performed in the correct order.
Related Tasks
Creating a resource group
Create the resource group to use for the Rubrik Cloud Cluster.
Creating a service endpoint
In the virtual network where Rubrik Cloud Cluster ES will be deployed, create a service endpoint to provide
direct connectivity to Azure storage.
Setting up Rubrik Cloud Cluster ES for AWS
Use an SSH session to set up Rubrik Cloud Cluster ES for AWS.
Prerequisites
Complete these tasks:
• Complete the steps described in Creating a storage container.
• Purchase a Rubrik Cloud Cluster license from a Rubrik reseller or from the Azure Marketplace.
• Generate an SSH key pair. Azure documentation describes how to create and manage SSH keys.
Context
Instantiate a minimum of three nodes, one at a time, in preparation for forming a cluster.
Procedure
1. Log in to the Azure Portal.
2. Navigate to the Virtual machines service.
3. Click + Create and select + Virtual machine.
The Create a virtual machine blade appears.
4. In Subscription, select the subscription associated with the Rubrik Cloud Cluster ES.
5. In Resource group, select the resource group for the Rubrik Cloud Cluster ES nodes.
6. In Virtual machine name, type a unique name for the node.
7. In Region, select the region where the Rubrik Cloud Cluster ES will be deployed.
The Rubrik Cloud Cluster ES must be in the same region as the storage container.
8. In Image, click See all images.
The Select an image page appears.
Result
Azure creates the virtual machines for the Rubrik Cloud Cluster ES in the account.
Next task
Configure the cluster, as described in Setting up Rubrik Cloud Cluster ES for Azure.
Related Concepts
Workflow for Rubrik Cloud Cluster ES on Azure
Prerequisites
Have the following information available:
• IP addresses for the nodes in the Rubrik Cloud Cluster Elastic Storage (Rubrik Cloud Cluster ES). The IP
addresses are available from the node overview page in the Azure portal.
• Connection string for the storage container.
• Name of the private key file that contains the private SSH key.
Procedure
1. Log in to a computer with access to the Rubrik Cloud Cluster ES and the SSH key pair.
2. Use SSH to connect to one of the Rubrik Cloud Cluster ES nodes.
From a terminal prompt, type ssh -i path-to-private-key-file admin@node-private-
ip-address
Where:
• path-to-private-key-file is the path to the file containing the private SSH key.
• node-private-ip-address is the private IP address of the node selected for management access to
the Rubrik Cloud Cluster ES.
The welcome message appears.
3. At the prompt, type network nslookup www.rubrik.com dns, where dns is the IP address of a
DNS server to be used by the Rubrik Cloud Cluster ES.
This command tests the connectivity between the Rubrik Cloud Cluster ES node and the DNS servers.
The system setup script uses Google DNS at 8.8.8.8 as the default value.
If the network nslookup request fails to access www.rubrik.com, replace dns with the IP address
of a DNS server that is available to the Rubrik Cloud Cluster ES.
4. Repeat the connectivity test for each DNS server used by the Rubrik Cloud Cluster ES.
5. At the prompt, type network ping ntp, where ntp is the IP address of the NTP server to be used
by the Rubrik Cloud Cluster ES.
The system setup script uses the NTP Project server pool at pool.ntp.org as the default value.
If the ping command fails, replace ntp with the IP address of an NTP server that is available to the
Rubrik Cloud Cluster ES.
6. Repeat the network ping test for each NTP server used by the Rubrik Cloud Cluster ES.
7. At the prompt, type cluster bootstrap.
The User configuration section appears.
Result
The Rubrik CLI starts the system setup process. The Bootstrap Progress section appears and the CLI
displays progress messages. When the setup process finishes, the Rubrik Cloud Cluster is ready to register.
Next task
Choose a method to register the Rubrik Cloud Cluster ES, as described in Cloud Cluster registration.
Context
The virtual machines that form the Rubrik Cloud Cluster are deployed and managed from this resource
group.
Procedure
1. Log in to the Azure portal using the subscription account.
2. Under Azure services, select Resource groups.
The Resource groups page appears.
3. Click Create.
The Create a resource group blade appears, with the Basics tab selected.
4. Complete the fields on the blade.
5. Click Next:Tags and supply a name and value for the tag.
Tags can help organize resources by categories.
6. Click Review + create.
A validation message appears.
Result
The resource group is available for the Rubrik Cloud Cluster.
Next task
For Rubrik Cloud Cluster ES, create a service endpoint in the account where the Rubrik Cloud Cluster ES
will be deployed, as described in Creating a service endpoint.
For Rubrik Cloud Cluster, create the virtual machines, as described in Creating Rubrik Cloud Cluster on
Azure.
Related Concepts
Workflow for Rubrik Cloud Cluster ES on Azure
Setting up a Rubrik Cloud Cluster with elastic storage on Azure consists of a sequence of tasks, which must
be performed in the correct order.
Related Tasks
Creating a storage container
Create a storage account with one container to store the data for Rubrik Cloud Cluster ES.
Creating Rubrik Cloud Cluster ES on Azure
Create at least three virtual machines to use as nodes for Rubrik Cloud Cluster ES on Azure.
Setting up Rubrik Cloud Cluster ES for AWS
Use an SSH session to set up Rubrik Cloud Cluster ES for AWS.
Prerequisites
Complete the following:
• Purchase a Rubrik Cloud Cluster license from a Rubrik reseller or from the Azure Marketplace.
• Create a resource group for the Rubrik Cloud Cluster nodes, as described in Creating a resource group.
• Generate an SSH key pair. Azure documentation describes how to create and manage SSH keys.
Context
Instantiate a minimum of four nodes, one at a time, in preparation for forming a cluster.
Procedure
1. Log in to the Azure Portal.
2. Navigate to the Virtual machines service.
3. Click + Create and select + Virtual machine.
The Create a virtual machine blade appears.
4. In Subscription, select the subscription associated with the Rubrik Cloud Cluster from the menu.
5. In Resource group, select the resource group for the Rubrik Cloud Cluster nodes.
6. In Virtual machine name, type a unique name for the node.
7. In Region, select the region where the Rubrik Cloud Cluster will be deployed.
8. In Image, click See all images.
The Select an image page appears.
9. In the search field, type Rubrik and press Enter.
The Rubrik Cloud Data Management on Azure tile appears.
10. Click Select, then select the Rubrik CDM image to use for the Rubrik Cloud Cluster.
Result
Azure creates the virtual machines for the Rubrik Cloud Cluster in the account.
Next task
Configure the cluster, as described in Setting up Rubrik Cloud Cluster for Azure.
Prerequisites
Complete the following:
• Create a Rubrik Cloud Cluster on Azure, as described in Creating Rubrik Cloud Cluster on Azure.
• Obtain and have available the IP addresses for the nodes in the Rubrik Cloud Cluster. The IP addresses
are available from the node overview page in the Azure portal.
• Obtain and have available the name of the private key file that contains the private SSH key.
Procedure
1. Log in to a computer with access to the Rubrik Cloud Cluster and the SSH key pair.
2. Use SSH to connect to one of the Rubrik Cloud Cluster nodes.
From a terminal prompt, type: ssh -i path-to-private-key-file admin@node-private-
ip-address
Where:
• path-to-private-key-file is the path to the file containing the private SSH key.
• node-private-ip-address is the private IP address of one of the nodes in the Rubrik Cloud Cluster.
The welcome message appears.
3. At the prompt, type network nslookup www.rubrik.com dns, where dns is the IP address of a
DNS server to be used by the Rubrik Cloud Cluster.
This command tests the connectivity between the Rubrik Cloud Cluster node and the DNS servers.
The system setup script uses Google DNS at 8.8.8.8 as the default value.
If the network nslookup request fails to access www.rubrik.com, replace dns with the IP address
of a DNS server that is available to the Rubrik Cloud Cluster.
4. Repeat the connectivity test for each DNS server used by the Rubrik Cloud Cluster.
5. At the prompt, type network ping ntp, where ntp is the IP address of the NTP server to be used
by the Rubrik Cloud Cluster.
The system setup script uses the NTP Project server pool at pool.ntp.org as the default value.
If the ping command fails, replace ntp with the IP address of an NTP server that is available to the
Rubrik Cloud Cluster.
6. Repeat the network ping test for each NTP server used by the Rubrik Cloud Cluster.
7. At the prompt, type cluster bootstrap.
The User configuration section appears.
8. At E-mail, type a valid email address.
The Rubrik Cloud Cluster will send notifications and alerts to this email address.
9. At Password, type a secure password for the admin account.
The password entered in this step replaces the temporary password for the admin account. Keep the
new password in a secure location. The password also provides web UI access for the admin account.
10. At Re-enter Password, retype the password.
The Cluster configuration section appears.
11. At Cluster name, type a name for the Rubrik Cloud Cluster.
The Rubrik Cloud Cluster uses the name to identify itself in the Rubrik CDM web UI and with other
Rubrik clusters.
Result
The Rubrik CLI starts the system setup process. The Bootstrap Progress section appears and the CLI
displays progress messages. When the setup process finishes, the Rubrik Cloud Cluster is ready to register.
Next task
Choose a method to register the Rubrik Cloud Cluster, as described in Cloud Cluster registration.
Related Tasks
Creating a resource group
Create the resource group to use for the Rubrik Cloud Cluster.
Creating Rubrik Cloud Cluster on Azure
Create at least four virtual machines to use as nodes for Rubrik Cloud Cluster on Azure.
Procedure
1. On a computer with access to port 443 on one of the nodes of the Rubrik Cloud Cluster, start Google
Chrome.
Result
The Dashboard page appears.
Procedure
1. Log in to the Rubrik CDM web UI.
2. From the left-side menu, select Servers & Apps and click a choice based on the protected host.
Option Description
Linux Hosts The Linux Hosts tab of the Linux Hosts page
appears.
Windows Hosts The Windows Hosts tab of the Windows Hosts
page appears.
SQL Server DBs The Hosts/Instances tab of the SQL Server DBs
page appears.
3. Depending on the choice made in the previous step, select:
Option Description
Add Linux Hosts The Add Linux Hosts dialog box appears.
Add Windows Hosts The Add Windows Hosts dialog box appears.
4. In the text of the dialog box, click Rubrik Backup Service.
A browser-specific dialog box appears to enable saving the package file.
5. Save the file to a temporary location.
6. In the Rubrik CDM web UI of the Rubrik Cloud Cluster, add each protected host.
Result
The Rubrik Cloud Cluster adds the protected hosts.
Context
Each node can have up to six disks, and each node must have the same number of disks. Disks are added
in the Azure UI first, then the disks are set up and formatted in the Rubrik CDM web UI.
Procedure
1. Log in to the Azure subscription account.
2. On the left-side menu, click Virtual Machines.
The Virtual machines page appears.
3. Click the name of the virtual machine corresponding to the node where the new disk will be added.
The overview page for the virtual machine appears.
4. From the left-side menu, select Disks.
The Disks page appears.
5. Under Data Disks, click + Create and attach a new disk once for each new disk to add to the
node.
A Rubrik Cloud Cluster node can have up to six disks total.
6. Type a name for each disk, and select the same storage type and size as the other disks in the Rubrik
Cloud Cluster.
7. Click Create.
8. Click Save.
Azure creates the disks, attaches them to the virtual machine, and lists the new disks in the virtual
machine's disk settings under Data disks.
9. Return to the Virtual machines page and repeat the process for each of the remaining virtual machines
in the cluster.
Each virtual machine must have the same number of disks so that each node will be the same size.
10. Log in to the Rubrik CDM web UI using an account with administrator privileges.
11. From the left-side menu, select Dashboards > System Performance.
The System Performance dashboard appears, and displays all the nodes for the cluster.
12. Click the name of one of the nodes that has new disks.
The node details page appears, with the new disks indicated by an alert symbol.
13. On the HDD Status card, click Set Up Disk.
The Manage Disk dialog box appears.
14. Click Submit.
15. Set up any remaining new disks for the node.
16. Repeat the process of setting up new disks for all nodes in the cluster.
Result
The Rubrik Cloud Cluster formats the disks and adds them to the specified nodes.
Prerequisites
Create one or more new Azure nodes.
• For Rubrik Cloud Cluster Elastic Storage (Cloud Cluster ES), use the procedure described in Creating
Rubrik Cloud Cluster ES on Azure.
• For Rubrik Cloud Cluster, use the procedure described in Creating Rubrik Cloud Cluster on Azure.
Note: For Rubrik Cloud Cluster, all nodes must have the same number of disks, and each disk must be the
same type and size. Rubrik Cloud Clusters do not support mixing dense nodes and standard nodes.
Procedure
1. From a computer with network access to the IP address of one of the new nodes, open an SSH
session on that node.
Type ssh admin@node-ip-address, where node-ip-address is the IP address of the new node.
The password prompt appears.
2. Type rubrik.
The Rubrik CLI opens.
3. At the command prompt, type network ifconfig.
Save the node ID and subnet mask for later use.
4. At the command prompt, type network route -n.
Save the default gateway IP address for later use.
5. Open an SSH session on each of the remaining new nodes and obtain their node IDs.
Each new node has the same subnet mask and default gateway IP address. The only unique
information for each node is the node ID.
6. Open the Rubrik REST API playground.
In a web browser, open https://rubrik_cluster/docs/internal/playground/, where
rubrik_cluster is the resolvable hostname or IP address of the Rubrik cloud cluster.
The Rubrik REST API Explorer appears.
7. Click /cluster.
The listing expands to show all operations for that endpoint.
8. Click POST /cluster/{id}/node.
The endpoint listing expands.
9. Click Try it out.
The page opens the JSON fields in the request section for editing.
10. In the request section, type the node ID of the first new node, the IP address, the netmask, and the
gateway IP address.
{
"nodes": {
"node_id": {
"managementIpConfig": {
"address": "ip-address",
"netmask": "netmask",
"gateway": "gateway"
}
}
Result
The Rubrik REST API server processes the POST request and adds the new nodes to the Rubrik Cloud
Cluster.
Related Tasks
Creating Rubrik Cloud Cluster on Azure
Create at least four virtual machines to use as nodes for Rubrik Cloud Cluster on Azure.
Creating Rubrik Cloud Cluster ES on Azure
Create at least three virtual machines to use as nodes for Rubrik Cloud Cluster ES on Azure.
Context
Decommissioning a Rubrik Cloud Cluster removes the associated virtual machines from Azure, and
permanently deletes all data that is stored on the Rubrik Cloud Cluster. These instructions apply to both
Rubrik Cloud Cluster and Rubrik Cloud Cluster Elastic Storage (Cloud Cluster ES).
Procedure
1. Log in to the Azure portal using the subscription account for the Rubrik Cloud Cluster or Cloud Cluster
ES.
2. Navigate to the All resources page.
3. Select all the virtual machines that form the Rubrik Cloud Cluster.
The filter field and the grouping field can be used to narrow the results.
4. Select all resources associated with the selected virtual machines.
Each virtual machine has resources of the following types:
• Network security group
• Network interface
• Disk (for Cloud Cluster, this includes one OS disk and three to six data disks; for Cloud Cluster ES,
this includes one OS disk and one staging area disk)
5. On the top menu bar, click Delete.
A confirmation dialog box appears.
6. In Confirm delete, type yes, then click Delete.
Azure deletes the virtual machines and the resources.
Next task
For a Rubrik Cloud Cluster ES, complete the decommissioning process by removing the associated storage
container, as described in Removing a storage container from Rubrik Cloud Cluster ES on Azure.
Prerequisites
Remove the virtual machines used as nodes for the Rubrik Cloud Cluster ES, along with their associated
resources, as described in Decommissioning a Rubrik Cloud Cluster.
Context
This task completes the decommissioning of a Rubrik Cloud Cluster ES by removing the storage container
from the storage account. If the storage account has no containers used for other purposes, delete the
entire storage account.
Procedure
1. Log in to the Azure portal using the subscription account for the Rubrik Cloud Cluster ES.
2. Navigate to the Storage accounts page.
3. Select the storage account that has the container used by the Rubrik Cloud Cluster ES.
The details page for the storage account appears.
4. On the top menu bar, open the menu and select Containers.
The Storage account page lists the containers for that account.
5. Select the container to delete.
6. On the top menu bar, click Delete.
A confirmation dialog box appears.
7. Click OK.
Result
Azure deletes the storage container from the storage account.
Rubrik CDM on Google Cloud Platform provides the ability to run a Rubrik cloud cluster for protecting
applications and data within a virtual network.
Standard node Rubrik Cloud Cluster on Google Clould Platform (GCP) runs on four or more virtual
machines and dense node Rubrik Cloud Cluster GCP runs on three or more virtual machines. Each virtual
machine performs as a node of the cluster. The Rubrik Cloud Cluster uses Reed-Solomon erasure coding to
protect data integrity and provide efficient use of storage resources.
Rubrik provides an image to use as a template when instantiating the nodes of a Rubrik Cloud Cluster.
Rubrik also provides a script that copies the image to the customer account.
Requirement Description
Rubrik Cloud Cluster setup The setup files orchestrate the deployment of the Rubrik Cloud Cluster on
files GCP. Setup files include:
• deploy_client_base.py
• deploy_gcp_client.py
• deploy_rubrik_cluster.py
• gcp_client_ext.py
• cloud_platform_client.py
• customer_details.yml
Download these files from support.rubrik.com.
Web browser Use the latest version of the Google Chrome web browser to install Rubrik
Cloud Cluster on GCP. Rubrik supports the newest version of Chrome and
the previous two versions.
Service account The service account is configured with permissions to allow access to the
GCP API used for deploying the Rubrik Cloud Cluster on GCP.
Related Tasks
Creating a role and a service account
Context
The deployment script uses the service account to copy the image to the account and deploy the Cloud
Cluster nodes. The service account must have specific permissions, which are granted by the role.
Procedure
1. Log in to the Google Cloud Console using a project owner account, or an account with the IAM Role
Administrator role.
The account must have the iam.roles.create permission.
2. From the menu, select Access > Roles.
The Roles page appears and lists the roles for the current project.
3. Click Create Role.
4. Type a name, a title, and a description for the role.
5. Click Add Permissions, then select the permissions to assign to the role.
Select the following permissions:
• accessapproval.requests.dismiss
• compute.disks.create
• compute.globalOperations.get
• compute.images.create
• compute.images.get
• compute.images.getIamPolicy
• compute.images.useReadOnly
• compute.instances.create
• compute.instances.get
• compute.instances.getSerialPortOutput
• compute.subnetworks.get
Result
The Google Cloud Console creates the service account with the required permissions.
Next task
Create a key for the service account, as described in Creating a key.
Creating a key
Create a key to authenticate the service account.
Prerequisites
Create a role with the required permissions and assign it to a service account, as described in Creating a
role and a service account.
Context
The service account requires a private key to authenticate to the Rubrik cloud cluster.
Procedure
1. Log in to the Google Cloud Console using a project owner account, or an account with the Service
Account Key Admin role.
2. From the menu, select Identity > Service Accounts.
3. Select the service account that was previously created.
4. Open the three-dot menu for the service account and select Create key.
The Create private key dialog box appears.
5. Under Key type, select JSON and click Create.
A window appears and displays the name of the file that contains the private key. The Google Cloud
Console downloads the key file to the default location.
6. Click Close.
7. Store the private key in the same directory as the deployment files from support.rubrik.com.
The file can be renamed to a name that is easier to remember; for example, credentials.json.
Result
The deployment script can access the private key to authenticate the service account.
Next task
Specify cluster configuration details and deploy the cluster from the Cloud Shell, as described in Deploying
a Rubrik Cloud Cluster on GCP.
Prerequisites
Download the setup files from support.rubrik.com. Create a key for the service account to
authenticate to the Rubrik Cloud Cluster.
Procedure
1. On a computer, navigate to the directory that contains the files obtained from
support.rubrik.com, along with the private key file.
2. Using a plain text editor, open customer_details.yml and fill in the fields.
3. Save the file.
4. Log in to the Google Cloud Console.
5. In the upper-right of the display, click the terminal icon to activate Cloud Shell.
6. At the top of the console, open the three-dot menu and select Upload Files.
The Rubrik base image folder opens and lists the files in that folder.
7. Select all the files in the folder and click Open.
A window appears and shows file transfer progress.
8. In the Cloud Shell, grant execute permission to deploy_rubrik_cluster.py.
Type chmod u+x deploy_rubrik_cluster.py.
9. Run the command to deploy the Rubrik Cloud Cluster.
Type ./deploy_rubrik_cluster.py --deployment_details_file
customer_details.yml.
The Cloud Shell displays information messages that indicate the progress of the deployment. After
each node is deployed, the script displays the IP address for that node.
10. Copy and retain the name and private IP address of each node.
System setup requires these IP addresses.
Result
Google Cloud instantiates Rubrik Cloud Cluster nodes with the Rubrik base image, and deploys the nodes
according to the instructions in the customer_details.yml file.
Next task
SSH to one of the nodes and set up the Rubrik Cloud Cluster, as described in Setting up the Rubrik Cloud
Cluster on GCP.
Related Tasks
Creating a key
Create a key to authenticate the service account.
Related reference
GCP customer details file
Related Tasks
Creating a key
Method Description
Access through a jump Access the public IP of the jump server. From the jump server:
server
• Access the nodes of the Rubrik Cloud Cluster.
• Start a web browser on the jump server and access the Rubrik CDM web
UI of the Rubrik Cloud Cluster through the browser session.
VPN access to the virtual Configure a VPN that includes the virtual network where the Rubrik Cloud
network Cluster is running and the network locations of management hosts. From the
local machine:
• Access the nodes of the Rubrik Cloud Cluster.
• Start a web browser on the local machine and access the Rubrik CDM
web UI of the Rubrik Cloud Cluster through the browser session.
Prerequisites
Complete the tasks described in the following sections:
• Creating a role and a service account
• Creating a key
• Deploying a Rubrik Cloud Cluster on GCP
Procedure
1. Open an SSH session and navigate to the IP address of one of the nodes.
Type ssh admin@node-ip-address, where node-ip-address is the IP address of the node selected
for management access to the Rubrik Cloud Cluster.
The password prompt appears.
2. Type rubrik.
In a later step, the setup script prompts for a new password to replace this temporary password for
the admin account.
Result
The Rubrik CLI starts the system setup process. The Bootstrap Progress section appears and the CLI
displays progress messages.
Next task
Register the Cloud Cluster, as described in Cloud Cluster registration.
Procedure
1. On a computer with access to port 443 on one of the nodes of the Rubrik Cloud Cluster, start Google
Chrome.
2. In the address field, type https://Rubrik_Cluster, where Rubrik_Cluster is the resolvable
hostname or private IP address of one of the nodes of the Rubrik Cloud Cluster.
The Welcome page appears.
3. In Username, type admin.
4. In Password, type the password for the admin account.
Use the password for the admin account that was created during system setup.
5. Click Sign In.
Result
The Dashboard page appears.
Context
Add the disk to the node in the Google Cloud Console, then go to the Rubrik CDM web UI to format the
disk and add it to the Rubrik Cloud Cluster.
Procedure
1. Log in to the Google Cloud Console using an account with administrator privileges.
2. Select the project associated with the Rubrik Cloud Cluster.
3. From the main menu, select Compute Engine > VM instances.
4. Click the name of the node where the disk will be added.
The VM instance details page appears.
5. On the top menu bar, click Edit.
The page displays additional information available for editing.
6. Under Additional Disks, click Add new disk.
The Additional disks listing expands to include a placeholder for the new disk.
7. In Name, type a name for the new disk.
Result
The Rubrik cluster formats the new disk and adds it to the Rubrik Cloud Cluster on Google Cloud Platform.
Prerequisites
Have available the customer_details.yml file that was used to set up the Rubrik Cloud Cluster.
Context
Add information about the node to the GCP customer details file. In the Google Cloud Shell interface, use
the customer details file to deploy the Rubrik Cloud Cluster. Collect network information for the Rubrik
Cloud Cluster. Use the Rubrik REST API with the network information to configure the network settings on
the Rubrik cloud cluster.
Procedure
1. In a web browser, navigate to the directory that contains the customer_details.yml file.
2. Using any plain text editor, open customer_details.yml and type the names of the new nodes in
the node_names section.
Delete the names of the previously deployed nodes. The script only requires the names of the new
nodes to add to the existing Cloud Cluster.
3. Save the file.
4. Log in to the Google Cloud Console.
5. In the upper-right of the display, click the terminal icon to activate Cloud Shell.
6. At the top of the console, open the three-dot menu and select Upload Files.
The Rubrik base image folder opens and lists the files in that folder.
7. Select the customer_details.yml file and click Open.
A window appears and shows file transfer progress.
8. Run the command to deploy the Rubrik Cloud Cluster.
Type:
After GCP deploys the new nodes, the script displays the IP address for each node.
{
"nodes": {
"node_id": {
"managementIpConfig": {
"address": "ip-address",
"netmask": "netmask",
"gateway": "gateway"
}
}
},
"ipmiPassword": "NoPassword"
}
Result
The Rubrik REST API server processes the POST request and adds the new nodes to the Rubrik Cloud
Cluster.
Procedure
1. Log in to the Google Cloud Console using an account with administrator privileges.
2. Select the project associated with the Rubrik Cloud Cluster.
3. From the main menu, select Compute Engine > VM instances.
4. Click the name of a node.
The VM instance details page appears.
5. On the top menu bar, click Edit.
The page displays additional information available for editing.
6. Under Deletion protection, clear Enable deletion protection.
7. Click Save.
8. In the upper right corner of the VM instance details page, click the delete icon.
A confirmation dialog box appears.
9. Click Delete.
Result
A message indicates that the Google Cloud Platform successfully deleted the instance, and the VM
instances page shows that the node is gone from the list.
Prerequisites
Contact Rubrik Support to obtain a Support Portal login.
Procedure
1. Log in to the Rubrik CDM web UI.
2. Click the gear icon.
The gear menu appears.
3. Click Register Cluster.
Result
The Rubrik Cloud Cluster makes a secure connection with the Rubrik Support Portal server, authenticates
the account information, obtains a registration token, and applies the token to the Rubrik Cloud Cluster.
The Rubrik Cloud Cluster removes the Register Cluster gear menu entry.
Related Concepts
Cloud Cluster registration
Register Rubrik Cloud Clusters through the Rubrik Support portal.
Related Tasks
Registering Rubrik Cloud Clusters offline
If online access is not available, register Rubrik Cloud Clusters with the Rubrik Support portal through
offline registration.
Prerequisites
Contact Rubrik to obtain a Support Portal login.
Procedure
1. From a computer with internet access, log in to https://support.rubrik.com.
2. Navigate to the My Products tab.
3. Click Register a Product.
The Register your Rubrik Cluster page appears.
4. Specify the Cluster Name and Cluster UUID.
5. Click Download Key, to save the registration token to portable media.
The registration token is sometimes referred to as the registration key or the regcode.
6. From the Rubrik Cloud Cluster, log in to the Rubrik CDM web UI.
7. Click the gear icon on the top bar of the Rubrik CDM web UI.
The gear menu appears.
8. Click Register Cluster.
The Register Cluster page appears.
9. In Register Type, select Registration Token.
10. In Registration Token, paste the contents of the registration token file, and click Register.
Result
The Rubrik Cloud Cluster applies the registration token and completes the registration. The Rubrik Cloud
Cluster removes the Register Cluster gear menu entry.
Related Concepts
Cloud Cluster registration