Deploy a Console agent in AWS from NetApp Console
Deploy a Console agent in AWS without leaving the NetApp Console, so that you can start managing your AWS resources and data services.
Deploying a Console agent in AWS launches an EC2 instance running Linux and the Console agent software in a VPC of your choice.
Step 1: Set up networking to deploy a Console agent in AWS
Ensure that the network location where you plan to deploy the Console agent supports the following requirements. These requirements enable the Console agent to manage resources and processes in your hybrid cloud.
- VPC and subnet
-
When you create the Console agent, you need to specify the VPC and subnet where it should reside.
- Connections to target networks
-
The Console agent requires a network connection to the location where you're planning to create and manage systems. For example, the network where you plan to create Cloud Volumes ONTAP systems or a storage system in your on-premises environment.
- Outbound internet access
-
The network location where you deploy the Console agent must have an outbound internet connection to contact specific endpoints.
- Endpoints contacted from the Console agent
-
The Console agent requires outbound internet access to contact the following endpoints to manage resources and processes within your public cloud environment for day-to-day operations.
The endpoints listed below are all CNAME entries.
Endpoints Purpose AWS services (amazonaws.com):
-
CloudFormation
-
Elastic Compute Cloud (EC2)
-
Identity and Access Management (IAM)
-
Key Management Service (KMS)
-
Security Token Service (STS)
-
Simple Storage Service (S3)
To manage AWS resources. The endpoint depends on your AWS region. Refer to AWS documentation for details
Amazon FSx for NetApp ONTAP:
-
api.workloads.netapp.com
The web-based console contacts this endpoint to interact with the Workload Factory APIs to manage and operate FSx for ONTAP-based workloads.
-
https://mysupport.netapp.com
To obtain licensing information and to send AutoSupport messages to NetApp Support.
-
https://signin.b2c.netapp.com
To update NetApp Support Site (NSS) credentials or to add new NSS credentials to the NetApp Console.
-
https://support.netapp.com
To obtain licensing information and to send AutoSupport messages to NetApp Support as well as to receive software updates for Cloud Volumes ONTAP.
-
https://api.bluexp.netapp.com
-
https://netapp-cloud-account.auth0.com
-
https://netapp-cloud-account.us.auth0.com
-
https://console.netapp.com
-
https://components.console.bluexp.netapp.com
-
https://cdn.auth0.com
To provide features and services within the NetApp Console.
-
https://bluexpinfraprod.eastus2.data.azurecr.io
-
https://bluexpinfraprod.azurecr.io
To obtain images for Console agent deployment and upgrades.
-
- Endpoints contacted from the NetApp console
-
As you use the web-based NetApp Console SaaS application, it contacts several endpoints to complete data management tasks. This includes endpoints that are contacted to deploy the Console agent from the Console.
- Proxy server
-
NetApp supports both explicit and transparent proxy configurations. If you are using a transparent proxy, you only need to provide the certificate for the proxy server. If you are using an explicit proxy, you'll also need the IP address and credentials.
-
IP address
-
Credentials
-
HTTPS certificate
-
- Ports
-
There's no incoming traffic to the Console agent, unless you initiate it or it is used as a proxy to send AutoSupport messages from Cloud Volumes ONTAP to NetApp Support.
-
HTTP (80) and HTTPS (443) provide access to the local UI, which you'll use in rare circumstances.
-
SSH (22) is only needed if you need to connect to the host for troubleshooting.
-
Inbound connections over port 3128 are required if you deploy Cloud Volumes ONTAP systems in a subnet where an outbound internet connection isn't available.
If Cloud Volumes ONTAP systems don't have an outbound internet connection to send AutoSupport messages, the Console automatically configures those systems to use a proxy server that's included with the Console agent. The only requirement is to ensure that the Console agent's security group allows inbound connections over port 3128. You'll need to open this port after you deploy the Console agent.
-
- Enable NTP
-
If you're planning to use NetApp Data Classification to scan your corporate data sources, you should enable a Network Time Protocol (NTP) service on both the Console agent and the NetApp Data Classification system so that the time is synchronized between the systems. Learn more about NetApp Data Classification.
You'll need to implement this networking requirement after you create the Console agent.
Step 2: Set up AWS permissions to deploy the Console agent
Give the Console only the AWS permissions it needs to deploy the Console agent in your VPC, based on the authentication method that you choose.
Choose one of these authentication methods and set up only what it requires:
| Method | What it does | What you set up |
|---|---|---|
Create role for me |
The Console opens AWS CloudFormation Quick Create, which creates the deployment role that the Console assumes. |
Permissions for the AWS identity that submits the stack. |
Assume role |
The Console assumes an existing IAM role in your account. |
A policy and an IAM role. |
AWS keys |
The Console uses an AWS access key and secret key. |
A policy and an IAM user. |
With Create role for me and Assume role, the Console assumes an IAM role, called the deployment role, to deploy the Console agent. After deployment, the Console agent uses a separate IAM role attached to its EC2 instance, called the agent role. By default, the Console creates the agent role for you. Learn how to use your own agent role.
Set up permissions for Create role for me (CloudFormation Quick Create)
Use an AWS identity that can create the CloudFormation stack and the deployment role, so that the stack completes without permission errors.
The identity that submits the CloudFormation Quick Create stack needs administrator permissions or the following minimum permissions. These permissions let CloudFormation create the deployment role. They are not the permissions of the agent role.
{
"Version": "2012-10-17",
"Statement": [
{
"Sid": "CloudFormationStack",
"Effect": "Allow",
"Action": [
"cloudformation:CreateStack",
"cloudformation:DeleteStack",
"cloudformation:DescribeStacks",
"cloudformation:DescribeStackEvents",
"cloudformation:GetTemplateSummary",
"iam:CreateRole",
"iam:DeleteRole",
"iam:GetRole",
"iam:PutRolePolicy",
"iam:DeleteRolePolicy",
"iam:GetRolePolicy",
"iam:PassRole",
"lambda:CreateFunction",
"lambda:DeleteFunction",
"lambda:GetFunction",
"lambda:InvokeFunction"
],
"Resource": "*"
}
]
}
Set up permissions for Assume role or AWS keys
If you choose Assume role or AWS keys, create a policy with only the permissions needed to deploy the Console agent, and attach it to the role or user that the Console uses.
If needed, you can restrict the IAM policy by using the IAM Condition element. AWS documentation: Condition element
-
Go to the AWS IAM console.
-
Select Policies > Create policy.
-
Select JSON.
-
Copy and paste the following policy:
This policy contains only the permissions needed to launch the Console agent in AWS from the Console. View the permissions of the agent role.
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "iam:CreateRole", "iam:DeleteRole", "iam:PutRolePolicy", "iam:CreateInstanceProfile", "iam:DeleteRolePolicy", "iam:AddRoleToInstanceProfile", "iam:RemoveRoleFromInstanceProfile", "iam:DeleteInstanceProfile", "iam:PassRole", "iam:ListRoles", "ec2:DescribeInstanceStatus", "ec2:RunInstances", "ec2:ModifyInstanceAttribute", "ec2:CreateSecurityGroup", "ec2:DeleteSecurityGroup", "ec2:DescribeSecurityGroups", "ec2:RevokeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupEgress", "ec2:AuthorizeSecurityGroupIngress", "ec2:RevokeSecurityGroupIngress", "ec2:CreateNetworkInterface", "ec2:DescribeNetworkInterfaces", "ec2:DeleteNetworkInterface", "ec2:ModifyNetworkInterfaceAttribute", "ec2:DescribeSubnets", "ec2:DescribeVpcs", "ec2:DescribeDhcpOptions", "ec2:DescribeKeyPairs", "ec2:DescribeRegions", "ec2:DescribeInstances", "ec2:CreateTags", "ec2:DescribeImages", "ec2:DescribeAvailabilityZones", "ec2:DescribeLaunchTemplates", "ec2:CreateLaunchTemplate", "cloudformation:CreateStack", "cloudformation:DeleteStack", "cloudformation:DescribeStacks", "cloudformation:DescribeStackEvents", "cloudformation:ValidateTemplate", "ec2:AssociateIamInstanceProfile", "ec2:DescribeIamInstanceProfileAssociations", "ec2:DisassociateIamInstanceProfile", "iam:GetRole", "iam:TagRole", "kms:ListAliases", "cloudformation:ListStacks" ], "Resource": "*" }, { "Effect": "Allow", "Action": [ "ec2:TerminateInstances" ], "Condition": { "StringLike": { "ec2:ResourceTag/OCCMInstance": "*" } }, "Resource": [ "arn:aws:ec2:*:*:instance/*" ] } ] } -
Select Next and add tags, if needed.
-
Select Next and enter a name and description.
-
Select Create policy.
-
Either attach the policy to an IAM role that the Console can assume or to an IAM user so that you can provide the Console with access keys:
-
Assume role: Set up an IAM role that the Console can assume:
-
Go to the AWS IAM console in the target account.
-
Under Access Management, select Roles > Create Role and follow the steps to create the role.
-
Under Trusted entity type, select AWS account.
-
Select Another AWS account and enter the ID of the Console SaaS account: 952013314444
-
Select the policy that you created in the previous section.
-
After you create the role, copy the Role ARN so that you can paste it in the Console when you create the Console agent.
-
-
AWS keys: Set up permissions for an IAM user so that you can provide the Console with access keys:
-
From the AWS IAM console, select Users and then select the user name.
-
Select Add permissions > Attach existing policies directly.
-
Select the policy that you created.
-
Select Next and then select Add permissions.
-
Ensure that you have the access key and secret key for the IAM user.
-
-
You now have a deployment role or an IAM user that has the required permissions. When you deploy the Console agent, you provide the role ARN or the access keys.
Step 3: Set up your own IAM role for the Console agent (optional)
Create your own agent role if you want to select it instead of the role that the Console creates by default. Create the role before you deploy the Console agent.
-
Log in to the AWS console and navigate to the IAM service.
-
Create a policy:
-
Select Policies > Create policy.
-
Select JSON and copy and paste the contents of the IAM policy for the Console agent.
-
Finish the remaining steps to create the policy.
For standard regions, the permissions are spread across two policies. Two policies are required due to a maximum character size limit for managed policies in AWS. Learn more about IAM policies for the Console agent.
-
-
Create an IAM role:
-
Select Roles > Create role.
-
Select AWS service > EC2.
-
Add permissions by attaching the policy that you just created.
-
Finish the remaining steps to create the role.
-
You now have an agent role that you can select in Agent deployment details when you deploy the Console agent.
Step 4: Deploy the Console agent
Provide your authentication, deployment, network, and security group details so that the Console launches the Console agent in your VPC.
-
Creating the Console agent from the Console deploys an EC2 instance in AWS using a default configuration. Do not switch to a smaller EC2 instance with fewer CPUs or less RAM after creating the Console agent. Learn about the default configuration for the Console agent.
-
By default, the Console creates the agent role and its profile. If you provide your own agent role, ensure that you update it as new permissions are added in future releases. Learn more about the IAM policy for the Console agent.
You should have the following:
-
Select Administration > Agents.
-
On the Overview page, select Deploy agent > AWS.
-
In the AWS credentials for agent deployment section, choose one of the following authentication methods:
-
Create role for me:
-
Select your AWS region and enter your AWS account ID. Optionally, enter an external ID.
-
Select Open CloudFormation Quick Create.
-
In AWS, acknowledge the terms and select Create stack.
-
When AWS finishes creating the role, return to the Console and confirm the role.
-
-
Assume role: Enter the ARN of the IAM role and select Validate credentials.
-
AWS keys: Enter the access key and secret key, and select Validate credentials.
-
-
In the Agent deployment details section, provide details about the Console agent.
-
Enter a name.
-
Add custom tags (metadata).
-
Choose whether you want the Console to create the agent role, or select an agent role that you set up yourself.
-
Choose whether you want to encrypt the Console agent's EBS disks. You have the option to use the default encryption key or to use a custom key.
-
-
In the Networking configuration section, specify a VPC, subnet, and key pair for the Console agent, choose whether to enable a public IP address, and optionally specify a proxy configuration.
Ensure you have the correct key pair to access the Console agent virtual machine. Without a key pair, you cannot access it.
-
In the Security group section, choose whether to create a new security group or whether to select an existing security group that allows the required inbound and outbound rules.
-
Review your selections to verify that your setup is correct.
-
The Validate agent configuration check box is selected by default to have the Console validate the network connectivity requirements when you deploy. If the Console fails to deploy the agent, it provides a report to help you troubleshoot. If the deployment succeeds, no report is provided.
-
If you are still using the previous endpoints used for agent upgrades, the validation fails with an error. To avoid this, clear the check box to skip the validation check.
-
During installation, NetApp checks that the agent host has at least 80 percent of total disk space available, which includes 48 GB in
/optand 32 GB in/var(80 GB total). After installation, it requires at least 20 percent of total disk to remain available, which includes 12 GB in/optand 8 GB in/var(20 GB total).
-
-
Select Add.
The Console deploys the Console agent in about 10 minutes. Stay on the page until the process completes.
After the process is complete, the Console agent is available for use from the Console.
If you have Amazon S3 buckets in the same AWS account where you created the Console agent, you'll see an Amazon S3 working environment appear on the Systems page automatically. Learn how to manage S3 buckets from NetApp Console
Troubleshoot a failed Console agent deployment
Use the deployment report to find what blocked the Console agent deployment, and then retry it.
The Console provides a report only if the Validate agent configuration check box was selected. If the deployment succeeds, there is no report.
-
In the Agent deployment failed dialog box, select Download report.
The Console downloads a PDF file that contains the validation report.
-
Review the report and fix the issues that it lists.
-
In the dialog box, select Start over, and then complete the deployment again.
You must start the entire process over to try again.