Skip to content

Commit 52228a3

Browse files
zmoogzmoog
committed
Address review comments
Changes: - Clarify processor v2 is required for websockets and proxy - Clarify minimum set of EA version (I would add the min version in the docs) - Highlight outbound connections
1 parent 21c43a5 commit 52228a3

4 files changed

Lines changed: 50 additions & 28 deletions

File tree

‎packages/azure/_dev/build/docs/README.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -358,12 +358,11 @@ The Agent uses the **integration name** and the **event hub name** to uniquely i
358358
└─Elastic Agent───────────────────┘ └─Storage Account──────────────────────────┘
359359
```
360360

361+
361362
### Running the integration behind a firewall
362363

363364
When the Elastic Agent runs in an environment with network restrictions, you need to check if the required ports are open, depending on the transport protocol used by the integration.
364365

365-
#### Requirements
366-
367366
The Elastic agent requires access to the following Azure services:
368367

369368
- Event Hubs
@@ -399,7 +398,7 @@ The Elastic agent requires access to the following Azure services:
399398

400399
By default, the integration uses AMQP to communicate with the event hub.
401400

402-
AMQP uses port `5671` and `5672` for secure communication with the event hub. These ports are used to receive events. By allowing traffic on these ports, the Elastic Agent can establish a secure connection with the event hub.
401+
AMQP uses port `5671` and `5672` for secure communication with the event hub. The Elastic Agent acts as a client and initiates **outbound TCP connections** to these ports on the Azure Event Hubs service. By allowing outgoing traffic to these ports, the Elastic Agent can establish a secure connection with the event hub to receive events.
403402

404403
For more information, check the following documents:
405404

@@ -410,11 +409,16 @@ For more information, check the following documents:
410409

411410
If ports 5671/5672 are blocked in your environment, the integration can use AMQP-over-WebSockets instead. This protocol tunnels AMQP over port 443 (HTTPS), which is typically allowed through firewalls.
412411

412+
##### Requirements
413+
414+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
415+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
416+
413417
To use AMQP-over-Websockets, set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" in the **Advanced options** section of the integration.
414418

415-
#### Storage Account (HTTPS)
419+
#### Storage Account
416420

417-
Port `443` is used for secure communication with the Storage Account service. This port is commonly used for HTTPS traffic. By allowing traffic on port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
421+
The Elastic Agent initiates **outbound TCP connections** to port `443` (HTTPS) to communicate with the Azure Storage Account service. By allowing outgoing traffic to port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
418422

419423
#### DNS
420424

@@ -432,7 +436,11 @@ When using AMQP-over-WebSockets, both Event Hubs and Storage Account traffic use
432436

433437
The integration supports proxying traffic to the Azure services using the `HTTPS_PROXY` environment variable.
434438

435-
**IMPORTANT**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
439+
##### Requirements
440+
441+
- **Transport protocol**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
442+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
443+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
436444

437445
## Settings
438446

‎packages/azure/_dev/build/docs/events.md‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -487,13 +487,10 @@ The Elastic Agent can use a single Storage Account to store the checkpoint infor
487487
└─Elastic Agent───────────────────┘ └─Storage Account──────────────────────────┘
488488
```
489489

490-
491490
### Running the integration behind a firewall
492491

493492
When the Elastic Agent runs in an environment with network restrictions, you need to check if the required ports are open, depending on the transport protocol used by the integration.
494493

495-
#### Requirements
496-
497494
The Elastic agent requires access to the following Azure services:
498495

499496
- Event Hubs
@@ -529,7 +526,7 @@ The Elastic agent requires access to the following Azure services:
529526

530527
By default, the integration uses AMQP to communicate with the event hub.
531528

532-
AMQP uses port `5671` and `5672` for secure communication with the event hub. These ports are used to receive events. By allowing traffic on these ports, the Elastic Agent can establish a secure connection with the event hub.
529+
AMQP uses port `5671` and `5672` for secure communication with the event hub. The Elastic Agent acts as a client and initiates **outbound TCP connections** to these ports on the Azure Event Hubs service. By allowing outgoing traffic to these ports, the Elastic Agent can establish a secure connection with the event hub to receive events.
533530

534531
For more information, check the following documents:
535532

@@ -538,17 +535,18 @@ For more information, check the following documents:
538535

539536
#### Event Hubs (AMQP-over-Websockets)
540537

541-
This feature requires:
542-
- Elastic Agent 8.19.10, 9.1.10 or 9.2.4 (or later)
543-
- Set the `Processor version` to `v2`
544-
545538
If ports 5671/5672 are blocked in your environment, the integration can use AMQP-over-WebSockets instead. This protocol tunnels AMQP over port 443 (HTTPS), which is typically allowed through firewalls.
546539

540+
##### Requirements
541+
542+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
543+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
544+
547545
To use AMQP-over-Websockets, set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" in the **Advanced options** section of the integration.
548546

549547
#### Storage Account
550548

551-
Port `443` is used for secure communication with the Storage Account service. This port is commonly used for HTTPS traffic. By allowing traffic on port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
549+
The Elastic Agent initiates **outbound TCP connections** to port `443` (HTTPS) to communicate with the Azure Storage Account service. By allowing outgoing traffic to port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
552550

553551
#### DNS
554552

@@ -566,8 +564,11 @@ When using AMQP-over-WebSockets, both Event Hubs and Storage Account traffic use
566564

567565
The integration supports proxying traffic to the Azure services using the `HTTPS_PROXY` environment variable.
568566

569-
**IMPORTANT**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
567+
##### Requirements
570568

569+
- **Transport protocol**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
570+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
571+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
571572

572573
## Settings
573574

‎packages/azure/docs/README.md‎

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -358,12 +358,11 @@ The Agent uses the **integration name** and the **event hub name** to uniquely i
358358
└─Elastic Agent───────────────────┘ └─Storage Account──────────────────────────┘
359359
```
360360

361+
361362
### Running the integration behind a firewall
362363

363364
When the Elastic Agent runs in an environment with network restrictions, you need to check if the required ports are open, depending on the transport protocol used by the integration.
364365

365-
#### Requirements
366-
367366
The Elastic agent requires access to the following Azure services:
368367

369368
- Event Hubs
@@ -399,7 +398,7 @@ The Elastic agent requires access to the following Azure services:
399398

400399
By default, the integration uses AMQP to communicate with the event hub.
401400

402-
AMQP uses port `5671` and `5672` for secure communication with the event hub. These ports are used to receive events. By allowing traffic on these ports, the Elastic Agent can establish a secure connection with the event hub.
401+
AMQP uses port `5671` and `5672` for secure communication with the event hub. The Elastic Agent acts as a client and initiates **outbound TCP connections** to these ports on the Azure Event Hubs service. By allowing outgoing traffic to these ports, the Elastic Agent can establish a secure connection with the event hub to receive events.
403402

404403
For more information, check the following documents:
405404

@@ -410,11 +409,16 @@ For more information, check the following documents:
410409

411410
If ports 5671/5672 are blocked in your environment, the integration can use AMQP-over-WebSockets instead. This protocol tunnels AMQP over port 443 (HTTPS), which is typically allowed through firewalls.
412411

412+
##### Requirements
413+
414+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
415+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
416+
413417
To use AMQP-over-Websockets, set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" in the **Advanced options** section of the integration.
414418

415-
#### Storage Account (HTTPS)
419+
#### Storage Account
416420

417-
Port `443` is used for secure communication with the Storage Account service. This port is commonly used for HTTPS traffic. By allowing traffic on port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
421+
The Elastic Agent initiates **outbound TCP connections** to port `443` (HTTPS) to communicate with the Azure Storage Account service. By allowing outgoing traffic to port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
418422

419423
#### DNS
420424

@@ -432,7 +436,11 @@ When using AMQP-over-WebSockets, both Event Hubs and Storage Account traffic use
432436

433437
The integration supports proxying traffic to the Azure services using the `HTTPS_PROXY` environment variable.
434438

435-
**IMPORTANT**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
439+
##### Requirements
440+
441+
- **Transport protocol**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
442+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
443+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
436444

437445
## Settings
438446

‎packages/azure/docs/events.md‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -487,13 +487,10 @@ The Elastic Agent can use a single Storage Account to store the checkpoint infor
487487
└─Elastic Agent───────────────────┘ └─Storage Account──────────────────────────┘
488488
```
489489

490-
491490
### Running the integration behind a firewall
492491

493492
When the Elastic Agent runs in an environment with network restrictions, you need to check if the required ports are open, depending on the transport protocol used by the integration.
494493

495-
#### Requirements
496-
497494
The Elastic agent requires access to the following Azure services:
498495

499496
- Event Hubs
@@ -529,7 +526,7 @@ The Elastic agent requires access to the following Azure services:
529526

530527
By default, the integration uses AMQP to communicate with the event hub.
531528

532-
AMQP uses port `5671` and `5672` for secure communication with the event hub. These ports are used to receive events. By allowing traffic on these ports, the Elastic Agent can establish a secure connection with the event hub.
529+
AMQP uses port `5671` and `5672` for secure communication with the event hub. The Elastic Agent acts as a client and initiates **outbound TCP connections** to these ports on the Azure Event Hubs service. By allowing outgoing traffic to these ports, the Elastic Agent can establish a secure connection with the event hub to receive events.
533530

534531
For more information, check the following documents:
535532

@@ -540,11 +537,16 @@ For more information, check the following documents:
540537

541538
If ports 5671/5672 are blocked in your environment, the integration can use AMQP-over-WebSockets instead. This protocol tunnels AMQP over port 443 (HTTPS), which is typically allowed through firewalls.
542539

540+
##### Requirements
541+
542+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
543+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
544+
543545
To use AMQP-over-Websockets, set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" in the **Advanced options** section of the integration.
544546

545547
#### Storage Account
546548

547-
Port `443` is used for secure communication with the Storage Account service. This port is commonly used for HTTPS traffic. By allowing traffic on port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
549+
The Elastic Agent initiates **outbound TCP connections** to port `443` (HTTPS) to communicate with the Azure Storage Account service. By allowing outgoing traffic to port 443, the Elastic Agent can securely access and interact with the Storage Account service, which is essential for storing and retrieving checkpoint data for each event hub partition.
548550

549551
#### DNS
550552

@@ -562,8 +564,11 @@ When using AMQP-over-WebSockets, both Event Hubs and Storage Account traffic use
562564

563565
The integration supports proxying traffic to the Azure services using the `HTTPS_PROXY` environment variable.
564566

565-
**IMPORTANT**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
567+
##### Requirements
566568

569+
- **Transport protocol**: You need to set the **Event Hubs transport protocol** setting to "AMQP-over-WebSockets" when using a proxy.
570+
- **Elastic Agent version**: 8.17.6+, 8.18.3+, 8.19.0+ (or any 9.x version)
571+
- **Processor version**: You must set the `Processor version` to `v2` in the integration settings
567572

568573
## Settings
569574

0 commit comments

Comments
 (0)