5b22aa9b66
## Summary This PR adds the following parameters to the `INIT` engine API: * `frequency`: the transform run frequency * `timeout`: the timeout for the initial creation of the transform * `docsPerSecond`: transform throttling option. See [here](https://arc.net/l/quote/vxcmfnhh) * `delay`: The transform delay duration. See [here](https://arc.net/l/quote/mzvaexhv) Coming soon In addition, the PR adds these fields to the Saved Object with the engine descriptor, as well as providing a migration with the appropriate backfilling. Finally, there are some utility function that were/are helpful in working with objects. ## How to test *NOTE*: Always make sure the security default data view exists. Easiest way it to just navigate to some Security UI. ### Checking the new defaults 1. Initialize an engine via dev tools by calling: `POST kbn:/api/entity_store/engines/<entity_type>/init {}` 2. Call `GET kbn:/api/entity_store/status`. This response should now contain all the default optional values. ### Observing the parameters are being applied 1. Initialize an engine via the API. This time pass any of the `timeout, frequency, delay and docsPerSecond` options in the request body. 2. Once the `status` changes to `started`, query the respective transform: `GET _transform/entities-v1-latest-security_<entity_type>_default` 3. Check that the parameters have been applied to the transform ### Checking Saved Object Migration 1. Check out `main`. 2. Initialize the store. 3. Query `GET kbn:/api/entity_store/status`. Note down the fields in the engine object. 4. Check out this branch. 5. Restart kibana. 6. Query `GET kbn:/api/entity_store/status` again. Observe the new fields have been added and backfilled --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| examples | ||
| linters | ||
| output | ||
| overlays | ||
| scripts | ||
| bundle.json | ||
| bundle.serverless.json | ||
| kibana.info.serverless.yaml | ||
| kibana.info.yaml | ||
| makefile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
Kibana API reference documentation
Documentation about our OpenAPI bundling workflow and configuration. See Kibana's hosted stateful and serverless docs.
Workflow
The final goal of this workflow is to produce an OpenAPI bundle containing all Kibana's public APIs.
Step 0
OAS from Kibana's APIs are continuously extracted and captured in bundle.json and bundle.serverless.json as fully formed OAS documentation. See node scripts/capture_oas_snapshot --help for more info.
These bundles form the basis of our OpenAPI bundles to which we append and layer extra information before publishing.
Step 1
Append pre-existing bundles not extracted from code using kbn-openapi-bundler to produce the final resulting bundles.
To add more files into the final bundle, edit the appropriate oas_docs/scripts/merge*.js files.
Step 2
Apply any final overalys to the document that might include examples or final tweaks (see the "Scripts" section for more details).
Scripts
The oas_docs/scripts folder contains scripts that point to the source domain-specific OpenAPI bundles and specify additional parameters for producing the final output bundle. Currently, there are the following scripts:
-
merge_ess_oas.jsscript produces production an output bundle for ESS -
merge_serverless_oas.jsscript produces production an output bundle for Serverless
Output Kibana OpenAPI bundles
The oas_docs/output folder contains the final resulting Kibana OpenAPI bundles
kibana.yamlproduction ready ESS OpenAPI bundlekibana.serverless.yamlproduction ready Serverless OpenAPI bundle
Bundling commands
Besides the scripts in the oas_docs/scripts folder, there is an oas_docs/makefile to simplify the workflow. Use make help to see available commands.