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 cross-link for other encryption key settings #165014

Merged
merged 3 commits into from
Aug 28, 2023
Merged

[DOCS] Add cross-link for other encryption key settings #165014

merged 3 commits into from
Aug 28, 2023

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Aug 28, 2023

Summary

Problem: The Configure security in Kibana docs page only covers the xpack.security.encryptionKey setting for session encryption. Users may not know that encryption for Kibana's reporting and saved objects features also require encryption keys.

Solution: Add a cross-link to the respective encryption key settings for reporting and saved objects

Preview

Closes #134513

@jrodewig jrodewig added Team:Docs (Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead Feature:Saved Objects docs Feature:Security/Session Management Platform Security - Session Management v8.10.0 v8.11.0 v8.9.2 labels Aug 28, 2023
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@jrodewig jrodewig requested a review from legrego August 28, 2023 16:34
@github-actions
Copy link

Documentation preview:

@jrodewig jrodewig added the release_note:skip Skip the PR/issue when compiling release notes label Aug 28, 2023
Copy link
Contributor

@jeramysoucy jeramysoucy left a comment

Choose a reason for hiding this comment

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

LGTM!

@jrodewig jrodewig merged commit 8ac82e3 into elastic:main Aug 28, 2023
5 checks passed
@jrodewig jrodewig deleted the add-encryption-key-crosslink branch August 28, 2023 19:02
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 28, 2023
Problem: The [Configure security in Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html) docs page only covers the `xpack.security.encryptionKey` setting for session encryption. Users may not know that encryption for Kibana's reporting and saved objects features also require encryption keys.

Solution: Add a cross-link to the respective encryption key settings for  reporting and saved objects
(cherry picked from commit 8ac82e3)
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Aug 28, 2023
Problem: The [Configure security in Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html) docs page only covers the `xpack.security.encryptionKey` setting for session encryption. Users may not know that encryption for Kibana's reporting and saved objects features also require encryption keys.

Solution: Add a cross-link to the respective encryption key settings for  reporting and saved objects
(cherry picked from commit 8ac82e3)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.10
8.9

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 Aug 28, 2023
…) (#165034)

# Backport

This will backport the following commits from `main` to `8.10`:
- [[DOCS] Add cross-link for other encryption key settings
(#165014)](#165014)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"James
Rodewig","email":"james.rodewig@elastic.co"},"sourceCommit":{"committedDate":"2023-08-28T19:02:22Z","message":"[DOCS]
Add cross-link for other encryption key settings (#165014)\n\nProblem:
The [Configure security in
Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html)
docs page only covers the `xpack.security.encryptionKey` setting for
session encryption. Users may not know that encryption for Kibana's
reporting and saved objects features also require encryption
keys.\r\n\r\nSolution: Add a cross-link to the respective encryption key
settings for reporting and saved
objects","sha":"8ac82e38d79c0031d76de472d1b1e0f2f7b9fef2","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Feature:Reporting","Feature:Saved
Objects","release_note:skip","docs","Feature:Security/Session
Management","v8.10.0","v8.11.0","v8.9.2"],"number":165014,"url":"https://github.com/elastic/kibana/pull/165014","mergeCommit":{"message":"[DOCS]
Add cross-link for other encryption key settings (#165014)\n\nProblem:
The [Configure security in
Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html)
docs page only covers the `xpack.security.encryptionKey` setting for
session encryption. Users may not know that encryption for Kibana's
reporting and saved objects features also require encryption
keys.\r\n\r\nSolution: Add a cross-link to the respective encryption key
settings for reporting and saved
objects","sha":"8ac82e38d79c0031d76de472d1b1e0f2f7b9fef2"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.9"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/165014","number":165014,"mergeCommit":{"message":"[DOCS]
Add cross-link for other encryption key settings (#165014)\n\nProblem:
The [Configure security in
Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html)
docs page only covers the `xpack.security.encryptionKey` setting for
session encryption. Users may not know that encryption for Kibana's
reporting and saved objects features also require encryption
keys.\r\n\r\nSolution: Add a cross-link to the respective encryption key
settings for reporting and saved
objects","sha":"8ac82e38d79c0031d76de472d1b1e0f2f7b9fef2"}},{"branch":"8.9","label":"v8.9.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
kibanamachine added a commit that referenced this pull request Aug 28, 2023
… (#165035)

# Backport

This will backport the following commits from `main` to `8.9`:
- [[DOCS] Add cross-link for other encryption key settings
(#165014)](#165014)

<!--- Backport version: 8.9.7 -->

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

<!--BACKPORT [{"author":{"name":"James
Rodewig","email":"james.rodewig@elastic.co"},"sourceCommit":{"committedDate":"2023-08-28T19:02:22Z","message":"[DOCS]
Add cross-link for other encryption key settings (#165014)\n\nProblem:
The [Configure security in
Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html)
docs page only covers the `xpack.security.encryptionKey` setting for
session encryption. Users may not know that encryption for Kibana's
reporting and saved objects features also require encryption
keys.\r\n\r\nSolution: Add a cross-link to the respective encryption key
settings for reporting and saved
objects","sha":"8ac82e38d79c0031d76de472d1b1e0f2f7b9fef2","branchLabelMapping":{"^v8.11.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Feature:Reporting","Feature:Saved
Objects","release_note:skip","docs","Feature:Security/Session
Management","v8.10.0","v8.11.0","v8.9.2"],"number":165014,"url":"https://github.com/elastic/kibana/pull/165014","mergeCommit":{"message":"[DOCS]
Add cross-link for other encryption key settings (#165014)\n\nProblem:
The [Configure security in
Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html)
docs page only covers the `xpack.security.encryptionKey` setting for
session encryption. Users may not know that encryption for Kibana's
reporting and saved objects features also require encryption
keys.\r\n\r\nSolution: Add a cross-link to the respective encryption key
settings for reporting and saved
objects","sha":"8ac82e38d79c0031d76de472d1b1e0f2f7b9fef2"}},"sourceBranch":"main","suggestedTargetBranches":["8.10","8.9"],"targetPullRequestStates":[{"branch":"8.10","label":"v8.10.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.11.0","labelRegex":"^v8.11.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/165014","number":165014,"mergeCommit":{"message":"[DOCS]
Add cross-link for other encryption key settings (#165014)\n\nProblem:
The [Configure security in
Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html)
docs page only covers the `xpack.security.encryptionKey` setting for
session encryption. Users may not know that encryption for Kibana's
reporting and saved objects features also require encryption
keys.\r\n\r\nSolution: Add a cross-link to the respective encryption key
settings for reporting and saved
objects","sha":"8ac82e38d79c0031d76de472d1b1e0f2f7b9fef2"}},{"branch":"8.9","label":"v8.9.2","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: James Rodewig <james.rodewig@elastic.co>
jloleysens added a commit to jloleysens/kibana that referenced this pull request Aug 29, 2023
* main: (40 commits)
  Adjust migrations and elasticsearch service settings for serverless. (elastic#165050)
  [Security Solution] expandable flyout - add investigate in timeline f… (elastic#165025)
  [SecuritySolution] Hide create dashboard button from listing (elastic#164476)
  Construct HTTP log message only if needed (elastic#165057)
  [Security Solution] expandable flyout - add no data message in entities details and entities overview components (elastic#164955)
  Add functional tests for serverless security management UIs (elastic#164886)
  [api-docs] 2023-08-29 Daily api_docs build (elastic#165056)
  [Cloud Security][CIS GCP]cis gcp now use updated gcp field name + small last minute changes (elastic#164792)
  [Security Solution] Expandable flyout - update risk classification ui in entities overview (elastic#165022)
  [Security Solution] Fixes Preconfigured Connectors not working with Assistant (elastic#164900)
  [Security Solution] Coverage Overview follow-up 2 (elastic#164986)
  [DOCS] Add cross-link for other encryption key settings (elastic#165014)
  chore(slo): general enhancement (elastic#164723)
  Revert "[SOR] Allow optionally downgrading documents with a higher version model in API READ methods" (elastic#164991)
  [OAS] Add more Elasticsearch query rule examples (elastic#164386)
  [security_solution_cypress] Add support for options in EsArchiver.load (elastic#164988)
  [Event Log] Skip setting assets to hidden in serverless (elastic#164767)
  remove unneeded usages of isErrorResponse (elastic#164609)
  [Enterprise Search] Make network drive connector platinum (elastic#165007)
  [RAM] update api key to become public (elastic#164883)
  ...
bryce-b pushed a commit to bryce-b/kibana that referenced this pull request Sep 19, 2023
Problem: The [Configure security in Kibana](https://www.elastic.co/guide/en/kibana/current/using-kibana-with-security.html) docs page only covers the `xpack.security.encryptionKey` setting for session encryption. Users may not know that encryption for Kibana's reporting and saved objects features also require encryption keys.

Solution: Add a cross-link to the respective encryption key settings for  reporting and saved objects
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
(Deprecated) Feature:Reporting Use Reporting:Screenshot, Reporting:CSV, or Reporting:Framework instead docs Feature:Saved Objects Feature:Security/Session Management Platform Security - Session Management release_note:skip Skip the PR/issue when compiling release notes Team:Docs v8.9.2 v8.10.0 v8.11.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Please add missing "xpack.reporting.encryptionKey" setting to "Security settings in Kibana" doc page
4 participants