Search <book_title>...

Veritas CloudPoint Administrator's Guide

Last Published: 2020-06-04

Product(s): CloudPoint (2.2.2)

Platform: Linux

Upgrading a CloudPoint CloudFormation stack

The following upgrade steps are applicable if you have deployed CloudPoint using the CloudFormation Template (CFT) in the AWS cloud. The upgrade process is similar to when you are deploying a new instance using the CloudPoint CFT. The difference is in some of the parameters where you are required to specify the values used in the existing CloudPoint deployment.

For more details about the CloudPoint CFT and the deployment process, refer to the following:

See About CloudPoint deployment in the AWS cloud.

Prerequisites for the upgrade

Perform the following steps before you proceed with the upgrade:

Gather the following details about the existing CloudPoint instance; these are required later during the actual upgrade:
- CloudPoint metadata volume ID.
  Perform the following steps to get the volume ID:
  - In the AWS Console, from the menu on the left, click Services, and then from under Management & Governance, click CloudFormation.
  - From the list of stacks, click on the CloudPoint stack and then click the Resources tab.
  - From the list of resources displayed, locate a volume of type of AWS::EC2::Volume and Logical ID as NewVolume.
    This is the volume that contains the CloudPoint metadata.
  - Copy the entry that appears in the Physical ID column.
    The entry is of the format vol-123456abc789 and it represents the volume ID.
- CloudPoint metadata disk snapshot ID.
  Using the CloudPoint metadata volume ID that you noted earlier, perform the following steps to find out the metadata disk's snapshot ID:
  - In the AWS Console, from the menu on the left, click Services, and then from under Compute, click EC2.
  - From the EC2 Dashboard navigation menu on the left, under Elastic Block Store, click Snapshots.
  - Search for the snapshot ID using the CloudPoint metadata volume ID as the search parameter.
  - Copy the snapshot ID listed under the Snapshot ID column.
- AWS IAM role that is attached to the CloudPoint configuration.
- AWS Elastic IP that is associated with the CloudPoint instance.
- CloudPoint administrator user name and password.
- AWS SNS Topic ARN that is created for the existing CloudPoint stack.
  If required, you can also use another SNS topic ARN altogether.
Sign in to CloudPoint user interface (UI) and from the Job Log page, verify that there are no protection policy snapshot or other operations in progress.
Stop CloudPoint gracefully.
Log on to the CloudPoint instance and then run the following command:
# sudo docker run --rm -it -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:current_version stop
Here, current_version represents the currently installed CloudPoint version.
For example, if the installed CloudPoint version is 2.0.2.4722, the command will be as follows:
# sudo docker run --rm -it -v /cloudpoint:/cloudpoint -v /var/run/docker.sock:/var/run/docker.sock veritas/flexsnap-cloudpoint:2.0.2.4722 stop
The CloudPoint containers are stopped one by one. Messages similar to the following appear on the command line:
```
Stopping the services
Stopping container: flexsnap-agent.e425d969dd4 ...done
Stopping container: flexsnap-agent.4704fd318322 ...done
Stopping container: flexsnap-fluentd ...done
Stopping container: flexsnap-mongodb ...done
Stopping container: flexsnap-rabbitmq ...done
```
Wait for all the CloudPoint containers to be stopped.
Unmount the CloudPoint file system on the instance and then detach the CloudPoint metadata volume mounted at /cloudpoint.
Type the following command on the instance:
# umount /cloudpoint
Disassociate the AWS Elastic IP that is assigned to the existing CloudPoint instance.
From the AWS console, click on the EC2 Service and then from under Network and Security, select Elastic IPs. Select the Elastic IP address assigned to the instance and then click Actions > Disassociate address and then confirm the action.
You will associate the same IP with the newer instance later during the upgrade.
Shut down the existing CloudPoint instance.

Perform the following steps to upgrade a CloudPoint deployment using a new AWS CloudFormation stack.

To upgrade the CloudPoint CloudFormation stack

From the AWS Marketplace online store, download the CloudPoint CloudFormation template of the CloudPoint version that you wish to upgrade to, to a temporary location.
Alternatively, you can also make a note of the template download URL.
Log on to the AWS Management Console and from the top right corner select the region in which you want to run the CloudPoint instance.
From the Services menu, under Management & Governance, select CloudFormation.
To begin creating a new stack, click Create Stack.
Note:
AWS provides different options to create a stack depending on whether you have an existing stack running. Refer to the following for the exact steps:
https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/cfn-console-create-stack.html
On the Select Template page, in the Choose a template section, specify the CloudPoint template using any of the following methods:
- Click Upload a template to Amazon S3 and then click Browse and select the CloudPoint template file that you downloaded earlier.
- Alternatively, click Specify an Amazon S3 template URL and then enter the CloudPoint template download URL.
After specifying the template file, click Next.
On the Specify Details page, in the Stack name field, type a name for the new stack.
Use a descriptive name that helps you identify this stack from a list of stacks later.

On the Specify Details page, in the Parameters section, specify the parameter values.

These parameters allow you to customize the stack at creation time.

CloudPoint System Configuration

Parameter	Description
EC2 Instance Type	From the drop-down list, select the instance type that you want to use for the CloudPoint instance. The instance type can be the same as the existing CloudPoint instance or higher. Specify `t3.large` or a higher configuration.
Volume Size	Specify a size for the EBS volume that is attached to the new instance. This volume is used for storing CloudPoint metadata. Enter a value of `60 GB` or more.
EBS Volume ID	Specify the ID of the EBS volume that contains the CloudPoint metadata of the existing CloudPoint deployment. The specified volume is attached to the newer CloudPoint instance. This parameter is required for the upgrade. Note: Ensure that you specify only one of the parameters, EBS Volume ID or Volume Snapshot ID, for the upgrade. Do not specify both the parameters.
Volume Snapshot ID	Specify the snapshot ID of the disk that contains the CloudPoint metadata of the existing CloudPoint deployment. A new EBS volume is created from the specified snapshot and is attached to the new instance. This parameter is required for the upgrade. Note: Ensure that you specify only one of the parameters, EBS Volume ID or Volume Snapshot ID, for the upgrade. Do not specify both the parameters.
IAM Role	Specify the IAM role that you want to attach to the upgraded CloudPoint instance. This should be the same IAM role that is attached with the existing CloudPoint deployment. This is the same role with which the CloudPoint plug-in for AWS was configured on the existing instance. Ensure that the IAM role is assigned with the permissions that CloudPoint requires. See Configuring AWS permissions for CloudPoint. If you do not specify any value, the CFT creates a new IAM role with requisite permissions and attaches that role to the CloudPoint instance.

Network Configuration

Parameter	Description
CloudPoint Network Interface	Select the network interface to assign to the CloudPoint server. CloudPoint uses this interface for public access. If you specify a private network, ensure that you enable public access for the CloudPoint instance either via a NAT gateway or by configuring a Virtual Private Cloud (VPC) endpoint for the AWS CloudFormation service.
CloudPoint VPC	Specify the ID of the Virtual Private Cloud (VPC) where you want to deploy the CloudPoint instance.
CloudPoint Subnet	From the drop-down list, select the subnet ID of an existing subnet in the VPC where you want to deploy the CloudPoint instance. The drop-down list displays all the existing subnet IDs in the region where you are deploying CloudPoint.
Availability Zone	From the drop-down list, select the availability zone where you want to deploy the CloudPoint instance.
Inbound Access CIDR	Specify the CIDR to allow inbound access to the CloudPoint instance. This is used to create a security group for CloudPoint.
Elastic IP (optional)	If a public network interface was selected for the CloudPoint instance earlier, then specify the Elastic IP to assign to the CloudPoint instance. The IP should be the same IP that was assigned to the existing CloudPoint instance earlier. If an IP is not specified here, an IP address from the AWS pool is automatically assigned to the CloudPoint instance.

CloudPoint Configuration

Parameter	Description
CloudPoint User Name	Specify a valid email address that will be used to configure as an administrator user account on the new CloudPoint instance. The user account must be the same admin account that was configured on the existing CloudPoint instance.
CloudPoint Password	Specify the password for the administrator user account. The password must be the same as that of the admin user account configured on the existing CloudPoint instance.
Confirm CloudPoint Password	Re-enter the password for the administrator user account.
Hostnames (optional)	In case of upgrades, leave this field blank.
License Type	Select the CloudPoint trial license that you wish to activate on the CloudPoint instance. Pick from one of the following options: Freemium A Freemium license is a permanent license that does not expire and allows you to try out a subset of the CloudPoint features. This license lets you protect up to 10 TB of front-end terabyte (FETB) data. Evaluation An Evaluation license is a 60-day time-bound license that allows you to try out all of the CloudPoint features. This license lets you protect up to 1000 TB of FETB data. See Understanding your CloudPoint license.
Enable Telemetry (optional)	Specify whether you want to enable or disable the telemetry service. When enabled, your CloudPoint usage information is shared with Veritas anonymously.

CloudPoint ASG Notification Configuration

Parameter	Description
SNS Topic ARN (optional)	Specify the ARN of the SNS topic that you created for the existing CloudPoint stack. If required, you can also specify a new SNS topic ARN. The SNS topic allows you to receive notifications whenever there is a change to the Auto Scaling Group (ASG). Veritas recommends that you configure an SNS Topic for the CloudPoint instance. The change notifications help you keep a track of the health of the CloudPoint instance. See Instance failures and Auto Scaling Group behavior.

Parameter

Description

SNS Topic ARN

(optional)

Specify the ARN of the SNS topic that you created for the existing CloudPoint stack. If required, you can also specify a new SNS topic ARN.

The SNS topic allows you to receive notifications whenever there is a change to the Auto Scaling Group (ASG).

Veritas recommends that you configure an SNS Topic for the CloudPoint instance. The change notifications help you keep a track of the health of the CloudPoint instance.

See Instance failures and Auto Scaling Group behavior.

CloudPoint KMS Configuration

Parameter	Description
CMK ID (optional)	Specify the ID of the AWS KMS customer master key (CMK) that you want to use to configure AWS KMS with CloudPoint. If KMS was configured in the existing CloudPoint deployment, then specify the CMK that was used earlier. This parameter is not required if you do not want to use KMS with CloudPoint. If you do not specify this parameter, CloudPoint uses the default 256-bit AES specification to encrypt and decrypt all the configuration information. See About CloudPoint integration with AWS KMS.
CMK Region (optional)	Specify the region of the CMK whose ID is specified in the CMK ID field earlier. This parameter is not required if the CMK region is the same as where CloudPoint is being deployed.

Parameter

Description

CMK ID

(optional)

Specify the ID of the AWS KMS customer master key (CMK) that you want to use to configure AWS KMS with CloudPoint.

If KMS was configured in the existing CloudPoint deployment, then specify the CMK that was used earlier.

This parameter is not required if you do not want to use KMS with CloudPoint. If you do not specify this parameter, CloudPoint uses the default 256-bit AES specification to encrypt and decrypt all the configuration information.

See About CloudPoint integration with AWS KMS.

CMK Region

(optional)

Specify the region of the CMK whose ID is specified in the CMK ID field earlier.

This parameter is not required if the CMK region is the same as where CloudPoint is being deployed.

Security Configuration

Parameter	Description
Key Pair Name	From the drop-down list, select the EC2 Key Pair that you want to use to enable SSH access to the CloudPoint instance. The drop-down list displays all the Key Pair names in the region where you want to deploy CloudPoint.

Parameter

Description

Key Pair Name

From the drop-down list, select the EC2 Key Pair that you want to use to enable SSH access to the CloudPoint instance.

The drop-down list displays all the Key Pair names in the region where you want to deploy CloudPoint.

Verify the parameter values and then click Next.
On the Options page, set any additional options (such as Tags, Permissions, Rollback Triggers) for the stack and then click Next.
On the Review page, review all the details that you have provided for the stack.
Under the Capabilities section, you may see an information box that displays a message informing you that this template may create additional IAM resources.
Select I acknowledge that AWS CloudFormation might create IAM resources. to acknowledge and confirm.
Verify all the details and then click Create to launch the stack.
Your stack now appears in the list of AWS CloudFormation stacks and the status appears as CREATE_IN_PROGRESS.
Select the stack and then click the Events tab to see the sequence of events that occur during the creation of the stack.
Click the Resources tab to see all the resources that are created for the stack.
After the stack is created successfully, the status of the stack changes to CREATE_COMPLETE.
This completes the process of setting up a CloudPoint stack using the CloudFormation template.
You can now connect to the CloudPoint instance, install required licenses, and then configure CloudPoint agents and plug-ins.
See Understanding your CloudPoint license.
See About plug-ins.