AWS AWSEC2 documentation change
Summary
Restructured documentation by moving detailed testing/enablement procedures to linked pages and added new sections about ENA queues and troubleshooting guides
Security assessment
The changes primarily reorganize existing content into linked subpages and add operational documentation about queues/troubleshooting. No security vulnerabilities, patches, or exploit mitigations are mentioned. Enhanced networking improvements relate to performance/functionality rather than security hardening.
Diff
diff --git a/AWSEC2/latest/UserGuide/enhanced-networking-ena.md b/AWSEC2/latest/UserGuide/enhanced-networking-ena.md index 4cd757d90..eec5f52ef 100644 --- a//AWSEC2/latest/UserGuide/enhanced-networking-ena.md +++ b//AWSEC2/latest/UserGuide/enhanced-networking-ena.md @@ -5 +5 @@ -Prerequisites for enhanced networking with ENATest whether enhanced networking is enabledEnable enhanced networking on your instance +Prerequisites for enhanced networking with ENA @@ -60 +60 @@ To review network specifications for your instance, choose the instance family l - * Test whether enhanced networking is enabled + * [Test whether enhanced networking is enabled](./test-enhanced-networking-ena.html) @@ -62 +62,7 @@ To review network specifications for your instance, choose the instance family l - * Enable enhanced networking on your instance + * [Enable enhanced networking on your instance](./enabling_enhanced_networking.html) + + * [ENA queues](./ena-queues.html) + + * [Troubleshoot the ENA kernel driver on Linux](./troubleshooting-ena.html) + + * [Troubleshoot the Elastic Network Adapter Windows driver](./troubleshoot-ena-driver.html) @@ -86,414 +91,0 @@ To prepare for enhanced networking using the ENA, set up your instance as follow -## Test whether enhanced networking is enabled - -You can test whether enhanced networking is enabled in your instances or your AMIs. - -###### Instance attribute - -Check the value of the `enaSupport` instance attribute. - -AWS CLI - - -Use the [describe-instances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-instances.html) command. - - - aws ec2 describe-instances \ - --instance-ids i-1234567890abcdef0 \ - --query "Reservations[].Instances[].EnaSupport" - -If enhanced networking is enabled, the output is as follows. - - - [ - true - ] - -PowerShell - - -Use the [Get-EC2Instance](https://docs.aws.amazon.com/powershell/latest/reference/items/Get-EC2Instance.html) cmdlet. - - - (Get-EC2Instance -InstanceId i-1234567890abcdef0).Instances.EnaSupport - -If enhanced networking is enabled, the output is as follows. - - - True - -###### Image attribute - -Check the value of the `enaSupport` image attribute. - -AWS CLI - - -Use the [describe-images](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-images.html) command. - - - aws ec2 describe-images \ - --image-id ami-0abcdef1234567890 \ - --query "Images[].EnaSupport" - -If enhanced networking is enabled, the output is as follows. - - - [ - true - ] - -PowerShell - - -Use the [Get-EC2Image](https://docs.aws.amazon.com/powershell/latest/reference/items/Get-EC2Image.html) cmdlet. - - - (Get-EC2Image -ImageId ami-0abcdef1234567890).EnaSupport - -If enhanced networking is enabled, the output is as follows. - - - True - -###### Linux network interface driver - -Use the following command to verify that the `ena` kernel driver is being used on a particular interface, substituting the interface name that you want to check. If you are using a single interface (default), this is `eth0`. If your Linux distribution supports predictable network names, this could be a name like `ens5`. For more information, expand the section for RHEL, SUSE, and CentOS in Enable enhanced networking on your instance. - -In the following example, the `ena` kernel driver is not loaded, because the listed driver is `vif`. - - - [ec2-user ~]$ ethtool -i eth0 - driver: vif - version: - firmware-version: - bus-info: vif-0 - supports-statistics: yes - supports-test: no - supports-eeprom-access: no - supports-register-dump: no - supports-priv-flags: no - -In this example, the `ena` kernel driver is loaded and at the minimum recommended version. This instance has enhanced networking properly configured. - - - [ec2-user ~]$ ethtool -i eth0 - driver: ena - version: 1.5.0g - firmware-version: - expansion-rom-version: - bus-info: 0000:00:05.0 - supports-statistics: yes - supports-test: no - supports-eeprom-access: no - supports-register-dump: no - supports-priv-flags: no - -## Enable enhanced networking on your instance - -The procedure that you use depends on the operating system of the instance. - -The AMIs for Amazon Linux include the kernel driver required for enhanced networking with ENA installed and have ENA support enabled. Therefore, if you launch an instance with an HVM version of Amazon Linux on a supported instance type, enhanced networking is already enabled for your instance. For more information, see Test whether enhanced networking is enabled. - -The latest Ubuntu HVM AMIs include the kernel driver required for enhanced networking with ENA installed and have ENA support enabled. Therefore, if you launch an instance with the latest Ubuntu HVM AMI on a supported instance type, enhanced networking is already enabled for your instance. For more information, see Test whether enhanced networking is enabled. - -If you launched your instance using an older AMI and it does not have enhanced networking enabled already, you can install the `linux-aws` kernel package to get the latest enhanced networking drivers and update the required attribute. - -###### To install the `linux-aws` kernel package (Ubuntu 16.04 or later) - -Ubuntu 16.04 and 18.04 ship with the Ubuntu custom kernel (`linux-aws` kernel package). To use a different kernel, contact [Support](https://console.aws.amazon.com/support). - -###### To install the `linux-aws` kernel package (Ubuntu Trusty 14.04) - - 1. Connect to your instance. - - 2. Update the package cache and packages. - - ubuntu:~$ sudo apt-get update && sudo apt-get upgrade -y linux-aws - -###### Important - -If during the update process you are prompted to install `grub`, use `/dev/xvda` to install `grub` onto, and then choose to keep the current version of `/boot/grub/menu.lst`. - - 3. [EBS-backed instance] From your local computer, stop the instance using the Amazon EC2 console or one of the following commands: [stop-instances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/stop-instances.html) (AWS CLI) or [Stop-EC2Instance](https://docs.aws.amazon.com/powershell/latest/reference/items/Stop-EC2Instance.html) (AWS Tools for Windows PowerShell). - -[Instance store-backed instance] You can't stop the instance to modify the attribute. Instead, proceed to this procedure: To enable enhanced networking on Ubuntu (instance store-backed instances). - - 4. From your local computer, enable the enhanced networking attribute using one of the following commands: - - * [modify-instance-attribute](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-attribute.html) (AWS CLI) - - aws ec2 modify-instance-attribute --instance-id i-1234567890abcdef0 --ena-support - - * [Edit-EC2InstanceAttribute](https://docs.aws.amazon.com/powershell/latest/reference/items/Edit-EC2InstanceAttribute.html) (Tools for Windows PowerShell) - - Edit-EC2InstanceAttribute -InstanceId i-1234567890abcdef0 -EnaSupport $true - - 5. (Optional) Create an AMI from the instance, as described in [Create an Amazon EBS-backed AMI](./creating-an-ami-ebs.html). The AMI inherits the enhanced networking `enaSupport` attribute from the instance. Therefore, you can use this AMI to launch another instance with enhanced networking enabled by default. - - 6. From your local computer, start the instance using the Amazon EC2 console or one of the following commands: [start-instances](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/start-instances.html) (AWS CLI) or [Start-EC2Instance](https://docs.aws.amazon.com/powershell/latest/reference/items/Start-EC2Instance.html) (AWS Tools for Windows PowerShell). - - - - -###### To enable enhanced networking on Ubuntu (instance store-backed instances) - -Follow the previous procedure until the step where you stop the instance. Create a new AMI as described in [Create an instance store-backed AMI](./creating-an-ami-instance-store.html), making sure to enable the enhanced networking attribute when you register the AMI. - - * [register-image](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/register-image.html) (AWS CLI) - - aws ec2 register-image --ena-support ... - - * [Register-EC2Image](https://docs.aws.amazon.com/powershell/latest/reference/items/Register-EC2Image.html) (AWS Tools for Windows PowerShell) - - Register-EC2Image -EnaSupport $true ... - - - - -The latest AMIs for Red Hat Enterprise Linux, SUSE Linux Enterprise Server, and CentOS include the kernel driver required for enhanced networking with ENA and have ENA support enabled. Therefore, if you launch an instance with the latest AMI on a supported instance type, enhanced networking is already enabled for your instance. For more information, see Test whether enhanced networking is enabled. - -The following procedure provides the general steps for enabling enhanced networking on a Linux distribution other than Amazon Linux AMI or Ubuntu. For more information, such as detailed syntax for commands, file locations, or package and tool support, see the documentation for your Linux distribution. - -###### To enable enhanced networking on Linux - - 1. Connect to your instance. - - 2. Clone the source code for the `ena` kernel driver on your instance from GitHub at [https://github.com/amzn/amzn-drivers](https://github.com/amzn/amzn-drivers). (SUSE Linux Enterprise Server 12 SP2 and later include ENA 2.02 by default, so you are not required to download and compile the ENA driver. For SUSE Linux Enterprise Server 12 SP2 and later, you should file a request to add the driver version you want to the stock kernel). - - git clone https://github.com/amzn/amzn-drivers - - 3. Compile and install the `ena` kernel driver on your instance. These steps depend on the Linux distribution. For more information about compiling the kernel driver on Red Hat Enterprise Linux, see [How do I install the latest ENS driver for enhanced network support on an Amazon EC2 instance that runs RHEL?](https://repost.aws/knowledge-center/install-ena-driver-rhel-ec2)