Closes #156023 ## Summary ESO = Encrypted Saved Object(s) This PR modifies the `EncryptedSavedObjectTypeRegistration` definition, replacing the `attributesToExcludeFromAAD` property with a `attributesToIncludeInAAD` property. The purpose is to alter the default inclusion of new SO attributes, which will help to resolve potential decryption issues with serverless zero downtime upgrades (see https://github.com/elastic/kibana/issues/156023). NOTE: nested fields are included when the parent field is added to the include list. In this way the include list behaves just as the exclude list did. #### Attention Code Owners: I attempted to create the include list for existing ESOs by comparing the exclude list to the full list of attributes, ~~however, I am sure this is either incomplete or partially incorrect~~ UPDATE: new tests have been created to validate the include list (see the **Testing** section). These changes will need to be carefully audited by the owning teams during the review process. This PR will not merge until all code owners have reviewed and approved the changes. If your team is a consumer of ESOs, please see the **Testing** section below. ## Testing Automated test suites have been updated to account for the changes to ESO registration. The riskier part of this PR are the changes to existing ESOs, and validating that they are effectively identical to their previous implementations. I have used main branch Kibana to generate several ESOs - one of each type, then saved those raw encrypted objects to an esArchiver JSON file. New functional tests, in the `encrypted_saved_objects_api_integration` suite, have been created to verify that those objects can be successfully decrypted using the new ESO definitions containing the AAD include list. ### ESO Types to Validate See `x-pack/test/encrypted_saved_objects_api_integration/tests/encrypted_saved_objects_aad_include_list.ts` - [x] ACTION_SAVED_OBJECT_TYPE/'action' - [x] ACTION_TASK_PARAMS_SAVED_OBJECT_TYPE/'action_task_params' - [x] CONNECTOR_TOKEN_SAVED_OBJECT_TYPE/'connector_token' - [x] RULE_SAVED_OBJECT_TYPE/'alert' - [x] 'api_key_pending_invalidation' - [x] OUTPUT_SAVED_OBJECT_TYPE/'ingest-outputs - [x] MESSAGE_SIGNING_KEYS_SAVED_OBJECT_TYPE/'fleet-message-signing-keys - [x] UNINSTALL_TOKENS_SAVED_OBJECT_TYPE/'fleet-uninstall-tokens' - [x] syntheticsApiKeyObjectType/'uptime-synthetics-api-key' - [x] syntheticsMonitorType/'synthetics-monitor' - [x] syntheticsParamType/'synthetics-param' ### Flaky Test Runner https://buildkite.com/elastic/kibana-flaky-test-suite-runner/builds/5419 --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com> |
||
---|---|---|
.buildkite | ||
.github | ||
api_docs | ||
config | ||
dev_docs | ||
docs | ||
examples | ||
kbn_pm | ||
legacy_rfcs | ||
licenses | ||
packages | ||
plugins | ||
scripts | ||
src | ||
test | ||
typings | ||
x-pack | ||
.backportrc.json | ||
.bazelignore | ||
.bazeliskversion | ||
.bazelrc | ||
.bazelrc.common | ||
.bazelversion | ||
.browserslistrc | ||
.editorconfig | ||
.eslintignore | ||
.eslintrc.js | ||
.gitattributes | ||
.gitignore | ||
.i18nrc.json | ||
.node-version | ||
.npmrc | ||
.nvmrc | ||
.prettierignore | ||
.prettierrc | ||
.stylelintignore | ||
.stylelintrc | ||
.telemetryrc.json | ||
.yarnrc | ||
BUILD.bazel | ||
catalog-info.yaml | ||
CODE_OF_CONDUCT.md | ||
CONTRIBUTING.md | ||
FAQ.md | ||
fleet_packages.json | ||
github_checks_reporter.json | ||
kibana.d.ts | ||
LICENSE.txt | ||
nav-kibana-dev.docnav.json | ||
NOTICE.txt | ||
package.json | ||
preinstall_check.js | ||
README.md | ||
renovate.json | ||
RISK_MATRIX.mdx | ||
SECURITY.md | ||
sonar-project.properties | ||
STYLEGUIDE.mdx | ||
tsconfig.base.json | ||
tsconfig.browser.json | ||
tsconfig.browser_bazel.json | ||
tsconfig.json | ||
TYPESCRIPT.md | ||
versions.json | ||
WORKSPACE.bazel | ||
yarn.lock |
Kibana
Kibana is your window into the Elastic Stack. Specifically, it's a browser-based analytics and search dashboard for Elasticsearch.
- Getting Started
- Documentation
- Version Compatibility with Elasticsearch
- Questions? Problems? Suggestions?
Getting Started
If you just want to try Kibana out, check out the Elastic Stack Getting Started Page to give it a whirl.
If you're interested in diving a bit deeper and getting a taste of Kibana's capabilities, head over to the Kibana Getting Started Page.
Using a Kibana Release
If you want to use a Kibana release in production, give it a test run, or just play around:
- Download the latest version on the Kibana Download Page.
- Learn more about Kibana's features and capabilities on the Kibana Product Page.
- We also offer a hosted version of Kibana on our Cloud Service.
Building and Running Kibana, and/or Contributing Code
You might want to build Kibana locally to contribute some code, test out the latest features, or try out an open PR:
- CONTRIBUTING.md will help you get Kibana up and running.
- If you would like to contribute code, please follow our STYLEGUIDE.mdx.
- For all other questions, check out the FAQ.md and wiki.
Documentation
Visit Elastic.co for the full Kibana documentation.
For information about building the documentation, see the README in elastic/docs.
Version Compatibility with Elasticsearch
Ideally, you should be running Elasticsearch and Kibana with matching version numbers. If your Elasticsearch has an older version number or a newer major number than Kibana, then Kibana will fail to run. If Elasticsearch has a newer minor or patch number than Kibana, then the Kibana Server will log a warning.
Note: The version numbers below are only examples, meant to illustrate the relationships between different types of version numbers.
Situation | Example Kibana version | Example ES version | Outcome |
---|---|---|---|
Versions are the same. | 7.15.1 | 7.15.1 | 💚 OK |
ES patch number is newer. | 7.15.0 | 7.15.1 | ⚠️ Logged warning |
ES minor number is newer. | 7.14.2 | 7.15.0 | ⚠️ Logged warning |
ES major number is newer. | 7.15.1 | 8.0.0 | 🚫 Fatal error |
ES patch number is older. | 7.15.1 | 7.15.0 | ⚠️ Logged warning |
ES minor number is older. | 7.15.1 | 7.14.2 | 🚫 Fatal error |
ES major number is older. | 8.0.0 | 7.15.1 | 🚫 Fatal error |
Questions? Problems? Suggestions?
- If you've found a bug or want to request a feature, please create a GitHub Issue. Please check to make sure someone else hasn't already created an issue for the same topic.
- Need help using Kibana? Ask away on our Kibana Discuss Forum and a fellow community member or Elastic engineer will be glad to help you out.