Skip to main content

Quick Setup

This section provides information to help you install and configure the CxLink Backup agent in your SAP database server.

Topics

Create a Storage Profile​

A Storage Provider profile is a set of configuration values that hold all the information needed to use a Cloud Provider storage service as the target for your SAP Backups. In this section you will be able to define the access to remote storage destination as well as its properties. We will use this providers profiles to store o retrieve our backups.

What is a Storage Provider Profile?

You can find a more detailed information in the Storage Provider Profiles section.

Follow these steps to add a new Storage Provider profile for your backups:

  1. Start the emory settings wizard and choose the Storage Providers profiles option:


    _10
    ? CxLink Backup: [Use arrows to move, type to filter]
    _10
    > Storage Providers profiles
    _10
    Data storage providers for backups & restores
    _10
    Specific Database configuration for Oracle database
    _10
    License Software
    _10
    Logging settings
    _10
    Syntax Backups Dashboard
    _10
    Backups Lifecycle
    _10
    Debug traces
    _10
    Exit

  2. Choose Add a new profile


    _10
    ? Select action to perfom: [Use arrows to move, enter to select, type to filter]
    _10
    List all defined profiles
    _10
    > Add new profile
    _10
    Edit existing profile
    _10
    Delete existing profile
    _10
    Return

  3. Choose a name for your provider profile (in this example, development):


    _10
    ? Select action to perfom: Add
    _10
    ? Enter provider profile name: development

  4. Select your desired provider from the available list:


    _10
    ? Select provider type: [Use arrows to move, enter to select, type to filter]
    _10
    > AWS
    _10
    Azure
    _10
    GCP

  5. Follow the steps for the specified Storage Provider:

  • Use AWS Profile. As described in the previous section, you can choose to use an EC2 Instance Service Role (Instance Profile) or an AWS Cli Named Profile to grant the proper permissions to the target Amazon S3 Bucket.


    _10
    ? Use AWS profile? [? for help] (y/N)

    • Choose y if you want to use an AWS CLI named profile instead of the EC2 instance Service Role and enter the name of the profile in the Enter AWS Profile name configured in this server menu option.
    • Leave it empty or enter N if you want to use EC2 Instance Role attached to the EC2 Instance

  • Use AssumeRole. You can store and retrieve your backups or use different AWS KMS keys to/from different AWS Accounts by assuming roles.


    _10
    ? Use AssumeRole? [? for help] (y/N)

    • Choose y if you want to assume a role to grant access to the target Amazon S3 Bucket, and enter the Role ARN.
    • Choose N if you want to use the inline permissions of the EC2 instance.

  • Select storage location Choose the AWS Region where your backups will be stored. The region of your Amazon S3 Bucket.


    _10
    ? Choose AWS Region: [Use arrows to move, enter to select, type to filter]
    _10
    ap-south-1
    _10
    eu-west-3
    _10
    eu-west-2
    _10
    > eu-west-1
    _10
    ap-northeast-3
    _10
    ap-northeast-2
    _10
    ap-northeast-1

  • Select Bucket where your backups will be stored

    You can choose one from your backups list


    _10
    ? Choose bucket from the List: [Use arrows to move, enter to select, type to filter]
    _10
    > emory-backups-dev
    _10
    emory-backups-prd

  • Choose encryption type

    Choose the encryption model that you want to use from your SAP Backups:

    • AES256 (default) (KMS-managed customer master key (CMK) of your AWS Account. Name: aws/s3)

    • aws:kms (AWS Key Management Service) Custom symmetrical CMK stored in KMS.

    • None. To not encrypting your backups, or to accept the default S3 Encryption option.


      _10
      ? Choose encryption type: [Use arrows to move, enter to select, type to filter]
      _10
      > AES256
      _10
      aws:kms
      _10
      none

  • Choose storage class for the backups

    CxLink Backup supports the following S3 storage classes. Choose the one that fits your requirements. More information in: https://aws.amazon.com/s3/storage-classes/?nc1=h_ls


    _10
    ? Choose storage class for the backups: [Use arrows to move, enter to select, type to filter]
    _10
    > Standard
    _10
    Intelligent_Tiering
    _10
    Standard_IA
    _10
    OneZone_IA
    _10
    Reduced_Redundancy

  • Tag S3 Objects with backup information

    CxLink Backup can automatically add information to the Amazon S3 objects by adding tags. This information can help you later to manage your backups lifecycle or to identify specific backups. The information currently added in the object tags are:

    • backup_id - Unique identified generated by the SAP Database
    • backup_type - Full, Log, transaction, incremental, differential, etc..
    • start_date - Timestamp of the backup execution
    • lifecycle - Daily, Weekly, Monthly, Yearly... (See lifecycle section for additional information). D, W, Y, M
    • expiration_date - If you set the lifecycle policy, when the backup is supposed to be deleted.

    More information in : S3 Configuration Settings

  • S3 Downloader/Uploader MemoryBuffer - multipart_chunksize *

  • S3 Downloader/Uploader Concurrency - max_concurrent_requests *

Set the Storage Provider profile as default for your backups​

In this section we will define in which provider profile to use to store or retrieve the backups.

Note: The first time you execute cxLink settings and create a provider profile as explained in the last section, it is configured as default backups provider profile.

  1. Select Provider profile to store backups [] from the options:


    _10
    ? Select : [Use arrows to move, enter to select, type to filter]
    _10
    > Provider profile to store backups []
    _10
    [DR scenarios] Provider profile to restore backups []
    _10
    Return

  2. Choose the profile that you want to use to store backups


    _10
    ? Select : Provider profile to store backups []
    _10
    ? Select provider profile: [Use arrows to move, enter to select, type to filter]
    _10
    prod
    _10
    > dev

  3. Ensure that the profile is listed as the selected.


    _10
    ? Select : [Use arrows to move, enter to select, type to filter]
    _10
    > Provider profile to store backups [dev]
    _10
    [DR scenarios] Provider profile to restore backups [None]
    _10
    Return

  4. You can now select Return and Exit to save the configuration if no other action should be taken.

Register the agent with the License Management Console​

Backup agent needs a valid CxLink license to perform backups to your storage provider. Follow the guidelines described in the register action section to register your agent.

Prepare your database to work with Backup​

As with any Third-Party SAP backup tool, there are additional steps that should be done at the database level to finish the CxLink Backup configuration. Jump into the Database Guide to find out the configuration steps to be done in each specific database: