Skip to content

Commit 0dd823e

Browse files
kilfoyleshainaraskas
kilfoyle
and
shainaraskas
authored
Replace placeholder URLs (#2141)
In light of finding abuse of dummy links in our docs, this replaces placeholder URLs with non-hostable segments. A few thoughts: - I noticed that for Cloud API examples we sometimes use `COORDINATOR_HOST` rather than the variable `$COORDINATOR_HOST`. The latter is safer, and also we explicitly tell users to export that variable in their shell to run the curl API examples. - Some other changes are just for consistency, i.e., using angle brackets for segments that need to be replaced. - Where possible I removed `http` and `https` from dummy URLs, but in some cases it's explicitly the protocol that's being demonstrated, so I left those and changed the url content to contain angle brackets. Rel: #1799 --------- Co-authored-by: shainaraskas <[email protected]>
1 parent 9b9d436 commit 0dd823e

File tree

55 files changed

+151
-151
lines changed

Some content is hidden

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

55 files changed

+151
-151
lines changed

‎deploy-manage/deploy/cloud-enterprise/add-custom-bundles-plugins.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Custom plugins can include the official {{es}} plugins not provided with {{ece}}
7171
"elasticsearch_version" : "<es_version>" <2>
7272
},
7373
{
74-
"url": "http://www.MYURL.com/my-custom-plugin.zip",
74+
"url": "<MY_HOST_URL>/my-custom-plugin.zip",
7575
"name": "my-custom-plugin",
7676
"elasticsearch_version": "7.17.1"
7777
}
@@ -105,7 +105,7 @@ This example adds a custom LDAP bundle for deployment level role-based access co
105105
"user_bundles": [
106106
{
107107
"name": "ldap-cert",
108-
"url": "http://www.MYURL.com/ldapcert.zip", <1>
108+
"url": "<MY_HOST_URL>/ldapcert.zip", <1>
109109
"elasticsearch_version": "*"
110110
}
111111
]
@@ -151,7 +151,7 @@ In this example, we assume the Identity Provider does not publish its SAML metad
151151
"user_bundles": [
152152
{
153153
"name": "saml-metadata",
154-
"url": "http://www.MYURL.com/saml-metadata.zip", <1>
154+
"url": "<MY_HOST_URL>/saml-metadata.zip", <1>
155155
"elasticsearch_version": "*"
156156
}
157157
]
@@ -254,7 +254,7 @@ To import a JVM trust store:
254254
"user_bundles": [
255255
{
256256
"name": "custom-ca-certs",
257-
"url": "http://www.MYURL.com/cacerts.zip", <1>
257+
"url": "<MY_HOST_URL>/cacerts.zip", <1>
258258
"elasticsearch_version": "*" <2>
259259
}
260260
]
@@ -309,7 +309,7 @@ To import a JVM trust store:
309309
"user_bundles": [
310310
{
311311
"name": "custom-geoip-db",
312-
"url": "http://www.MYURL.com/my-geoip-file.zip",
312+
"url": "<MY_HOST_URL>/my-geoip-file.zip",
313313
"elasticsearch_version": "*"
314314
}
315315
]
@@ -359,7 +359,7 @@ To import a JVM trust store:
359359
"user_bundles": [
360360
{
361361
"name": "custom-synonyms",
362-
"url": "http://www.MYURL.com/synonyms.zip",
362+
"url": "<MY_HOST_URL>/synonyms.zip",
363363
"elasticsearch_version": "*"
364364
}
365365
]

‎deploy-manage/deploy/cloud-enterprise/ce-add-support-for-node-roles-autoscaling.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1418,7 +1418,7 @@ Having added support for `node_roles` and autoscaling to your custom template, i
14181418
1. Obtain the existing deployment templates by sending the following `GET` request, and take note of the `id` of the template you wish to update.
14191419

14201420
```sh
1421-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
1421+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
14221422
```
14231423

14241424
2. Send a `PUT` request with the updated template on the payload, in order to effectively replace the outdated template with the new one. Note that the following request is just an example, you have to replace `{{template_id}}` with the `id` you collected on step 1. and set the payload to the updated template JSON. Check [set deployment template API](https://www.elastic.co/docs/api/doc/cloud-enterprise/operation/operation-set-deployment-template-v2) for more details.

‎deploy-manage/deploy/cloud-enterprise/change-endpoint-urls.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ products:
1515
By default, the deployments `CNAME` is set to `LOCAL_HOST_IP.ip.es.io`, where `LOCAL_HOST_IP` is the IP address of the first installed ECE host. This results in the following default endpoint URLs:
1616

1717
```sh
18-
http://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9200
19-
https://CLUSTER_ID.LOCAL_HOST_IP.ip.es.io:9243
18+
http://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9200
19+
https://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9243
2020
```
2121

2222
::::{important}

‎deploy-manage/deploy/cloud-enterprise/configure-allocator-affinity.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ $$$fill-anti-affinity$$$`fill-anti-affinity` (default)
4242
To check how allocator affinity is currently configured:
4343

4444
```sh
45-
curl -X GET -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
45+
curl -X GET -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
4646
{
4747
"errors": [{
4848
"code": "platform.config.store.not_found",
@@ -56,7 +56,7 @@ If a configuration option cannot be found, the default `fill-anti-affinity` stra
5656
To set allocator affinity to the `distribute-anti-affinity` strategy:
5757

5858
```sh
59-
curl -X POST -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute-anti-affinity\" }" }'
59+
curl -X POST -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute-anti-affinity\" }" }'
6060
{
6161
"changed": false,
6262
"name": "constructor",
@@ -67,7 +67,7 @@ curl -X POST -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform
6767
To update allocator affinity to the `distribute` strategy:
6868

6969
```sh
70-
curl -X PUT -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute\" }" }'
70+
curl -X PUT -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor -H 'Content-Type: application/json' -d '{ "value": "{ \"allocator_prioritization\": \"distribute\" }" }'
7171
{
7272
"changed": true,
7373
"name": "constructor",
@@ -78,7 +78,7 @@ curl -X PUT -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/
7878
To change allocator affinity back to the default behavior:
7979

8080
```sh
81-
curl -X DELETE -u admin:PASSWORD -k https://COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
81+
curl -X DELETE -u admin:PASSWORD -k https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/store/constructor
8282
{
8383

8484
}

‎deploy-manage/deploy/cloud-enterprise/configure-host-rhel.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ Make sure to use a supported combination of Linux distribution and container eng
144144

145145
```text
146146
[engine]
147-
env = ["HTTP_PROXY=http://{proxy-ip}:{proxy-port}", "HTTPS_PROXY=http://{proxy-ip}:{proxy-port}"]
147+
env = ["HTTP_PROXY=http://<PROXY_IP>:<PROXY_PORT>", "HTTPS_PROXY=http://<PROXY_IP>:<PROXY_PORT>"]
148148
```
149149

150150
7. Reload systemd configuration

‎deploy-manage/deploy/cloud-enterprise/connect-elasticsearch.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Once you have the endpoint, use it in your client application. To test connectiv
3232
* Modify the following `curl` example to fit your environment by replacing the URL and proxy CA certificate with your own values.
3333

3434
```sh
35-
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://f76e96da2a7f4d3f8f3ee25d686b879c.HOST-IP-ADDRESS.ip.es.io:9243
35+
curl --cacert /path/to/elastic-ece-ca-cert.pem -u elastic https://<CLUSTER_ID.LOCAL_HOST_IP>.ip.es.io:9243
3636
{
3737
"name" : "instance-0000000000",
3838
"cluster_name" : "f76e96da2a7f4d3f8f3ee25d686b879c",

‎deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-configure-system-templates.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The API user must have the `Platform admin` role in order to configure system te
2828
1. Obtain the existing system deployment template you wish to modify. Note the `id` of the system deployment template as you will include this value in the API call to edit the template.
2929

3030
```sh
31-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
31+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
3232
```
3333

3434
2. Edit the JSON of the system deployment template you wish to modify.

‎deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-create-templates.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Before you start creating your own deployment templates, you should have: [tagge
8989
1. Obtain the existing deployment templates to get some examples of what the required JSON looks like. You can take the JSON for one of the existing templates and modify it to create a new template, similar to what gets shown in the next step.
9090

9191
```sh
92-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
92+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/deployments/templates?region=ece-region
9393
```
9494

9595
2. Post the JSON for your new deployment template.

‎deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-instance-configurations-create.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,15 +60,15 @@ Before you start creating your own instance configurations, you should have [tag
6060
1. Obtain the existing instance configurations to get some examples of what the required JSON looks like. You can take the JSON for one of the existing configurations and modify it to create a new instance configuration, similar to what gets shown in the next step.
6161

6262
```sh
63-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/configuration/instances
63+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/instances
6464
```
6565

6666
2. Post the JSON for your new instance configuration.
6767

6868
The following examples creates an instance configuration for machine learning with size increments that start at the recommended minimum of 16 GB of memory. To make sure that machine learning nodes get deployed only on the right allocators, this instance configuration also filters for [allocator tags from our earlier example](ece-configuring-ece-tag-allocators.md) to match only allocators with high CPU resources and SSD storage.
6969

7070
```sh
71-
curl -k -X POST -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/configuration/instances -H 'content-type: application/json' -d '{
71+
curl -k -X POST -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/configuration/instances -H 'content-type: application/json' -d '{
7272
"name": "Machine Learning Only",
7373
"description": "Custom machine learning instance configuration",
7474
"storage_multiplier": 32.0,

‎deploy-manage/deploy/cloud-enterprise/ece-configuring-ece-tag-allocators.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ If you have an allocator that meets several criteria, such as an allocator with
7777
1. Get a list of the allocators in your ECE installation:
7878

7979
```sh
80-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators
80+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators
8181
```
8282

8383
::::{note}
@@ -87,7 +87,7 @@ If you have an allocator that meets several criteria, such as an allocator with
8787
2. $$$check-allocator-tags$$$Check what tags have already been assigned to your allocators. In a new or newly upgraded ECE installation, this command returns `[]`, which means that you have not assigned any tags, yet.
8888

8989
```sh
90-
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata
90+
curl -k -X GET -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata
9191
```
9292

9393
`ALLOCATOR_ID`
@@ -102,7 +102,7 @@ If you have an allocator that meets several criteria, such as an allocator with
102102
* Example: To assign a single `highCPU: true` tag to an allocator:
103103

104104
```sh
105-
curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata/highCPU -H 'content-type: application/json' -d '{ "value": "true" }'
105+
curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata/highCPU -H 'content-type: application/json' -d '{ "value": "true" }'
106106
[{
107107
"key": "highCPU",
108108
"value": "true"
@@ -114,7 +114,7 @@ If you have an allocator that meets several criteria, such as an allocator with
114114
* Example: To assign multiple tags to an allocator with a single command:
115115

116116
```sh
117-
curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata -H 'content-type: application/json' -d '
117+
curl -k -X PUT -H "Authorization: ApiKey $ECE_API_KEY" https://$COORDINATOR_HOST:12443/api/v1/platform/infrastructure/allocators/ALLOCATOR_ID/metadata -H 'content-type: application/json' -d '
118118
{
119119
"items": [
120120
{

0 commit comments

Comments
 (0)