Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add TheHive connector to automated Observability case screenshots #193913

Merged
merged 14 commits into from
Nov 14, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Sep 24, 2024

Summary

Relates to #180931

This PR adds TheHive connector to the automated screenshot that is used in https://www.elastic.co/docs/current/serverless/observability/case-settings#create-a-connector

The screenshot automation for that page and for https://www.elastic.co/docs/current/serverless/security/cases-settings#external-incident-management-systems had been turned off per #188997 and #189058
I could not replicate those timeout errors, but I added retry.waitFor around any clicks since that's what seems to be done in https://github.com/elastic/kibana/blob/main/x-pack/test_serverless/functional/test_suites/security/ftr/cases/configure.ts

I have also removed one of the automated screenshots that is no longer required per elastic/security-docs#5859

Further updates were required related to #197041, which changes the location of the "Add connector" option within Case settings.

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs Feature:Cases Cases feature v8.16.0 backport:version Backport to applied version labels labels Sep 24, 2024
@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review September 24, 2024 21:33
@lcawl lcawl requested review from a team as code owners September 24, 2024 21:33
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops-cases (Feature:Cases)

@lcawl lcawl marked this pull request as ready for review September 26, 2024 20:26
Copy link
Contributor

@adcoelho adcoelho left a comment

Choose a reason for hiding this comment

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

LGTM but maybe we dont need all the retry.waitFor? The failing tests you linked were only about common-flyout-cancel.

@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl added v8.17.0 and removed v8.16.0 labels Nov 14, 2024
@lcawl
Copy link
Contributor Author

lcawl commented Nov 14, 2024

LGTM but maybe we dont need all the retry.waitFor? The failing tests you linked were only about common-flyout-cancel.

When I removed more of the retries, the screenshot generation started failing again, so I've left them for now.

Copy link
Contributor

@yngrdyn yngrdyn left a comment

Choose a reason for hiding this comment

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

Test changes LGTM

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@lcawl lcawl merged commit bdf62b6 into elastic:main Nov 14, 2024
21 checks passed
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11830312363

@lcawl lcawl deleted the case-screenshot-fixes branch November 14, 2024 03:41
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Nov 14, 2024
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.x

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Nov 14, 2024
…reenshots (#193913) (#200113)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Add TheHive connector to automated Observability case
screenshots (#193913)](#193913)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-11-14T03:40:55Z","message":"[DOCS]
Add TheHive connector to automated Observability case screenshots
(#193913)","sha":"bdf62b6b500f041d57a6ee74ddeee88138d42f26","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:ResponseOps","v9.0.0","docs","Feature:Cases","backport:version","v8.17.0"],"title":"[DOCS]
Add TheHive connector to automated Observability case
screenshots","number":193913,"url":"https://github.com/elastic/kibana/pull/193913","mergeCommit":{"message":"[DOCS]
Add TheHive connector to automated Observability case screenshots
(#193913)","sha":"bdf62b6b500f041d57a6ee74ddeee88138d42f26"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193913","number":193913,"mergeCommit":{"message":"[DOCS]
Add TheHive connector to automated Observability case screenshots
(#193913)","sha":"bdf62b6b500f041d57a6ee74ddeee88138d42f26"}},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:version Backport to applied version labels docs Feature:Cases Cases feature release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants