You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: contribute-docs/api-docs/kibana-api-docs-quickstart.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -202,7 +202,7 @@ responses:
202
202
:sync: code-generated
203
203
204
204
:::{note}
205
-
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues. See [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh) for the full list of paths captured in CI.
205
+
**This step is optional.** CI will automatically capture the snapshot when you push your `.ts` changes. Running this locally is useful for validating changes before pushing or debugging issues.
206
206
:::
207
207
208
208
This step captures the OpenAPI specification that {{kib}} generates at runtime from your route definitions. It spins up a local {{es}} and {{kib}} cluster with your code changes. This generates the following output files in the `oas_docs` directory:
@@ -214,13 +214,27 @@ This step captures the OpenAPI specification that {{kib}} generates at runtime f
214
214
- [Docker](https://docs.docker.com/get-docker/) must be running
215
215
- If you're an Elastician, ensure you're logged into Docker with your Elastic account
216
216
217
-
**Capture all API paths** (recommended):
217
+
To capture all the documented API paths, copy the command from [`capture_oas_snapshot.sh`](https://github.com/elastic/kibana/blob/main/.buildkite/scripts/steps/checks/capture_oas_snapshot.sh). For example:
218
218
219
219
```bash
220
-
node scripts/capture_oas_snapshot --update
220
+
node scripts/capture_oas_snapshot \
221
+
--include-path /api/status \
222
+
--include-path /api/alerting/rule/ \
223
+
--include-path /api/alerting/rules \
224
+
--include-path /api/actions \
225
+
--include-path /api/security/role \
226
+
--include-path /api/spaces \
227
+
--include-path /api/streams \
228
+
--include-path /api/fleet \
229
+
--include-path /api/saved_objects/_import \
230
+
--include-path /api/saved_objects/_export \
231
+
--include-path /api/maintenance_window \
232
+
--include-path /api/agent_builder
233
+
--update
221
234
```
222
235
223
-
**For faster iteration**, capture the specific paths you're working on:
236
+
For faster iteration, you can capture the specific paths you're working on, though this minimized output should not be included in your pull request.
Copy file name to clipboardExpand all lines: deploy-manage/tools/cross-cluster-replication/ccr-getting-started-prerequisites.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,9 @@ products:
16
16
17
17
To complete this tutorial, you need:
18
18
19
-
* The `manage` cluster privilege on the local cluster.
20
-
* A license on both clusters that includes {{ccr}}. [Activate a free 30-day trial](../../license/manage-your-license-in-self-managed-cluster.md).
21
-
* An index on the remote cluster that contains the data you want to replicate. This tutorial uses the sample eCommerce orders data set. [Load sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana).
22
-
* In the local cluster, all nodes with the `master`[node role](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#node-roles) must also have the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. The local cluster must also have at least one node with both a data role and the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. Individual tasks for coordinating replication scale based on the number of data nodes with the `remote_cluster_client` role in the local cluster.
19
+
- The `manage` cluster privilege on the local cluster.
20
+
- Both clusters must have the same [license](/deploy-manage/license.md) type, and that license must support {{ccr}}.
21
+
-[Activate a free 30-day trial](../../license/manage-your-license-in-self-managed-cluster.md).
22
+
- An index on the remote cluster that contains the data you want to replicate. This tutorial uses the sample eCommerce orders data set. [Load sample data](../../../explore-analyze/index.md#gs-get-data-into-kibana).
23
+
- In the local cluster, all nodes with the `master`[node role](elasticsearch://reference/elasticsearch/configuration-reference/node-settings.md#node-roles) must also have the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. The local cluster must also have at least one node with both a data role and the [`remote_cluster_client`](../../distributed-architecture/clusters-nodes-shards/node-roles.md#remote-node) role. Individual tasks for coordinating replication scale based on the number of data nodes with the `remote_cluster_client` role in the local cluster.
Depending on the data you defined, several options allow you to apply additional filtering to the data taken into account to compute the metric's value:
3
+
4
+
-**Normalize by unit**: Normalize the metric values to show per unit of time.
5
+
-**Filter by**: Specify a query.
6
+
-**Reduced time range**: Reduce the time range specified on the dashboard's time filter by the specified duration.
7
+
-**Time shift**: Shift the time range by the specified duration. This is useful if the value should use a different time range than the one selected on the dashboard.
8
+
-**Hide zero values**: Don't show values equal to zero. This option is on by default.
0 commit comments