Skip to content

Commit 85b4201

Browse files
[Docs] Replace placeholder URLs (#131309) (#131867)
* [Docs] Replace placeholder URLs * Remove 'DOCKER_HOST_URL' changes * url > ip * Update docs/reference/elasticsearch/configuration-reference/security-settings.md * Update docs/reference/elasticsearch/configuration-reference/security-settings.md * Update docs/reference/elasticsearch/configuration-reference/security-settings.md --------- Co-authored-by: shainaraskas <[email protected]>
1 parent 5535de3 commit 85b4201

File tree

10 files changed

+23
-23
lines changed

10 files changed

+23
-23
lines changed

docs/reference/elasticsearch-plugins/cloud/ec-plugins-guide.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ curl -X POST \
4949
-H "Authorization: ApiKey $CLOUD_API_KEY" \
5050
-H 'Content-Type: application/json' \
5151
-d '{
52-
"download_url" : "https://my_site/custom-plugin-8.4.3.zip",
52+
"download_url" : "<MY_SITE_URL>/custom-plugin-8.4.3.zip",
5353
"extension_type" : "plugin",
5454
"name" : "custom-plugin",
5555
"version" : "8.4.3"
@@ -323,7 +323,7 @@ curl -X POST \
323323
-H "Authorization: ApiKey $CLOUD_API_KEY" \
324324
-H 'Content-Type: application/json' \
325325
-d '{
326-
"download_url" : "https://my_site/custom-plugin-8.4.3-10212022.zip",
326+
"download_url" : "<MY_SITE_URL>/custom-plugin-8.4.3-10212022.zip",
327327
"extension_type" : "plugin",
328328
"name": "custom-plugin-10212022",
329329
"version" : "8.4.3"

docs/reference/elasticsearch-plugins/manage-plugins-using-configuration-file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ plugins:
2525
- id: analysis-icu
2626
- id: repository-azure
2727
- id: custom-mapper
28-
location: https://example.com/archive/custom-mapper-1.0.0.zip
28+
location: <EXAMPLE_URL>/archive/custom-mapper-1.0.0.zip
2929
```
3030
3131
This example installs the official `analysis-icu` and `repository-azure` plugins, and one unofficial plugin. Every plugin must provide an `id`. Unofficial plugins must also provide a `location`. This is typically a URL, but Maven coordinates are also supported. The downloaded plugin’s name must match the ID in the configuration file.
@@ -35,7 +35,7 @@ While {{es}} will respect the [standard Java proxy system properties](https://do
3535
```yaml
3636
plugins:
3737
- id: custom-mapper
38-
location: https://example.com/archive/custom-mapper-1.0.0.zip
38+
location: <EXAMPLE_URL>/archive/custom-mapper-1.0.0.zip
3939
proxy: proxy.example.com:8443
4040
```
4141

docs/reference/elasticsearch-plugins/plugin-management-custom-url.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,13 @@ HTTP
4646
: To install a plugin from an HTTP URL:
4747

4848
```shell
49-
sudo bin/elasticsearch-plugin install https://some.domain/path/to/plugin.zip
49+
sudo bin/elasticsearch-plugin install <EXAMPLE_PLUGIN_HOST_URL>/plugin.zip
5050
```
5151

5252
The plugin script will refuse to talk to an HTTPS URL with an untrusted certificate. To use a self-signed HTTPS cert, you will need to add the CA cert to a local Java truststore and pass the location to the script as follows:
5353

5454
```shell
55-
sudo CLI_JAVA_OPTS="-Djavax.net.ssl.trustStore=/path/to/trustStore.jks" bin/elasticsearch-plugin install https://host/plugin.zip
55+
sudo CLI_JAVA_OPTS="-Djavax.net.ssl.trustStore=/path/to/trustStore.jks" bin/elasticsearch-plugin install <MY_HOST_URL>/plugin.zip
5656
```
5757

5858

docs/reference/elasticsearch/command-line-tools/saml-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,6 @@ bin/elasticsearch-saml-metadata --realm saml2 \
112112
--locale en-GB \
113113
--contacts \
114114
--organisation-name "Mega Corp. Finance Team" \
115-
--organisation-url "http://mega.example.com/finance/"
115+
--organisation-url "<EXAMPLE_URL>/finance/"
116116
```
117117

docs/reference/elasticsearch/configuration-reference/machine-learning-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ $$$xpack.ml.model_repository$$$
119119
or
120120

121121
```
122-
xpack.ml.model_repository: https://my-custom-backend
122+
xpack.ml.model_repository: <MY_CUSTOM_BACKEND_URL>
123123
```
124124

125125
If `xpack.ml.model_repository` is a file location, it must point to a subdirectory of the `config` directory of {{es}}.

docs/reference/elasticsearch/configuration-reference/monitoring-settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,13 +200,13 @@ xpack.monitoring.exporters.my_remote:
200200
host: "10.1.2.3"
201201
example2:
202202
type: http
203-
host: ["http://10.1.2.4"]
203+
host: ["<HOST_IP>"]
204204
example3:
205205
type: http
206206
host: ["10.1.2.5", "10.1.2.6"]
207207
example4:
208208
type: http
209-
host: ["https://10.1.2.3:9200"]
209+
host: ["HOST_IP>:9200"]
210210
```
211211

212212

docs/reference/elasticsearch/configuration-reference/security-settings.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1403,16 +1403,16 @@ In addition to the [settings that are valid for all realms](#ref-realm-settings)
14031403
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) The token type, `id_token` or `access_token`, that the JWT realm uses to verify incoming JWTs. Defaults to `id_token`.
14041404

14051405
`allowed_audiences` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
1406-
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) A list of allowed JWT audiences that {{es}} should verify. {{es}} will only consume JWTs that were intended for any of these audiences, as denoted by the `aud` claim in the JWT). The audiences are compared with exact string matches and do not support wildcards or regex. Examples of `aud` claim are `https://example.com/client1` and `other_service,elasticsearch`. When `token_type` is `access_token`, the audiences can be optionally denoted by a different claim in the JWT if `aud` does not exist. See also [`fallback_claims.aud`](#security-settings-jwt-fallback-claims-aud).
1406+
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) A list of allowed JWT audiences that {{es}} should verify. {{es}} will only consume JWTs that were intended for any of these audiences, as denoted by the `aud` claim in the JWT). The audiences are compared with exact string matches and do not support wildcards or regex. Examples of `aud` claim are `<example-url>/client1` and `other_service,elasticsearch`. When `token_type` is `access_token`, the audiences can be optionally denoted by a different claim in the JWT if `aud` does not exist. See also [`fallback_claims.aud`](#security-settings-jwt-fallback-claims-aud).
14071407

14081408
`allowed_clock_skew` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
14091409
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) The maximum allowed clock skew to be taken into consideration when validating JWTs with regards to their creation, not before, and expiration times.
14101410

14111411
`allowed_issuer` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
1412-
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) A verifiable Identifier for your JWT Issuer. An Issuer Identifier is usually a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. However, it can be any string. The value for this setting should be provided by your JWT Issuer. The issuer is compared with exact string matches and do not support wildcards or regex. Examples of `iss` claim are `https://example.com:8443/jwt` and `issuer123`.
1412+
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) A verifiable Identifier for your JWT Issuer. An Issuer Identifier is usually a case sensitive URL using the https scheme that contains scheme, host, and optionally, port number and path components and no query or fragment components. However, it can be any string. The value for this setting should be provided by your JWT Issuer. The issuer is compared with exact string matches and do not support wildcards or regex. Examples of `iss` claim are `<example-url>:8443/jwt` and `issuer123`.
14131413

14141414
`allowed_subjects` ![logo cloud](https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg "Supported on Elastic Cloud Hosted")
1415-
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) A list of allowed JWT subjects that {{es}} should verify. {{es}} will only consume JWTs that were issued for any of these subjects, as denoted by the `sub` claim in the JWT. The subjects are compared with exact string matches and do not support wildcards or regex. Examples of `sub` claim are `https://example.com/user1` and `user_1,user2`. When `token_type` is `access_token`, this setting is mandatory and the subject can be optionally denoted by a different claim in the JWT if `sub` does not exist. See also [`fallback_claims.sub`](#security-settings-jwt-fallback-claims-sub).
1415+
: ([Static](docs-content://deploy-manage/stack-settings.md#static-cluster-setting)) A list of allowed JWT subjects that {{es}} should verify. {{es}} will only consume JWTs that were issued for any of these subjects, as denoted by the `sub` claim in the JWT. The subjects are compared with exact string matches and do not support wildcards or regex. Examples of `sub` claim are `<example-url>/user1` and `user_1,user2`. When `token_type` is `access_token`, this setting is mandatory and the subject can be optionally denoted by a different claim in the JWT if `sub` does not exist. See also [`fallback_claims.sub`](#security-settings-jwt-fallback-claims-sub).
14161416

14171417
$$$security-settings-jwt-fallback-claims-sub$$$
14181418

docs/reference/elasticsearch/rest-apis/reindex-indices.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,7 @@ POST _reindex
592592
{
593593
"source": {
594594
"remote": {
595-
"host": "http://otherhost:9200",
595+
"host": "<OTHER_HOST_URL>:9200",
596596
"username": "user",
597597
"password": "pass"
598598
},
@@ -625,7 +625,7 @@ POST _reindex
625625
{
626626
"source": {
627627
"remote": {
628-
"host": "http://otherhost:9200",
628+
"host": "<OTHER_HOST_URL>:9200",
629629
"headers": {
630630
"Authorization": "ApiKey API_KEY_VALUE"
631631
}
@@ -674,7 +674,7 @@ POST _reindex
674674
{
675675
"source": {
676676
"remote": {
677-
"host": "http://otherhost:9200",
677+
"host": "<OTHER_HOST_URL>:9200",
678678
...
679679
},
680680
"index": "source",
@@ -704,7 +704,7 @@ POST _reindex
704704
{
705705
"source": {
706706
"remote": {
707-
"host": "http://otherhost:9200",
707+
"host": "<OTHER_HOST_URL>:9200",
708708
...,
709709
"socket_timeout": "1m",
710710
"connect_timeout": "10s"

docs/reference/enrich-processor/uri-parts-processor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ When the above processor executes on the following document:
4747
```js
4848
{
4949
"_source": {
50-
"input_field": "http://myusername:mypassword@www.example.com:80/foo.gif?key1=val1&key2=val2#fragment"
50+
"input_field": "http://myusername:mypassword@<example-url>:80/foo.gif?key1=val1&key2=val2#fragment"
5151
}
5252
}
5353
```
@@ -56,13 +56,13 @@ It produces this result:
5656

5757
```js
5858
"_source" : {
59-
"input_field" : "http://myusername:mypassword@www.example.com:80/foo.gif?key1=val1&key2=val2#fragment",
59+
"input_field" : "http://myusername:mypassword@<example-url>:80/foo.gif?key1=val1&key2=val2#fragment",
6060
"url" : {
6161
"path" : "/foo.gif",
6262
"fragment" : "fragment",
6363
"extension" : "gif",
6464
"password" : "mypassword",
65-
"original" : "http://myusername:mypassword@www.example.com:80/foo.gif?key1=val1&key2=val2#fragment",
65+
"original" : "http://myusername:mypassword@<example-url>:80/foo.gif?key1=val1&key2=val2#fragment",
6666
"scheme" : "http",
6767
"port" : 80,
6868
"user_info" : "myusername:mypassword",

docs/reference/query-languages/kql.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,11 +57,11 @@ Because this is a `text` field, the order of these search terms does not matter,
5757
http.request.body.content: "null pointer"
5858
```
5959

60-
Certain characters must be escaped by a backslash (unless surrounded by quotes). For example, to search for documents where `http.request.referrer` is [https://example.com](https://example.com), use either of the following queries:
60+
Certain characters must be escaped by a backslash (unless surrounded by quotes). For example, to search for documents where `http.request.referrer` is `https://<example-url>`, use either of the following queries:
6161

6262
```yaml
63-
http.request.referrer: "https://example.com"
64-
http.request.referrer: https\://example.com
63+
http.request.referrer: "https://<example-url>"
64+
http.request.referrer: https\://<example-url>
6565
```
6666

6767
You must escape following characters:

0 commit comments

Comments
 (0)