Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Update "Alert and action settings" docs to be generated from YAML source #191787

Open
wants to merge 50 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 36 commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
7275ea1
[Docs test] Config settings mock-up
kilfoyle Aug 29, 2024
048cd53
Fix script to use relative rather than hard-coded paths
kilfoyle Aug 30, 2024
11d33ed
Fix up script
kilfoyle Sep 5, 2024
7d2ba0a
Add groups logic
kilfoyle Sep 6, 2024
3490fe1
fixup
kilfoyle Sep 6, 2024
ccc7327
Add readme with schema
kilfoyle Sep 11, 2024
9d9d4d1
Add example yml page and output
kilfoyle Sep 16, 2024
2ebaa99
touchup
kilfoyle Sep 16, 2024
b58f23c
touchup
kilfoyle Sep 16, 2024
66bbcd6
Remove comments from examples file
kilfoyle Sep 17, 2024
3f70764
Reformat output; no plus signs
kilfoyle Sep 18, 2024
44185e7
Fix readme, plus other stuff that I forget
kilfoyle Sep 27, 2024
a27b353
readme touchup
kilfoyle Sep 27, 2024
79aa177
readme touchup
kilfoyle Sep 27, 2024
5c419f0
Fix script & schema, add template
kilfoyle Oct 3, 2024
fbc50b1
Comment out unused settings
kilfoyle Oct 4, 2024
142d232
Fix examples, intros, etc.
kilfoyle Oct 4, 2024
b19f09d
Add alert and action settings
kilfoyle Oct 4, 2024
58c1564
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 4, 2024
b544771
Fix parent files
kilfoyle Oct 4, 2024
3c839cc
Remove old files, examples, etc.
kilfoyle Oct 7, 2024
aa630ec
fixup
kilfoyle Oct 7, 2024
adaac1a
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 7, 2024
0435719
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 9, 2024
2a04536
Fix readme; add changes from Kibana PRs 195308, 195320
kilfoyle Oct 9, 2024
b91b149
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 9, 2024
afaf62b
Add top of file warnings
kilfoyle Oct 9, 2024
5c31ac4
Add platform-docs as codeowners for setting-gen directory
kilfoyle Oct 9, 2024
df17b44
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 10, 2024
5efed75
Add setting update from Kibana #189027
kilfoyle Oct 23, 2024
c9bb65e
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 23, 2024
ae43bf4
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 28, 2024
0ff8363
Merge branch 'main' into generate-settings-testing-02
kilfoyle Oct 30, 2024
8c8f182
Merge branch 'main' into generate-settings-testing-02
kilfoyle Nov 4, 2024
642b207
Add settings changes from Kibana #198435
kilfoyle Nov 4, 2024
8230849
Merge branch 'main' into generate-settings-testing-02
kilfoyle Nov 4, 2024
f2d494b
Remove collapsible sections
kilfoyle Nov 21, 2024
86d0679
Remove 'inference-action-type' to resolve conflict with Lisa's 198633
kilfoyle Nov 21, 2024
6e66c7d
Move examples to multiline YAML strings
kilfoyle Nov 21, 2024
fa1fe32
A couple of corrections
kilfoyle Nov 21, 2024
a31d564
Merge branch 'main' into generate-settings-testing-02
kilfoyle Nov 21, 2024
ebd8444
Update readme; Fix missing example comments
kilfoyle Nov 21, 2024
fd7d0e2
Merge branch 'main' into generate-settings-testing-02
kilfoyle Nov 25, 2024
7a62c58
Add in changes from PR 197421 to fix conflict
kilfoyle Dec 3, 2024
035e459
Merge branch 'main' into generate-settings-testing-02
kilfoyle Dec 3, 2024
72135bc
Merge branch 'main' into generate-settings-testing-02
kilfoyle Dec 12, 2024
3008521
Merge branch 'main' into generate-settings-testing-02
kilfoyle Dec 16, 2024
e70c728
multiline string descriptions; add datatypes; fix readme
kilfoyle Dec 17, 2024
a4cbb70
Merge branch 'main' into generate-settings-testing-02
kilfoyle Dec 17, 2024
519cdf9
Merge branch 'main' into generate-settings-testing-02
kilfoyle Dec 19, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -2040,6 +2040,9 @@ oas_docs/.spectral.yaml @elastic/platform-docs
oas_docs/kibana.info.serverless.yaml @elastic/platform-docs
oas_docs/kibana.info.yaml @elastic/platform-docs

# Documentation settings files
docs/settings-gen @elastic/platform-docs

# Plugin manifests
/src/plugins/**/kibana.jsonc @elastic/kibana-core
/x-pack/plugins/**/kibana.jsonc @elastic/kibana-core
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
For example:

[source,yaml]
----------------------------------------
xpack.actions.preconfigured:
my-server-log:
name: preconfigured-server-log-connector-type
actionTypeId: .server-log
----------------------------------------

For more examples, go to <<pre-configured-connectors>>.
29 changes: 29 additions & 0 deletions docs/settings-gen/embeds/example-setting-example.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
In the following example, two custom host settings
are defined. The first provides a custom host setting for mail server
`mail.example.com` using port 465 that supplies server certificate authentication
data from both a file and inline, and requires TLS for the
connection. The second provides a custom host setting for https server
`webhook.example.com` which turns off server certificate authentication,
that will allow Kibana to connect to the server if it's using a self-signed
certificate. The individual properties that can be used in the settings are
documented below.

[source,yaml]
--
xpack.actions.customHostSettings:
- url: smtp://mail.example.com:465
ssl:
verificationMode: 'full'
certificateAuthoritiesFiles: [ 'one.crt' ]
certificateAuthoritiesData: |
-----BEGIN CERTIFICATE-----
MIIDTD...
CwUAMD...
... multiple lines of certificate data ...
-----END CERTIFICATE-----
smtp:
requireTLS: true
- url: https://webhook.example.com
ssl:
verificationMode: 'none'
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
In the following example, two custom host settings
are defined. The first provides a custom host setting for mail server
`mail.example.com` using port 465 that supplies server certificate authentication
data from both a file and inline, and requires TLS for the
connection. The second provides a custom host setting for https server
`webhook.example.com` which turns off server certificate authentication,
that will allow Kibana to connect to the server if it's using a self-signed
certificate. The individual properties that can be used in the settings are
documented below.

[source,yaml]
--
xpack.actions.customHostSettings:
- url: smtp://mail.example.com:465
ssl:
verificationMode: 'full'
certificateAuthoritiesFiles: [ 'one.crt' ]
certificateAuthoritiesData: |
-----BEGIN CERTIFICATE-----
MIIDTD...
CwUAMD...
... multiple lines of certificate data ...
-----END CERTIFICATE-----
smtp:
requireTLS: true
- url: https://webhook.example.com
ssl:
verificationMode: 'none'
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
For example:

[source,yaml]
----
# If applicable, include the subdomain in the hostname
xpack.actions.proxyBypassHosts: [ "events.pagerduty.com" ]
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
For example:

[source,yaml]
----
# If applicable, include the subdomain in the hostname
xpack.actions.proxyOnlyHosts: [ "events.pagerduty.com" ]
----
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
To help diagnose problems using a proxy, you can use the `curl` command with options to use your proxy, and log debug information, with the following command, replacing the proxy and target URLs as appropriate. This will force the request to be made to the
proxy in tunneling mode, and display some of the interaction between the client and the proxy.

[source,sh]
--
curl --verbose --proxytunnel --proxy http://localhost:8080 http://example.com
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
For example:

[source,yaml]
--
xpack.alerting.rules.run:
actions:
max: 10
connectorTypeOverrides:
- id: '.server-log'
max: 5
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
For example:

[source,yaml]
--
xpack.alerting.rules.run:
timeout: '5m'
ruleTypeOverrides:
- id: '.index-threshold'
timeout: '15m'
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
For example:

[source,yaml]
--
xpack.actions.run:
maxAttempts: 1
connectorTypeOverrides:
- id: '.server-log'
maxAttempts: 5
--
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
In the following example, two custom host settings
are defined. The first provides a custom host setting for mail server
`mail.example.com` using port 465 that supplies server certificate authentication
data from both a file and inline, and requires TLS for the
connection. The second provides a custom host setting for https server
`webhook.example.com` which turns off server certificate authentication,
that will allow Kibana to connect to the server if it's using a self-signed
certificate. The individual properties that can be used in the settings are
documented below.

[source,yaml]
--
xpack.actions.customHostSettings:
- url: smtp://mail.example.com:465
ssl:
verificationMode: 'full'
certificateAuthoritiesFiles: [ 'one.crt' ]
certificateAuthoritiesData: |
-----BEGIN CERTIFICATE-----
MIIDTD...
CwUAMD...
... multiple lines of certificate data ...
-----END CERTIFICATE-----
smtp:
requireTLS: true
- url: https://webhook.example.com
ssl:
verificationMode: 'none'
--
Loading