Skip to main content

Register resources in workload factory for Databases

Contributors netapp-rlithman
PDFs

Register instances for Microsoft SQL Server and databases for Oracle so that you can monitor instance and database status, resource utilization, protection, and storage performance in workload factory for Databases.

Registration is possible only for databases engines running on FSx for ONTAP file system storage.

About the task

Registering an instance (SQL Server) or database (Oracle) includes two steps - authentication and preparation. Preparation involves making sure all AWS, NetApp, and PowerShell modules are installed on the instance.

You can authenticate using SQL Server credentials or with Windows credentials.

Note Workload factory supports only Microsoft SQL Server instance and Oracle database registration and management. Depending on the AWS account credentials you select in workload factory, PostgreSQL hosts might appear in the Inventory. Currently, workload factory supports unregistered PostgreSQL instances running only on Amazon Linux operating systems.

Before you begin

Consider the following before registering an instance:

The host for the instance or database must appear in the Inventory tab. For hosts to appear in the inventory, you must add AWS account credentials and read-only or read/write mode permissions.

Registering an instance in a private network

To register an instance (SQL Server) or database (Oracle) in a private network with no external connectivity, the following endpoints need to be available in the VPC with association to the subnets where SQL servers are present. Ensure the interface endpoints allow port 443 in the attached Security Group.

  • S3 Gateway/endpoint

  • ssm

  • ssmmessages

  • fsx

    If you use a proxy server for all outbound connections from EC2 instances, you must allow access to the following domains so that management operations work:

  • .microsoft.com (SQL Server)

  • .powershellgallery.com (SQL Server)

  • .aws.amazon.com

  • .amazonaws.com

Register a SQL Server instance

Registering an instance includes instance authentication and preparation.

Steps

  1. Log in using one of the console experiences.

  2. In the Databases tile, select Go to Databases inventory.

  3. In Databases, select the Inventory tab.

  4. Select Microsoft SQL Server as the engine type.

  5. Select the Instances tab.

  6. Select to register a single instance or multiple instances.

    1. Single instance registration: Navigate to the instance to manage and select Register instance.

    2. Multiple instance registration: Select the Register multiple instances button.

      Two options are available for registering multiple instances. In both cases, the instances must share the same authentication status (unauthenticated or authenticated).

      • Unauthenticated instances: Select multiple unauthenticated instances to register. These instances must share the same authentication credentials and FSx for ONTAP credentials. Select Apply and then Next.

      • Authenticated instances: Select multiple authenticated instances to register and then select Next.

  7. In step 2 on the Register instances page, select the instance authentication mode, enter the following details, and select Next. If instances are already authenticated, select Next.

    • SQL Server authentication: Enter the SQL Server user name and password, and the FSx for ONTAP file system user name and password.

    • Windows authentication: Enter the Windows user name and password, and the FSx for ONTAP file system user name and password.

  8. In step 3, prepare the instance by making sure the instance meets required prerequisites. If all required modules are installed and prerequisites are met, select Next to register the instance. If you need to take action, follow these steps.

    1. If missing, select workload factory to Install missing AWS and NetApp PowerShell modules.

    2. If missing, select workload factory to Install missing PowerShell 7. Installing missing PowerShell module 7 requires a system reboot.

    3. Review the prerequisites list for the following capabilities. Make sure that you meet all prerequisites per capability to register the instance.

      • Review well-architected issues and recommendations

      • Fix well-architected issues

      • Create database

      • Create database copies (sandbox)

        Completing prerequisites includes updating your AWS IAM policy permissions, EC2 IAM instance profile permissions, SQL Server permissions, and PowerShell modules.

    4. When prerequisites are complete and checks are Ready, you can select to Register the instance.

Result

Instance registration initiates. Select the Job monitoring tab to to track progress.

Register an Oracle database

Registering a database includes instance authentication and preparation.

Steps

  1. Log in using one of the console experiences.

  2. In the Databases tile, select Go to Databases inventory.

  3. In Databases, select the Inventory tab.

  4. In the Inventory tab, select Oracle as the database engine.

  5. Select the Databases tab.

  6. Select to register a single database or multiple databases.

    1. Single database registration: Navigate to the database to manage and select Register database.

    2. Multiple database registration: Select the Register multiple databases button.

      Two options are available for registering multiple databases. In both cases, the databases must share the same authentication status (unauthenticated or authenticated).

      • Unauthenticated databases: Select multiple unauthenticated databases to register. These databases must share the same authentication credentials and FSx for ONTAP credentials. Select Apply and then Next.

      • Authenticated databases: Select multiple authenticated databases to register and then select Next.

  7. In step 2 on the Register databases page, select the database authentication mode, enter the following details, and select Next. If databases are already authenticated, select Next.

    • Oracle user authentication: Enter the Oracle user name and password, and the FSx for ONTAP file system user name and password.

    • Oracle ASM user authentication: Optional. If the Oracle database uses Automatic Storage Management (ASM), enter the Oracle ASM (grid) user name and password.

  8. In step 3, prepare the database by making sure the database meets required prerequisites. If all required modules are installed and prerequisites are met, select Next to register the database. If you need to take action, follow these steps.

    1. Review the prerequisites list for the following capability. All prerequisites for a single capability must be complete to register the database.

      • Review well-architected issues and recommendations

    2. Complete the following prerequisites:

      • AWS IAM policy permissions: Copy and update AWS permissions in the AWS console.

      • EC2 IAM instance profile permissions: Copy and update EC2 IAM instance profile permissions on the Amazon EC2 instance in the AWS console.

      • Deployment modules: If required, select to install dependent modules which include the AWS Command Line interface (AWS CLI), jq (command-line JSON processor), and Python 3.12, if version 3.6 or greater isn't already installed. Workload factory automatically installs these modules as part of the registration process.

      • Oracle user permissions: If required, update the permissions for the Oracle user.

    3. When prerequisites are complete and checks are Ready, you can select to Register the database.

Result

Database registration initiates. Select the Job monitoring tab to to track progress.

What's next

After resource registration, you can perform the following tasks.