Skip to content

Commit 58c77ec

Browse files
Merge branch 'master' into incorrect-datafeed-start-time-69537
2 parents dcce6b6 + b7bb193 commit 58c77ec

File tree

183 files changed

+3168
-2272
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

183 files changed

+3168
-2272
lines changed

docs/developer/advanced/development-basepath.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[development-basepath]]
2-
=== Considerations for basepath
2+
== Considerations for basepath
33

44
In dev mode, {kib} by default runs behind a proxy which adds a random path component to its URL.
55

docs/developer/advanced/development-es-snapshots.asciidoc

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
[[development-es-snapshots]]
2-
=== Daily Elasticsearch Snapshots
2+
== Daily {es} Snapshots
33

4-
For local development and CI, {kib}, by default, uses Elasticsearch snapshots that are built daily when running tasks that require Elasticsearch (e.g. functional tests).
4+
For local development and CI, {kib}, by default, uses {es} snapshots that are built daily when running tasks that require {es} (e.g. functional tests).
55

6-
A snapshot is just a group of tarballs, one for each supported distribution/architecture/os of Elasticsearch, and a JSON-based manifest file containing metadata about the distributions.
6+
A snapshot is just a group of tarballs, one for each supported distribution/architecture/os of {es}, and a JSON-based manifest file containing metadata about the distributions.
77

8-
https://ci.kibana.dev/es-snapshots[A dashboard] is available that shows the current status and compatibility of the latest Elasticsearch snapshots.
8+
https://ci.kibana.dev/es-snapshots[A dashboard] is available that shows the current status and compatibility of the latest {es} snapshots.
99

10-
==== Process Overview
10+
=== Process Overview
1111

12-
1. Elasticsearch snapshots are built for each current tracked branch of {kib}.
12+
1. {es} snapshots are built for each current tracked branch of {kib}.
1313
2. Each snapshot is uploaded to a public Google Cloud Storage bucket, `kibana-ci-es-snapshots-daily`.
1414
** At this point, the snapshot is not automatically used in CI or local development. It needs to be tested/verified first.
1515
3. Each snapshot is tested with the latest commit of the corresponding {kib} branch, using the full CI suite.
1616
4. After CI
1717
** If the snapshot passes, it is promoted and automatically used in CI and local development.
18-
** If the snapshot fails, the issue must be investigated and resolved. A new incompatibility may exist between Elasticsearch and {kib}.
18+
** If the snapshot fails, the issue must be investigated and resolved. A new incompatibility may exist between {es} and {kib}.
1919

20-
==== Using the latest snapshot
20+
=== Using the latest snapshot
2121

22-
When developing locally, you may wish to use the most recent Elasticsearch snapshot, even if it's failing CI. To do so, prefix your commands with the follow environment variable:
22+
When developing locally, you may wish to use the most recent {es} snapshot, even if it's failing CI. To do so, prefix your commands with the follow environment variable:
2323

2424
["source","bash"]
2525
-----------
2626
KBN_ES_SNAPSHOT_USE_UNVERIFIED=true
2727
-----------
2828

29-
You can use this flag with any command that downloads and runs Elasticsearch snapshots, such as `scripts/es` or the FTR.
29+
You can use this flag with any command that downloads and runs {es} snapshots, such as `scripts/es` or the FTR.
3030

3131
For example, to run functional tests with the latest snapshot:
3232

@@ -35,7 +35,7 @@ For example, to run functional tests with the latest snapshot:
3535
KBN_ES_SNAPSHOT_USE_UNVERIFIED=true node scripts/functional_tests_server
3636
-----------
3737

38-
===== For Pull Requests
38+
==== For Pull Requests
3939

4040
Currently, there is not a way to run your pull request with the latest unverified snapshot without a code change. You can, however, do it with a small code change.
4141

@@ -45,9 +45,9 @@ Currently, there is not a way to run your pull request with the latest unverifie
4545

4646
Your pull request should then use the latest snapshot the next time that it runs. Just don't merge the change to `Jenkinsfile`!
4747

48-
==== Google Cloud Storage buckets
48+
=== Google Cloud Storage buckets
4949

50-
===== kibana-ci-es-snapshots-daily
50+
==== kibana-ci-es-snapshots-daily
5151

5252
This bucket stores snapshots that are created on a daily basis, and is the primary location used by `kbn-es` to download snapshots.
5353

@@ -61,7 +61,7 @@ The file structure for this bucket looks like this:
6161
* `<version>/archives/<unique id>/*.tar.gz.sha512`
6262
* `<version>/archives/<unique id>/manifest.json`
6363

64-
===== kibana-ci-es-snapshots-permanent
64+
==== kibana-ci-es-snapshots-permanent
6565

6666
This bucket stores only the most recently promoted snapshot for each version. Old snapshots are only deleted when new ones are uploaded.
6767

@@ -73,18 +73,18 @@ The file structure for this bucket looks like this:
7373
* `<version>/*.tar.gz.sha512`
7474
* `<version>/manifest.json`
7575

76-
==== How snapshots are built, tested, and promoted
76+
=== How snapshots are built, tested, and promoted
7777

78-
Each day, a https://kibana-ci.elastic.co/job/elasticsearch+snapshots+trigger/[Jenkins job] runs that triggers Elasticsearch builds for each currently tracked branch/version. This job is automatically updated with the correct branches whenever we release new versions of {kib}.
78+
Each day, a https://kibana-ci.elastic.co/job/elasticsearch+snapshots+trigger/[Jenkins job] runs that triggers {es} builds for each currently tracked branch/version. This job is automatically updated with the correct branches whenever we release new versions of {kib}.
7979

80-
===== Build
80+
==== Build
8181

82-
https://kibana-ci.elastic.co/job/elasticsearch+snapshots+build/[This Jenkins job] builds the Elasticsearch snapshots and uploads them to GCS.
82+
https://kibana-ci.elastic.co/job/elasticsearch+snapshots+build/[This Jenkins job] builds the {es} snapshots and uploads them to GCS.
8383

8484
The Jenkins job pipeline definition is https://github.com/elastic/kibana/blob/master/.ci/es-snapshots/Jenkinsfile_build_es[in the {kib} repo].
8585

86-
1. Checkout Elasticsearch repo for the given branch/version.
87-
2. Run `./gradlew -p distribution/archives assemble --parallel` to create all of the Elasticsearch distributions.
86+
1. Checkout {es} repo for the given branch/version.
87+
2. Run `./gradlew -p distribution/archives assemble --parallel` to create all of the {es} distributions.
8888
3. Create a tarball for each distribution.
8989
4. Create a manifest JSON file containing info about the distribution, as well as its download URL.
9090
5. Upload the tarballs and manifest to a unique location in the GCS bucket `kibana-ci-es-snapshots-daily`.
@@ -93,9 +93,9 @@ The Jenkins job pipeline definition is https://github.com/elastic/kibana/blob/ma
9393
** This allows the `KBN_ES_SNAPSHOT_USE_UNVERIFIED` flag to work.
9494
7. Trigger the verification job, to run the full {kib} CI test suite with this snapshot.
9595

96-
===== Verification and Promotion
96+
==== Verification and Promotion
9797

98-
https://kibana-ci.elastic.co/job/elasticsearch+snapshots+verify/[This Jenkins job] tests the latest Elasticsearch snapshot with the full {kib} CI pipeline, and promotes if it there are no test failures.
98+
https://kibana-ci.elastic.co/job/elasticsearch+snapshots+verify/[This Jenkins job] tests the latest {es} snapshot with the full {kib} CI pipeline, and promotes if it there are no test failures.
9999

100100
The Jenkins job pipeline definition is https://github.com/elastic/kibana/blob/master/.ci/es-snapshots/Jenkinsfile_verify_es[in the {kib} repo].
101101

docs/developer/advanced/index.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
* <<development-es-snapshots>>
66
* <<development-basepath>>
77

8-
include::development-es-snapshots.asciidoc[]
8+
include::development-es-snapshots.asciidoc[leveloffset=+1]
99

10-
include::running-elasticsearch.asciidoc[]
10+
include::running-elasticsearch.asciidoc[leveloffset=+1]
1111

12-
include::development-basepath.asciidoc[]
12+
include::development-basepath.asciidoc[leveloffset=+1]

docs/developer/advanced/running-elasticsearch.asciidoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[[running-elasticsearch]]
2-
=== Running elasticsearch during development
2+
== Running {es} during development
33

4-
There are many ways to run Elasticsearch while you are developing.
4+
There are many ways to run {es} while you are developing.
55

6-
[float]
6+
[discrete]
77

8-
==== By snapshot
8+
=== By snapshot
99

10-
This will run a snapshot of elasticsearch that is usually built nightly. Read more about <<development-es-snapshots>>.
10+
This will run a snapshot of {es} that is usually built nightly. Read more about <<development-es-snapshots>>.
1111

1212
[source,bash]
1313
----
@@ -25,36 +25,36 @@ yarn es snapshot --help
2525

2626
**Keeping data between snapshots**
2727

28-
If you want to keep the data inside your Elasticsearch between usages of this command, you should use the following command, to keep your data folder outside the downloaded snapshot folder:
28+
If you want to keep the data inside your {es} between usages of this command, you should use the following command, to keep your data folder outside the downloaded snapshot folder:
2929

3030
[source,bash]
3131
----
3232
yarn es snapshot -E path.data=../data
3333
----
3434

35-
==== By source
35+
=== By source
3636

37-
If you have the Elasticsearch repo checked out locally and wish to run against that, use `source`. By default, it will reference an elasticsearch checkout which is a sibling to the {kib} directory named elasticsearch. If you wish to use a checkout in another location you can provide that by supplying --source-path
37+
If you have the {es} repo checked out locally and wish to run against that, use `source`. By default, it will reference an {es} checkout which is a sibling to the {kib} directory named elasticsearch. If you wish to use a checkout in another location you can provide that by supplying --source-path
3838

3939
[source,bash]
4040
----
4141
yarn es source
4242
----
4343

44-
==== From an archive
44+
=== From an archive
4545

46-
Use this if you already have a distributable. For released versions, one can be obtained on the Elasticsearch downloads page.
46+
Use this if you already have a distributable. For released versions, one can be obtained on the {es} downloads page.
4747

4848
[source,bash]
4949
----
5050
yarn es archive <full_path_to_archive>
5151
----
5252

53-
Each of these will run Elasticsearch with a basic license. Additional options are available, pass --help for more information.
53+
Each of these will run {es} with a basic license. Additional options are available, pass --help for more information.
5454

55-
==== From a remote host
55+
=== From a remote host
5656

57-
You can save some system resources, and the effort of generating sample data, if you have a remote Elasticsearch cluster to connect to. (Elasticians: you do! Check with your team about where to find credentials)
57+
You can save some system resources, and the effort of generating sample data, if you have a remote {es} cluster to connect to. (Elasticians: you do! Check with your team about where to find credentials)
5858

5959
You'll need to create a kibana.dev.yml (<<customize-kibana-yml>>) and add the following to it:
6060

@@ -75,7 +75,7 @@ kibana.index: '.{YourGitHubHandle}-kibana'
7575
xpack.task_manager.index: '.{YourGitHubHandle}-task-manager-kibana'
7676
----
7777

78-
===== Running remote clusters
78+
==== Running remote clusters
7979

8080
Setup remote clusters for cross cluster search (CCS) and cross cluster replication (CCR).
8181

@@ -95,7 +95,7 @@ yarn es snapshot -E transport.port=9500 -E http.port=9201 -E path.data=../data_p
9595

9696
Once both clusters are running, start {kib}. {kib} will connect to the primary cluster.
9797

98-
Setup the remote cluster in {kib} from either Management -> Elasticsearch -> Remote Clusters UI or by running the following script in Console.
98+
Setup the remote cluster in {kib} from either Management -> {es} -> Remote Clusters UI or by running the following script in Console.
9999

100100
[source,bash]
101101
----

docs/developer/architecture/add-data-tutorials.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
[[add-data-tutorials]]
2-
=== Add data tutorials
2+
== Add data tutorials
33

44
`Add Data` in the {kib} Home application contains tutorials for setting up data flows in the Elastic stack.
55

66
Each tutorial contains three sets of instructions:
77

8-
* `On Premise.` Set up a data flow when both {kib} and Elasticsearch are running on premise.
9-
* `On Premise Elastic Cloud.` Set up a data flow when {kib} is running on premise and Elasticsearch is running on Elastic Cloud.
10-
* `Elastic Cloud.` Set up a data flow when both {kib} and Elasticsearch are running on Elastic Cloud.
8+
* `On Premise.` Set up a data flow when both {kib} and {es} are running on premise.
9+
* `On Premise Elastic Cloud.` Set up a data flow when {kib} is running on premise and {es} is running on Elastic Cloud.
10+
* `Elastic Cloud.` Set up a data flow when both {kib} and {es} are running on Elastic Cloud.
1111

12-
[float]
13-
==== Creating a new tutorial
12+
[discrete]
13+
=== Creating a new tutorial
1414
1. Create a new directory in the link:https://github.com/elastic/kibana/tree/master/src/plugins/home/server/tutorials[tutorials directory].
1515
2. In the new directory, create a file called `index.ts` that exports a function.
1616
The function must return a function object that conforms to the `TutorialSchema` interface link:{kib-repo}tree/{branch}/src/plugins/home/server/services/tutorials/lib/tutorial_schema.ts[tutorial schema].
@@ -23,15 +23,15 @@ The function must return a function object that conforms to the `TutorialSchema`
2323
If you are creating a new plugin and the tutorial is only related to that plugin, you can also place the `TutorialSchema` object into your plugin folder. Add `home` to the `requiredPlugins` list in your `kibana.json` file.
2424
Then register the tutorial object by calling `home.tutorials.registerTutorial(tutorialObject)` in the `setup` lifecycle of your server plugin.
2525

26-
[float]
27-
===== Variables
26+
[discrete]
27+
==== Variables
2828
String values can contain variables that are substituted when rendered. Variables are specified by `{}`.
2929
For example: `{config.docs.version}` is rendered as `6.2` when running the tutorial in {kib} 6.2.
3030

3131
link:{kib-repo}tree/{branch}/src/legacy/core_plugins/kibana/public/home/np_ready/components/tutorial/replace_template_strings.js#L23[Provided variables]
3232

33-
[float]
34-
===== Markdown
33+
[discrete]
34+
==== Markdown
3535
String values can contain limited Markdown syntax.
3636

3737
link:{kib-repo}tree/{branch}/src/legacy/core_plugins/kibana/public/home/components/tutorial/content.js#L8[Enabled Markdown grammars]

docs/developer/architecture/development-visualize-index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[development-visualize-index]]
2-
=== Developing Visualizations
2+
== Developing Visualizations
33

44
[IMPORTANT]
55
==============================================

docs/developer/architecture/index.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ A few notable services are called out below.
1818
* <<add-data-tutorials>>
1919
* <<development-visualize-index>>
2020

21-
include::add-data-tutorials.asciidoc[]
21+
include::add-data-tutorials.asciidoc[leveloffset=+1]
2222

23-
include::development-visualize-index.asciidoc[]
23+
include::development-visualize-index.asciidoc[leveloffset=+1]
2424

25-
include::security/index.asciidoc[]
25+
include::security/index.asciidoc[leveloffset=+1]

docs/developer/architecture/security/feature-registration.asciidoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
[[development-plugin-feature-registration]]
2-
==== Plugin feature registration
2+
== Plugin feature registration
33

44
If your plugin will be used with {kib}'s default distribution, then you have the ability to register the features that your plugin provides. Features are typically apps in {kib}; once registered, you can toggle them via Spaces, and secure them via Roles when security is enabled.
55

6-
===== UI Capabilities
6+
=== UI Capabilities
77

88
Registering features also gives your plugin access to “UI Capabilities”. These capabilities are boolean flags that you can use to conditionally render your interface, based on the current user's permissions. For example, you can hide or disable a Save button if the current user is not authorized.
99

10-
===== Registering a feature
10+
=== Registering a feature
1111

1212
Feature registration is controlled via the built-in `xpack_main` plugin. To register a feature, call `xpack_main`'s `registerFeature` function from your plugin's `init` function, and provide the appropriate details:
1313

@@ -21,7 +21,7 @@ init(server) {
2121
}
2222
-----------
2323

24-
===== Feature details
24+
=== Feature details
2525
Registering a feature consists of the following fields. For more information, consult the {kib-repo}blob/{branch}/x-pack/plugins/features/server/feature_registry.ts[feature registry interface].
2626

2727

@@ -65,12 +65,12 @@ Registering a feature consists of the following fields. For more information, co
6565
|The ID of the navigation link associated with your feature.
6666
|===
6767

68-
====== Privilege definition
68+
==== Privilege definition
6969
The `privileges` section of feature registration allows plugins to implement read/write and read-only modes for their applications.
7070

7171
For a full explanation of fields and options, consult the {kib-repo}blob/{branch}/x-pack/plugins/features/server/feature_registry.ts[feature registry interface].
7272

73-
===== Using UI Capabilities
73+
=== Using UI Capabilities
7474

7575
UI Capabilities are available to your public (client) plugin code. These capabilities are read-only, and are used to inform the UI. This object is namespaced by feature id. For example, if your feature id is “foo”, then your UI Capabilities are stored at `uiCapabilities.foo`.
7676
To access capabilities, import them from `ui/capabilities`:
@@ -86,7 +86,7 @@ if (canUserSave) {
8686
-----------
8787

8888
[[example-1-canvas]]
89-
===== Example 1: Canvas Application
89+
=== Example 1: Canvas Application
9090
["source","javascript"]
9191
-----------
9292
init(server) {
@@ -141,7 +141,7 @@ if (canUserSave) {
141141
Because the `read` privilege does not define the `save` capability, users with read-only access will have their `uiCapabilities.canvas.save` flag set to `false`.
142142

143143
[[example-2-dev-tools]]
144-
===== Example 2: Dev Tools
144+
=== Example 2: Dev Tools
145145

146146
["source","javascript"]
147147
-----------
@@ -176,7 +176,7 @@ init(server) {
176176
},
177177
privilegesTooltip: i18n.translate('xpack.features.devToolsPrivilegesTooltip', {
178178
defaultMessage:
179-
'User should also be granted the appropriate Elasticsearch cluster and index privileges',
179+
'User should also be granted the appropriate {es} cluster and index privileges',
180180
}),
181181
});
182182
}
@@ -199,7 +199,7 @@ server.route({
199199
-----------
200200

201201
[[example-3-discover]]
202-
===== Example 3: Discover
202+
=== Example 3: Discover
203203

204204
Discover takes advantage of subfeature privileges to allow fine-grained access control. In this example,
205205
a single "Create Short URLs" subfeature privilege is defined, which allows users to grant access to this feature without having to grant the `all` privilege to Discover. In other words, you can grant `read` access to Discover, and also grant the ability to create short URLs.

0 commit comments

Comments
 (0)