Skip to content

Commit 35624c1

Browse files
emilioalvapmdbirnstiehl
authored andcommitted
[Synthetics] Add proxy settings docs (elastic#3380)
### Summary Add proxy settings to synthetics cli docs --------- Co-authored-by: Mike Birnstiehl <[email protected]>
1 parent b91d8e5 commit 35624c1

File tree

2 files changed

+56
-1
lines changed

2 files changed

+56
-1
lines changed

solutions/observability/synthetics/cli.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -186,6 +186,26 @@ If the journey contains external NPM packages other than the `@elastic/synthetic
186186
* If you `push` a Synthetics project that used to contain one or more monitors but no longer contains any monitors, all monitors associated with the Synthetics project ID being pushed will be deleted.
187187
* If you `push` a Synthetics project that’s already been pushed using one Synthetics project ID and then try to `push` it using a *different* ID, it will create duplicates of all monitors in the Synthetics project.
188188

189+
`--proxy-uri`
190+
: The proxy URL to be used when connecting to Kibana on your deployment or Observability Serverless project.
191+
192+
This can also be set in the configuration file using [`proxy.uri` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
193+
194+
`--proxy-token`
195+
: (Optional) The authentication token to be used when connecting to the proxy URL. Based on auth header format `Basic Asaaas==`
196+
197+
This can also be set in the configuration file using [`proxy.token` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
198+
199+
`--proxy-ca`
200+
: (Optional) Override the trusted CA certificates for the proxy connection.
201+
202+
This can also be set in the configuration file using [`proxy.ca` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
203+
204+
`--proxy-no-verify`
205+
: (Optional) Disable TLS verification for the proxy connection.
206+
207+
This can also be set in the configuration file using [`proxy.noVerify` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
208+
189209
## Tag monitors [tagging-and-filtering]
190210

191211
Synthetics journeys can be tagged with one or more tags. Use tags to filter journeys when running tests locally or pushing them to Elastic.
@@ -251,6 +271,27 @@ To list both locations on Elastic’s global managed infrastructure and {{privat
251271
`--auth <string>`
252272
: API key used for [authentication](/deploy-manage/api-keys/elasticsearch-api-keys.md).
253273

274+
`--proxy-uri`
275+
: The proxy URL to be used when connecting to Kibana on your deployment or Observability Serverless project.
276+
277+
This can also be set in the configuration file using [`proxy.uri` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
278+
279+
`--proxy-token`
280+
: (Optional) The authentication token to be used when connecting to the proxy URL. Based on auth header format `Basic Asaaas==`
281+
282+
This can also be set in the configuration file using [`proxy.token` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
283+
284+
`--proxy-ca`
285+
: (Optional) Override the trusted CA certificates for the proxy connection.
286+
287+
This can also be set in the configuration file using [`proxy.ca` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
288+
289+
`--proxy-no-verify`
290+
: (Optional) Disable TLS verification for the proxy connection.
291+
292+
This can also be set in the configuration file using [`proxy.noVerify` in the configuration file](/solutions/observability/synthetics/configure-projects.md#synthetics-configuration-proxy). The value defined via the CLI will take precedence.
293+
294+
254295
::::{note}
255296
If an administrator has disabled Elastic managed locations for the role you are assigned and you do *not* include `--url` and `--auth`, all global locations managed by Elastic will be listed. However, you will not be able to push to these locations with your API key and will see an error: *You don’t have permission to use Elastic managed global locations*. For more details, refer to the [troubleshooting docs](/troubleshoot/observability/troubleshooting-synthetics.md#synthetics-troubleshooting-public-locations-disabled).
256297
::::

solutions/observability/synthetics/configure-projects.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,4 +284,18 @@ $$$synthetics-configuration-monitor-tags$$$ `tags` (`Array<string>`)
284284
For information on configuring monitors individually, refer to:
285285

286286
* [Configure individual browser monitors](/solutions/observability/synthetics/configure-individual-browser-monitors.md) for browser monitors
287-
* [Configure lightweight monitors](/solutions/observability/synthetics/configure-lightweight-monitors.md) for lightweight monitors
287+
* [Configure lightweight monitors](/solutions/observability/synthetics/configure-lightweight-monitors.md) for lightweight monitors
288+
289+
## `proxy` [synthetics-configuration-proxy]
290+
291+
`uri` (`string`)
292+
: The Proxy URL to be used when connecting to the deployment or Observability Serverless project.
293+
294+
`token` (`string`)
295+
: (Optional) The authentication token to be used when connecting to the proxy URL. Based on auth header format `Basic Asaaas==`
296+
297+
`ca` (`string | Buffer`)
298+
: (Optional) Override the trusted CA certificates for the proxy connection.
299+
300+
`noVerify` (`boolean`)
301+
: (Optional) Disable TLS verification for the proxy connection.

0 commit comments

Comments
 (0)