Skip to content

docs!(beyondinsight_password_safe): Refresh readme, move variable #15327

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 9 commits into from
Sep 16, 2025
Merged

docs!(beyondinsight_password_safe): Refresh readme, move variable #15327

merged 9 commits into from
Sep 16, 2025

Conversation

@andrewkroh
Copy link
Member

@andrewkroh andrewkroh commented Sep 16, 2025 •
edited
Loading

Proposed commit message

Follow the documentation guidelines from the developer docs and template structure from elastic-package. Cleanup some of the variable descriptions and add url_allowed_schemes to url variables. BREAKING: Move enable_request_tracer to the data stream level. https://www.elastic.co/docs/extend/integrations/documentation-guidelines https://github.com/elastic/elastic-package/blob/89b34ec09f562b2c1c921ba4b465b6ef96ea47de/internal/packages/archetype/_static/package-docs-readme.md.tmpl Closes #14985

Checklist

  • I have reviewed tips for building integrations and this pull request is aligned with them.
  • I have verified that all data streams collect metrics or logs.
  • I have added an entry to my package's changelog.yml file.
  • I have verified that Kibana version constraints are current according to guidelines.
  • I have verified that any added dashboard complies with Kibana's Dashboard good practices

Related issues

References

Screenshots

Screenshot 2025-09-15 at 21 17 01
Screenshot 2025-09-15 at 22 03 18
@andrewkroh andrewkroh force-pushed the beyondinsight_password_safe/readme-refresh branch from 52c5f73 to c49ae98 Compare September 16, 2025 01:09
@andrewkroh andrewkroh mentioned this pull request Sep 16, 2025
Closed
@andrewkroh andrewkroh added enhancement New feature or request documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. Integration:beyondinsight_password_safe BeyondInsight and Password Safe Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations] labels Sep 16, 2025
@andrewkroh andrewkroh marked this pull request as ready for review September 16, 2025 01:18
@andrewkroh andrewkroh requested a review from a team as a code owner September 16, 2025 01:18
@elasticmachine
Copy link

Pinging @elastic/security-service-integrations (Team:Security-Service Integrations)
@elastic-vault-github-plugin-prod
Copy link

🚀 Benchmarks report

To see the full report comment with /test benchmark fullreport
@andrewkroh
variable cleanup
f79cdc8 
BREAKING: Move enable_request_tracer to the data stream level. Cleanup some variable descriptions. Add url_allowed_schemes to urls type variables. Set a more concise title and description on the data streams.
@andrewkroh
add changelog
3873613
@andrewkroh andrewkroh force-pushed the beyondinsight_password_safe/readme-refresh branch from c49ae98 to 3873613 Compare September 16, 2025 02:08
@andrewkroh andrewkroh changed the title docs(beyondinsight_password_safe): Refresh readme docs!(beyondinsight_password_safe): Refresh readme, move variable Sep 16, 2025
efd6
efd6 approved these changes Sep 16, 2025
View reviewed changes
Copy link
Contributor

@efd6 efd6 left a comment

Choose a reason for hiding this comment

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

Suggestions/queries only.
packages/beyondinsight_password_safe/_dev/build/docs/README.md

## Data Streams
The BeyondInsight and Password Safe integration enables real-time monitoring of
privileged account access, session recordings, and password checkout patterns to
Copy link
Contributor

Choose a reason for hiding this comment

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

👍
packages/beyondinsight_password_safe/_dev/build/docs/README.md Outdated
The BeyondInsight and Password Safe integration enables real-time monitoring of
privileged account access, session recordings, and password checkout patterns to
help security teams maintain compliance and quickly identify potential privilege
abuse through BeyondTrust's Just-in-Time (JIT) privileged access management capabilities.
Copy link
Contributor

Choose a reason for hiding this comment

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

The "JIT" acronym is not referred to anywhere else. Does it need to be introduced here?
Copy link
Member Author

Choose a reason for hiding this comment

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

It is not necessary. ba3e75b
packages/beyondinsight_password_safe/data_stream/asset/manifest.yml Outdated
type: text
title: Interval
description: Data for all assets will be refetched at this interval.
description: Data for all assets will be refetched at this interval. The supported time units are "s", "m", "h".
Copy link
Contributor

Choose a reason for hiding this comment

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

Not specific for here, but it's always troubled me that we order these in ascending magnitude. Why? In colloquial English (in my dialect at least) this is not the conventional order.
Copy link
Member Author

Choose a reason for hiding this comment

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

cf0e96c

That does seem more natural.
packages/beyondinsight_password_safe/data_stream/useraudit/manifest.yml Outdated
show_user: false
default: "2160h"
description: How far back to pull BeyondInsight user audit events from the BeyondInsight user audit API(90 days). Supported units for this parameter are h/m/s.
description: How far back to pull BeyondInsight user audit events from the API. The supported time units are "s", "m", "h".
Copy link
Contributor

Choose a reason for hiding this comment

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

s/pull/collect/g?
Copy link
Member Author

Choose a reason for hiding this comment

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

ed2866e
@efd6
Copy link
Contributor

efd6 commented Sep 16, 2025 •
edited
Loading

… with the exception that the policy tests need to be examined/updated for the new locations.
@andrewkroh andrewkroh force-pushed the beyondinsight_password_safe/readme-refresh branch from 34a7fc0 to 742d81f Compare September 16, 2025 13:42
@andrewkroh
Copy link
Member Author

Policy tests were failing because I didn't move the enable_request_tracer variable in the test config. That is fixed now along with applying the same fix to the system tests.
@elasticmachine
Copy link

💚 Build Succeeded

History
@elastic-sonarqube
Copy link

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube
@andrewkroh andrewkroh merged commit 1251971 into elastic:main Sep 16, 2025
9 checks passed
@elastic-vault-github-plugin-prod
Copy link

Package beyondinsight_password_safe - 0.12.0 containing this change is available at https://epr.elastic.co/package/beyondinsight_password_safe/0.12.0/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

breaking change documentation Improvements or additions to documentation. Applied to PRs that modify *.md files. enhancement New feature or request Integration:beyondinsight_password_safe BeyondInsight and Password Safe Team:Security-Service Integrations Security Service Integrations team [elastic/security-service-integrations]

3 participants

@andrewkroh @elasticmachine @efd6