Difference between revisions of "AWS S3 VPC Flow Log Access"

From Observer GigaFlow Support | VIAVI Solutions Inc.
Jump to: navigation, search
 
(52 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
__TOC__
 +
[[Category:Cloud]]
 +
[[Category:NetFlow]]
 +
Observer Gigaflow uses the Amazon Web Services (AWS) Command Line Interface (CLI) tools to access AWS services.
  
Observer Gigaflow uses the Amazon Web Services (AWS) Command Line Interface (CLI) tools to access AWS services. You can install the latest version of the CLI tools for AWS system from https://aws.amazon.com/cli/.
+
You can install the latest version of the CLI tools for AWS system from https://aws.amazon.com/cli/.
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
 
| '''Note:''' The CLI tools must be configured with the same user used to run Gigaflow for it to be able to access the configuration profile.<br />
 
| '''Note:''' The CLI tools must be configured with the same user used to run Gigaflow for it to be able to access the configuration profile.<br />
 
For Linux, you can use the "su" command to choose the correct user and then run the AWS CLI commands.<br />
 
For Linux, you can use the "su" command to choose the correct user and then run the AWS CLI commands.<br />
For Windows, you need to change the Gigaflow service (using the services manager) to run as a local user. Then log in as that user, install the CLI tools and configure your AWS access.
+
For Windows, you need to change the Gigaflow service (using the services manager) to run as a local user. Then log in as that user, install the CLI tools, and configure your AWS access.
 
|}
 
|}
  
 
After installation, perform the following steps:
 
After installation, perform the following steps:
  
'''1.''' Add a role to your AWS instance with the following permissions:
+
'''1.''' On your AWS console, add a role to the AWS instance with the following permissions:
 
* S3 List/Read/Download
 
* S3 List/Read/Download
 
  {
 
  {
Line 49: Line 53:
 
<br />
 
<br />
 
<br />
 
<br />
GigaFlow uses the below 3 scripts. You must copy them from the <strong style="color:gray;">GigaFlow\resources\docs\eventsscripts\aws\</strong> folder to the <strong style="color:gray;">GigaFlow\resources\prepos\eventscripts</strong> folder to populate via the AWS VPC flow logs.
 
  
{| class="wikitable"
+
=== AWS Flow Log format (minimal recommendations) ===
|-
+
 
! File !! Use !! Event Script Attributes !! Output File
+
Below you can find the minimal recommendations on the AWS Flow Log format for the customer flow logs.
|-
+
 
| AWSVPCFlow.js || Processes the downloaded VPC flow logs and ingests the data into the GigaFlow database. || <strong>vpcDownloadFolder</strong>: The folder with the downloaded flow logs (same as <i>S3VPCFileDownload.js</i> uses) || <strong style="color:blue;">/static/s3fileprocess.html</strong>
+
  ${version} ${account-id} ${instance-id} ${interface-id} ${flow-direction} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}
|-
+
| S3EC2InstanceDetails.js || Gathers instance and interface information from AWS and uses it to add attributes to the created devices so that they can be searched on and displayed as appropriate. ||  || <strong style="color:blue;">/static/ec2instancedetails.html</strong>
+
|-
+
| S3VPCFileDownload.js || Downloads the most recent VPC flow logs from one or more S3 buckets. || <strong>vpcBuckets</strong>: The folder to download flow logs to (same as <i>AWSVPCFlow.js</i> uses) || <strong style="color:blue;">/static/s3filedownload.html</strong>
+
|}
+
<br />
+
After you copy these scripts, they will be visible on the <b>GigaFlow Event Scripts</b> page and you can use this page to monitor their status.
+
[[File:Gigaflow event scripts.png|frameless|left]]
+

Latest revision as of 18:48, 14 March 2024

Contents

Observer Gigaflow uses the Amazon Web Services (AWS) Command Line Interface (CLI) tools to access AWS services.

You can install the latest version of the CLI tools for AWS system from https://aws.amazon.com/cli/.

Note: The CLI tools must be configured with the same user used to run Gigaflow for it to be able to access the configuration profile.

For Linux, you can use the "su" command to choose the correct user and then run the AWS CLI commands.
For Windows, you need to change the Gigaflow service (using the services manager) to run as a local user. Then log in as that user, install the CLI tools, and configure your AWS access.

After installation, perform the following steps:

1. On your AWS console, add a role to the AWS instance with the following permissions:

  • S3 List/Read/Download
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"s3:Get*",
"s3:List*",
"s3-object-lambda:Get*",
"s3-object-lambda:List*"
],
"Resource": "*"
}
]
}
  • EC2 List/Read/Describe
{
 "Version": "2012-10-17",
 "Statement": [
 {
 "Effect": "Allow",
 "Action": "ec2:Describe*",
 "Resource": "*"
 }
 ]
}

2. Generate an Access Key ID and password and add them to your AWS CLI configuration (see https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-quickstart.html).

3. To test your configuration, run the following commands from the CLI:

aws ec2 describe-instances

aws s3 ls s3://

aws ec2 describe-flow-logs

AWS Flow Log format (minimal recommendations)

Below you can find the minimal recommendations on the AWS Flow Log format for the customer flow logs.

 ${version} ${account-id} ${instance-id} ${interface-id} ${flow-direction} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status}