Skip to content

Commit 5ff777a

Browse files
Merge pull request #2994 from SEKOIA-IO/fix/align_https_doc_on_various_regions
fix/align_doc_on_various_regions
2 parents d64d0ca + c59fc91 commit 5ff777a

2 files changed

Lines changed: 55 additions & 19 deletions

File tree

_shared_content/automate/playbooks-on-premises.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,11 @@ To ensure a bug-free installation, the Sekoia Endpoint Agent must be able to com
7171
- minio-symphony.prod.sekoia.io
7272
- ...
7373
74+
!!! note
75+
The domains listed above apply to the **FRA1** region.
76+
For other regions, the agent will communicate with region-specific endpoints (e.g., `app.fra2.sekoia.io`, `api.fra2.sekoia.io` for FRA2 region).
77+
The required domains for your region are displayed during the playbook runner installation in the Sekoia.io interface.
78+
7479
### Testing the prerequisites
7580
7681
We've prepared a Docker image to facilitate the validation process and ensure the environment is properly configured for agent installation.
@@ -83,22 +88,24 @@ docker run ghcr.io/sekoia-io/hello-sekoia:latest
8388

8489
This command will initiate the image download, effectively verifying whether the host system can successfully access the Docker registry and establish connectivity with Sekoia.io.
8590

86-
Here's an example of the expected output for your reference:
91+
??? example "Example of the expected output (FRA1 region):"
8792

88-
```
89-
Checking container runs in Docker ... OK
90-
Checking connectivity with Sekoia.io APIs ...
91-
- Checking app.sekoia.io ... OK
92-
- Checking api.sekoia.io ... OK
93-
Checking connectivity with the object storage ... OK
94-
```
93+
```
94+
Checking container runs in Docker ... OK
95+
Checking connectivity with Sekoia.io APIs ...
96+
- Checking app.sekoia.io ... OK
97+
- Checking api.sekoia.io ... OK
98+
Checking connectivity with the object storage ... OK
99+
```
95100

96101
!!! tip
97102
The `-e` option can be passed to the docker command to specify:
98103

99-
* The region: `-e region=mco1`
100-
* Proxy information: `-e https_proxy={proxy_url}`
104+
* The region: `-e region=<region>` (e.g., `-e region=mco1` for MCO1 region)
105+
* Proxy information: `-e https_proxy=<proxy_url>`
101106

107+
!!! tip
108+
Learn more about region and code in [our dedicated article](/getting_started/regions.md).
102109

103110
## Playbook runners
104111

@@ -120,7 +127,10 @@ To create a playbook runner, follow these steps:
120127
Your newly created playbook runner should now appear in the list. It will also be shown when configuring any playbook action.
121128

122129
!!! tip
123-
To specify a region when installing the runner, the `--region` argument can be added to the command.
130+
To specify a region when installing the runner, add the `--region` argument to the installation command.
131+
132+
!!! tip
133+
Learn more about region and code in [our dedicated article](/getting_started/regions.md).
124134

125135
### Use a runner in a playbook action
126136

docs/integration/ingestion_methods/https/format.md

Lines changed: 34 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,52 @@
11
# Formatting options
22

3-
To forward logs to Sekoia.io, several options format are available:
3+
To forward logs to Sekoia.io, several formatting options are available:
44

55
- Send your events as line-oriented records
66
- Send your events as a JSON object
77
- Send your events as a structured payload
88

9-
For each option, we will have to supply an intake key. The collector endpoint of Sekoia.io will provide event identifiers within the Sekoia.io detection workflow in the form of a JSON payload.
9+
For each option, we have to supply an intake key. The collector endpoint of Sekoia.io will provide event identifiers within the Sekoia.io detection workflow in the form of a JSON payload.
10+
11+
## Select the intake endpoint for your region
12+
13+
Sekoia.io supports multiple regions for HTTP ingestion.
14+
15+
FRA1 keeps the historical URL scheme, while all other regions use the new API-prefixed scheme.
16+
17+
!!! tip
18+
Learn more about region and code in [our dedicated article](/getting_started/regions.md).
19+
20+
Endpoints must be built from regional base URLs:
21+
22+
- FRA1 base URL: `https://intake.sekoia.io`
23+
- Other regions base URL: `https://intake.<region>.sekoia.io/api/v1/intake-http`
24+
25+
Then append the path `/<path>` (e.g., `/plain`, `/plain/batch`, `/jsons`, `/batch`, `/array`, etc.) to the corresponding regional base URL.
26+
27+
Examples:
28+
29+
- `https://intake.sekoia.io/batch`
30+
- `https://intake.fra2.sekoia.io/api/v1/intake-http/batch`
31+
- `https://intake.mco1.sekoia.io/api/v1/intake-http/jsons`
32+
- `https://intake.uae1.sekoia.io/api/v1/intake-http/plain/batch`
33+
34+
!!! warning
35+
The examples below use FRA1 URLs for readability. For other regions, replace the base URL with your regional endpoint.
1036

1137
## Push our events to Sekoia.io as line-oriented records
1238

1339
To forward events as plain records, you can use the `/plain` endpoint.
1440

15-
The following headers are handled by Sekoia.io’S HTTPS log collector:
41+
The following headers are handled by Sekoia.io's HTTPS log collector:
1642

1743
| Header | Mandatory? | Type | Description |
1844
|------------------------------|------------|----------|----------------------------------------------------------------------------------------|
1945
| `X-SEKOIAIO-INTAKE-KEY` | No | String | Intake to which you would like to push events to |
2046
| `X-SEKOIAIO-EVENT-TIMESTAMP` | No | Datetime | Event date if you want to push your own date (fallback is to use the reception’s date) |
2147

2248

23-
Supply the intake key as the header `X-SEKOIAIO-INTAKE-KEY`, as password in the HTTP Basic authentication mechanism or as a parameter in the querystring.
49+
Supply the intake key as the header `X-SEKOIAIO-INTAKE-KEY`, as password in the HTTP Basic authentication mechanism, or as a parameter in the query string.
2450

2551
To push one event, just POST content to `https://intake.sekoia.io/plain`
2652

@@ -121,15 +147,15 @@ curl -X POST -H "X-SEKOIAIO-INTAKE-KEY: REPLACE_BY_INTAKE_KEY" --data-binary @ev
121147

122148
To send us events as a JSON list, you should set `Content-Type` HTTP header to `application/json`.
123149

124-
The following headers are handled by Sekoia.io’S HTTPS log collector:
150+
The following headers are handled by Sekoia.io's HTTPS log collector:
125151

126152
| Header | Mandatory? | Type | Description |
127153
|------------------------------|------------|----------|----------------------------------------------------------------------------------------|
128154
| `X-SEKOIAIO-INTAKE-KEY` | No | String | Intake to which you would like to push events to |
129155
| `X-SEKOIAIO-EVENT-TIMESTAMP` | No | Datetime | Event date if you want to push your own date (fallback is to use the reception’s date) |
130156

131157

132-
Supply the intake key as the header `X-SEKOIAIO-INTAKE-KEY`, as password in the HTTP Basic authentication mechanism or as a parameter in the querystring.
158+
Supply the intake key as the header `X-SEKOIAIO-INTAKE-KEY`, as password in the HTTP Basic authentication mechanism, or as a parameter in the query string.
133159

134160
Use the endpoint `/jsons`. This endpoint accepts a set of events:
135161

@@ -223,11 +249,11 @@ If your events are enclosed in a JSON object, use the endpoint `/jsons` and prov
223249

224250
To send us events, you should set `Content-Type` HTTP header to `application/json`.
225251

226-
The following fields are currently handled by Sekoia.io’S HTTPS log collector:
252+
The following fields are currently handled by Sekoia.io's HTTPS log collector:
227253

228254
| Field | Mandatory? | Type | Description |
229255
|---------------|------------|----------|--------------------------------------------------------------------------------------------------------|
230-
| `intakey_key` | Yes | String | Intake to which you would like to push events to |
256+
| `intake_key` | Yes | String | Intake to which you would like to push events to |
231257
| `json` | Yes | String | The actual log payload. If you want to push structured JSON logs, please send them as quoted JSON here |
232258
| `@timestamp` | No | Datetime | Event date if you want to push your own date (fallback is to use the reception’s date) |
233259

0 commit comments

Comments
 (0)