Skip to content

Commit

Permalink
Merge branch 'main' into perf-uptime-overview
Browse files Browse the repository at this point in the history
  • Loading branch information
shahzad31 authored Aug 29, 2024
2 parents 60524d1 + 55781b7 commit b8fc7da
Show file tree
Hide file tree
Showing 167 changed files with 1,977 additions and 416 deletions.
4 changes: 2 additions & 2 deletions docs/api/dashboard-api.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[dashboard-api]]
== Import and export dashboard APIs

deprecated::[7.15.0,Both of these APIs have been deprecated in favor of the {api-kibana}/group/endpoint-saved-objects[saved objects API].]
deprecated::[7.15.0,Both of these APIs have been deprecated and will be removed in 9.0.0]

Import and export dashboards with the corresponding saved objects, such as visualizations, saved
searches, and data views.
Expand All @@ -16,4 +16,4 @@ The following import and export dashboard APIs are available:
* <<dashboard-api-export, Export dashboard API>> to export dashboards and corresponding saved objects

include::dashboard/import-dashboard.asciidoc[]
include::dashboard/export-dashboard.asciidoc[]
include::dashboard/export-dashboard.asciidoc[]
2 changes: 0 additions & 2 deletions docs/api/data-views.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,3 @@ For the latest details, refer to {api-kibana}/group/endpoint-data-views[data vie
WARNING: Do not write documents directly to the `.kibana` index. When you write directly
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.

WARNING: Use the data views APIs for managing data views instead of lower-level <<saved-objects-api, saved objects API>>.

2 changes: 1 addition & 1 deletion docs/api/osquery-manager.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

experimental[] Run live queries, manage packs and saved queries

WARNING: Use the osquery manager APIs for managing packs and saved queries instead of lower-level <<saved-objects-api, saved objects API>>.
Use the osquery manager APIs for managing packs and saved queries.

The following osquery manager APIs are available:

Expand Down
7 changes: 1 addition & 6 deletions docs/api/saved-objects.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
[[saved-objects-api]]
== Saved objects APIs

Manage {kib} saved objects, including dashboards, visualizations, and more.

For the latest details, refer to the {api-kibana}/group/endpoint-saved-objects[saved object API].

WARNING: Do not write documents directly to the `.kibana` index. When you write directly
to the `.kibana` index, the data becomes corrupted and permanently breaks future {kib} versions.
For the latest details, refer to the {api-kibana}/group/endpoint-saved-objects[saved objects API].
9 changes: 8 additions & 1 deletion docs/api/short-urls.asciidoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
[[short-urls-api]]
== Short URLs APIs

Manage {kib} short URLs.
experimental[] Manage {kib} short URLs.

The following short urls APIs are available:

* <<short-urls-api-create, Create short URL API>>
* <<short-urls-api-get, Get short URL API>>
* <<short-urls-api-delete, Delete short URL API>>
* <<short-urls-api-resolve, Resolve short URL API>>

include::short-urls/create-short-url.asciidoc[]
include::short-urls/get-short-url.asciidoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ Tests should run at the positive security boundary condition, meaning that they

The functional UI tests now default to logging in with a user named `test_user` and the roles of this user can be changed dynamically without logging in and out.

In order to achieve this a new service was introduced called `createTestUserService` (see `packages/kbn-ftr-common-functional-ui-services/services/security/test_user.ts`). The purpose of this test user service is to create roles defined in the test config files and setRoles() or restoreDefaults().
In order to achieve this a new service was introduced called `createTestUserService` (see `test/common/services/security/test_user.ts`). The purpose of this test user service is to create roles defined in the test config files and setRoles() or restoreDefaults().

An example of how to set the role like how its defined below:

Expand Down Expand Up @@ -366,22 +366,22 @@ await testSubjects.click(‘containerButton’);
** `find.allByCssSelector()`

**retry:**:::
// * Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/retry/retry.ts[packages/kbn-ftr-common-functional-services/services/retry/retry.ts]
// * Source: {kibana-blob}test/common/services/retry/retry.ts[test/common/services/retry/retry.ts]
* Helpers for retrying operations
* Popular methods:
** `retry.try(fn, onFailureBlock)` - Execute `fn` in a loop until it succeeds or the default timeout elapses. The optional `onFailureBlock` is executed before each retry attempt.
** `retry.tryForTime(ms, fn, onFailureBlock)` - Execute `fn` in a loop until it succeeds or `ms` milliseconds elapses. The optional `onFailureBlock` is executed before each retry attempt.

**kibanaServer:**:::
// * Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts[packages/kbn-ftr-common-functional-services/services/kibana_server/kibana_server.ts]
// * Source: {kibana-blob}test/common/services/kibana_server/kibana_server.js[test/common/services/kibana_server/kibana_server.js]
* Helpers for interacting with {kib}'s server
* Commonly used methods:
** `kibanaServer.uiSettings.update()`
** `kibanaServer.version.get()`
** `kibanaServer.status.getOverallState()`

**esArchiver:**:::
// * Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/es_archiver.ts[packages/kbn-ftr-common-functional-services/services/es_archiver.ts]
// * Source: {kibana-blob}test/common/services/es_archiver.ts[test/common/services/es_archiver.ts]
* Load/unload archives created with the `esArchiver`
* Popular methods:
** `esArchiver.load(path)`
Expand All @@ -393,7 +393,7 @@ Full list of services that are used in functional tests can be found here: {kiba

**Low-level utilities:**:::
* es
// ** Source: {kibana-blob}packages/kbn-ftr-common-functional-services/services/es.ts[packages/kbn-ftr-common-functional-services/services/es.ts]
// ** Source: {kibana-blob}test/common/services/es.ts[test/common/services/es.ts]
** {es} client
** Higher level options: `kibanaServer.uiSettings` or `esArchiver`
* remote
Expand Down
21 changes: 18 additions & 3 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19031,10 +19031,25 @@ tags:
- name: Fleet uninstall tokens
- description: Machine learning
name: ml
- description: >-
Manage Kibana saved objects, including dashboards, visualizations, and
more.
- description: >
Export sets of saved objects that you want to import into {kib}, resolve
import errors, and rotate an encryption key for encrypted saved objects
with the saved objects APIs.


To manage a specific type of saved object, use the corresponding APIs.

For example, use:


[Data views](../group/endpoint-data-views)


Warning: Do not write documents directly to the `.kibana` index. When you
write directly to the `.kibana` index, the data becomes corrupted and
permanently breaks future Kibana versions.
name: saved objects
x-displayName: Saved objects
- description: 'SLO APIs enable you to define, manage and track service-level objectives'
name: slo
- name: system
26 changes: 23 additions & 3 deletions oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27592,10 +27592,30 @@ tags:
- name: Fleet uninstall tokens
- description: Machine learning
name: ml
- description: >-
Manage Kibana saved objects, including dashboards, visualizations, and
more.
- description: >
Export sets of saved objects that you want to import into {kib}, resolve
import errors, and rotate an encryption key for encrypted saved objects
with the saved objects APIs.


To manage a specific type of saved object, use the corresponding APIs.

For example, use:


* [Data views](../group/endpoint-data-views)

* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)

* [Short
URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)


Warning: Do not write documents directly to the `.kibana` index. When you
write directly to the `.kibana` index, the data becomes corrupted and
permanently breaks future Kibana versions.
name: saved objects
x-displayName: Saved objects
- description: 'SLO APIs enable you to define, manage and track service-level objectives'
name: slo
- name: system
4 changes: 0 additions & 4 deletions oas_docs/overlays/kibana.overlays.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,6 @@ actions:
description: Change displayName
update:
x-displayName: "Machine learning"
- target: '$.tags[?(@.name=="saved objects")]'
description: Change displayName
update:
x-displayName: "Saved objects"
- target: '$.tags[?(@.name=="slo")]'
description: Change displayName
update:
Expand Down
4 changes: 0 additions & 4 deletions oas_docs/overlays/kibana.overlays.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,6 @@ actions:
description: Change displayName
update:
x-displayName: "Machine learning"
- target: '$.tags[?(@.name=="saved objects")]'
description: Change displayName
update:
x-displayName: "Saved objects"
- target: '$.tags[?(@.name=="slo")]'
description: Change displayName
update:
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -1651,7 +1651,7 @@
"buildkite-test-collector": "^1.7.0",
"callsites": "^3.1.0",
"chance": "1.0.18",
"chromedriver": "^127.0.3",
"chromedriver": "^128.0.0",
"clean-webpack-plugin": "^3.0.0",
"cli-progress": "^3.12.0",
"cli-table3": "^0.6.1",
Expand Down
3 changes: 2 additions & 1 deletion packages/core/saved-objects/docs/openapi/bundled.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
"tags": [
{
"name": "saved objects",
"description": "Manage Kibana saved objects, including dashboards, visualizations, and more."
"x-displayName": "Saved objects",
"description": "Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n* [Data views](../group/endpoint-data-views)\n* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)\n* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n"
}
],
"paths": {
Expand Down
13 changes: 12 additions & 1 deletion packages/core/saved-objects/docs/openapi/bundled.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,18 @@ servers:
- url: /
tags:
- name: saved objects
description: Manage Kibana saved objects, including dashboards, visualizations, and more.
x-displayName: Saved objects
description: |
Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
To manage a specific type of saved object, use the corresponding APIs.
For example, use:
* [Data views](../group/endpoint-data-views)
* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)
* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
paths:
/api/encrypted_saved_objects/_rotate_key:
post:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,8 @@
"tags": [
{
"name": "saved objects",
"description": "Manage Kibana saved objects, including dashboards, visualizations, and more."
"x-displayName": "Saved objects",
"description": "Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.\n\nTo manage a specific type of saved object, use the corresponding APIs.\nFor example, use:\n\n[Data views](../group/endpoint-data-views)\n\nWarning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.\n"
}
],
"paths": {
Expand Down
11 changes: 10 additions & 1 deletion packages/core/saved-objects/docs/openapi/bundled_serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,16 @@ servers:
default: localhost:5601
tags:
- name: saved objects
description: Manage Kibana saved objects, including dashboards, visualizations, and more.
x-displayName: Saved objects
description: |
Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
To manage a specific type of saved object, use the corresponding APIs.
For example, use:
[Data views](../group/endpoint-data-views)
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
paths:
/api/saved_objects/_export:
post:
Expand Down
13 changes: 12 additions & 1 deletion packages/core/saved-objects/docs/openapi/entrypoint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,18 @@ info:
url: https://www.elastic.co/licensing/elastic-license
tags:
- name: saved objects
description: Manage Kibana saved objects, including dashboards, visualizations, and more.
x-displayName: Saved objects
description: |
Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
To manage a specific type of saved object, use the corresponding APIs.
For example, use:
* [Data views](../group/endpoint-data-views)
* [Spaces](https://www.elastic.co/guide/en/kibana/current/spaces-api.html)
* [Short URLs](https://www.elastic.co/guide/en/kibana/current/short-urls-api.html)
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
servers:
- url: /
paths:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,16 @@ info:
url: https://www.elastic.co/licensing/elastic-license
tags:
- name: saved objects
description: Manage Kibana saved objects, including dashboards, visualizations, and more.
x-displayName: Saved objects
description: |
Export sets of saved objects that you want to import into {kib}, resolve import errors, and rotate an encryption key for encrypted saved objects with the saved objects APIs.
To manage a specific type of saved object, use the corresponding APIs.
For example, use:
[Data views](../group/endpoint-data-views)
Warning: Do not write documents directly to the `.kibana` index. When you write directly to the `.kibana` index, the data becomes corrupted and permanently breaks future Kibana versions.
servers:
- url: 'https://{kibana_url}'
variables:
Expand Down
9 changes: 0 additions & 9 deletions packages/kbn-ftr-common-functional-services/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import { ProvidedType } from '@kbn/test';
export { services as commonFunctionalServices } from './services/all';

import { KibanaServerProvider } from './services/kibana_server';
export { KibanaServerProvider } from './services/kibana_server';
export type KibanaServer = ProvidedType<typeof KibanaServerProvider>;

export { RetryService } from './services/retry';
Expand All @@ -19,7 +18,6 @@ import { EsArchiverProvider } from './services/es_archiver';
export type EsArchiver = ProvidedType<typeof EsArchiverProvider>;

import { EsProvider } from './services/es';
export { EsProvider } from './services/es';
export type Es = ProvidedType<typeof EsProvider>;

import { SupertestWithoutAuthProvider } from './services/supertest_without_auth';
Expand All @@ -31,10 +29,3 @@ import { SamlAuthProvider } from './services/saml_auth/saml_auth_provider';
export type SamlAuthProviderType = ProvidedType<typeof SamlAuthProvider>;

export type { FtrProviderContext } from './services/ftr_provider_context';
export { runSavedObjInfoSvc } from './services/saved_object_info';

export type { BsearchService, SendOptions } from './services/bsearch';
export { SavedObjectInfoService } from './services/saved_object_info';
export { DeploymentService } from './services/deployment';
export { IndexPatternsService } from './services/index_patterns';
export { RandomnessService } from './services/randomness';
14 changes: 0 additions & 14 deletions packages/kbn-ftr-common-functional-services/services/all.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ import { EsArchiverProvider } from './es_archiver';
import { EsProvider } from './es';
import { KibanaServerProvider } from './kibana_server';
import { RetryService } from './retry';
import { BsearchService } from './bsearch';
import { ConsoleProvider } from './console';
import { DeploymentService } from './deployment';
import { EsDeleteAllIndicesProvider } from './es_delete_all_indices';
import { IndexPatternsService } from './index_patterns';
import { SavedObjectInfoService } from './saved_object_info';
import { RandomnessService } from './randomness';
import { SupertestWithoutAuthProvider } from './supertest_without_auth';
import { SamlAuthProvider } from './saml_auth';

Expand All @@ -25,13 +18,6 @@ export const services = {
kibanaServer: KibanaServerProvider,
esArchiver: EsArchiverProvider,
retry: RetryService,
bsearch: BsearchService,
console: ConsoleProvider,
deployment: DeploymentService,
esDeleteAllIndices: EsDeleteAllIndicesProvider,
indexPatterns: IndexPatternsService,
savedObjectInfo: SavedObjectInfoService,
randomness: RandomnessService,
supertestWithoutAuth: SupertestWithoutAuthProvider,
samlAuth: SamlAuthProvider,
};
7 changes: 0 additions & 7 deletions packages/kbn-ftr-common-functional-services/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,8 @@
"@kbn/es-archiver",
"@kbn/test",
"@kbn/expect",
"@kbn/search-types",
"@kbn/core-http-common",
"@kbn/bfetch-plugin",
"@kbn/data-plugin",
"@kbn/dev-cli-runner",
"@kbn/dev-cli-errors",
"@kbn/repo-info",
"@kbn/es",
"@kbn/data-views-plugin"
],
"exclude": [
"target/**/*",
Expand Down
1 change: 0 additions & 1 deletion packages/kbn-ftr-common-functional-ui-services/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,3 @@ export {
} from './services/remote/network_profiles';
export type { TimeoutOpt } from './types';
export { TestSubjects } from './services/test_subjects';
export { SecurityService } from './services/security';
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import { FindProvider } from './find';
import { TestSubjects } from './test_subjects';
import { BrowserProvider } from './browser';
import { ToastsService } from './toasts';
import { SecurityServiceProvider } from './security';

export const services = {
retryOnStale: RetryOnStaleProvider,
Expand All @@ -21,5 +20,4 @@ export const services = {
testSubjects: TestSubjects,
browser: BrowserProvider,
toasts: ToastsService,
security: SecurityServiceProvider,
};
Loading

0 comments on commit b8fc7da

Please sign in to comment.