Skip to content

[Synthetics] Add client certificate reference to docs#4351

Merged
emilioalvap merged 4 commits into
elastic:mainfrom
emilioalvap:synthetics-client-certificate-docs
Oct 15, 2024
Merged

[Synthetics] Add client certificate reference to docs#4351
emilioalvap merged 4 commits into
elastic:mainfrom
emilioalvap:synthetics-client-certificate-docs

Conversation

@emilioalvap

Copy link
Copy Markdown
Contributor

Description

Latest Synthetics version has added support for Playwright's clientCertificates option, which allows TLS client auth to be enabled for browser journeys. This option can be specified in project monitors or through the UI.

Documentation sets edited in this PR

Check all that apply.

  • Stateful (docs/en/observability/*)
  • Serverless (docs/en/serverless/*)
  • Integrations Developer Guide (docs/en/integrations/*)
  • None of the above

Related issue

Closes #4335.

Checklist

  • Product/Engineering Review
  • Writer Review

Follow-up tasks

Select one.

  • This PR does not need to be ported to another doc set because:
    • The concepts in this PR only apply to one doc set (serverless or stateful)
    • The PR contains edits to both doc sets (serverless and stateful)
  • This PR needs to be ported to another doc set:
    • Port to stateful docs: <link to PR or tracking issue>
    • Port to serverless docs: <link to PR or tracking issue>

@emilioalvap emilioalvap added needs-writer-review backport-8.x Automated backport to the 8.x branch with mergify labels Oct 4, 2024
@emilioalvap emilioalvap requested a review from a team as a code owner October 4, 2024 19:07
@github-actions

github-actions Bot commented Oct 4, 2024

Copy link
Copy Markdown
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Comment thread docs/en/observability/synthetics-configuration.asciidoc
@elasticdocs

elasticdocs commented Oct 10, 2024

Copy link
Copy Markdown

🚀 Built elastic-dot-co-docs-preview-docs successfully!

Issues? Visit #next-docs in Slack

Comment thread docs/en/observability/synthetics-configuration.asciidoc Outdated
Comment on lines +92 to +97
//////
[NOTE]
=====
Path-based options `{certPath, keyPath, pfxPath}` are only supported on Private Locations, defer to in-memory alternatives `{cert, key, pfx}` when running on locations hosted by Elastic.
=====
//////

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the notes supposed to be hidden? This note and the "tip" below are currently commented out (wrapped in //////).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, fixed that. I hadn't noticed when I copied the markdown from another section, thanks for pointing it out.

@colleenmcginnis would you happen to know why I can't see my changes in the preview URL?
Preview url: https://observability-docs_bk_4351.docs-preview.app.elstc.co/guide/en/observability/current/synthetics-configuration.html

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When you're targeting main, you're updating the master path (https://observability-docs_bk_4351.docs-preview.app.elstc.co/guide/en/observability/master/synthetics-configuration.html). You should be able to see your changes at that link. It can be added to current via a backport to 8.15 using the backport-8.15 label.

Comment thread docs/en/serverless/synthetics/synthetics-configuration.mdx Outdated
Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>

@colleenmcginnis colleenmcginnis left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@emilioalvap emilioalvap added the backport-8.15 Automated backport with mergify label Oct 14, 2024
@emilioalvap emilioalvap merged commit 9410c58 into elastic:main Oct 15, 2024
mergify Bot pushed a commit that referenced this pull request Oct 15, 2024
* [Synthetics] Add client certificate reference to docs

---------

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit 9410c58)

# Conflicts:
#	docs/en/serverless/synthetics/synthetics-configuration.mdx
mergify Bot pushed a commit that referenced this pull request Oct 15, 2024
* [Synthetics] Add client certificate reference to docs

---------

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit 9410c58)

# Conflicts:
#	docs/en/serverless/synthetics/synthetics-configuration.mdx
colleenmcginnis pushed a commit that referenced this pull request Oct 15, 2024
…o docs (#4368)

* [Synthetics] Add client certificate reference to docs (#4351)

* [Synthetics] Add client certificate reference to docs

---------

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit 9410c58)

# Conflicts:
#	docs/en/serverless/synthetics/synthetics-configuration.mdx

* Delete docs/en/serverless directory

---------

Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
colleenmcginnis pushed a commit that referenced this pull request Oct 15, 2024
…to docs (#4369)

* [Synthetics] Add client certificate reference to docs (#4351)

* [Synthetics] Add client certificate reference to docs

---------

Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com>
(cherry picked from commit 9410c58)

# Conflicts:
#	docs/en/serverless/synthetics/synthetics-configuration.mdx

* Delete docs/en/serverless directory

---------

Co-authored-by: Emilio Alvarez Piñeiro <95703246+emilioalvap@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-8.x Automated backport to the 8.x branch with mergify backport-8.15 Automated backport with mergify needs-writer-review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Request]: Document Private Certificates support for Synthetics browser monitors

4 participants