Skip to content

Commit 648c9cb

Browse files
authored
[DOCS] Add azure storage secure settings while the node is running (#107163)
1 parent 0f09fda commit 648c9cb

File tree

4 files changed

+20
-6
lines changed

4 files changed

+20
-6
lines changed

docs/reference/setup/secure-settings.asciidoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,11 @@ are node-specific settings that must have the same value on every node.
2525
Just like the settings values in `elasticsearch.yml`, changes to the keystore
2626
contents are not automatically applied to the running {es} node. Re-reading
2727
settings requires a node restart. However, certain secure settings are marked as
28-
*reloadable*. Such settings can be <<cluster-nodes-reload-secure-settings, re-read and applied on a running node>>.
28+
*reloadable*. Such settings can be re-read and applied on a running node.
29+
30+
You can define these settings before the node is started,
31+
or call the <<cluster-nodes-reload-secure-settings,Nodes reload secure settings API>>
32+
after the settings are defined to apply them to a running node.
2933

3034
The values of all secure settings, *reloadable* or not, must be identical
3135
across all cluster nodes. After making the desired secure settings changes,

docs/reference/snapshot-restore/repository-azure.asciidoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ You can use https://docs.microsoft.com/en-us/azure/storage/blobs/storage-blobs-i
66
[[repository-azure-usage]]
77
==== Setup
88

9-
To enable Azure repositories, you have first to define your azure storage settings as
10-
{ref}/secure-settings.html[secure settings], before starting up the node:
9+
To enable Azure repositories, you have first to define your Azure storage settings as
10+
{ref}/secure-settings.html[secure settings].
11+
12+
You can define these settings before the node is started, or call the <<cluster-nodes-reload-secure-settings,Nodes reload secure settings API>> after the settings are defined to apply them to a running node.
1113

1214
[source,sh]
1315
----------------------------------------------------------------

docs/reference/snapshot-restore/repository-gcs.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,10 @@ PUT _snapshot/my_gcs_repository
117117
// TEST[skip:we don't have gcs setup while testing this]
118118

119119
The `credentials_file` settings are {ref}/secure-settings.html#reloadable-secure-settings[reloadable].
120+
You can define these settings before the node is started,
121+
or call the <<cluster-nodes-reload-secure-settings,Nodes reload secure settings API>>
122+
after the settings are defined to apply them to a running node.
123+
120124
After you reload the settings, the internal `gcs` clients, which are used to
121125
transfer the snapshot contents, utilize the latest settings from the keystore.
122126

docs/reference/snapshot-restore/repository-s3.asciidoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ For more information about creating and updating the {es} keystore, see
5656
{ref}/secure-settings.html[Secure settings].
5757

5858
For example, if you want to use specific credentials to access S3 then run the
59-
following commands to add these credentials to the keystore:
59+
following commands to add these credentials to the keystore.
6060

6161
[source,sh]
6262
----
@@ -80,8 +80,12 @@ bin/elasticsearch-keystore remove s3.client.default.session_token
8080
----
8181

8282
*All* client secure settings of this repository type are
83-
{ref}/secure-settings.html#reloadable-secure-settings[reloadable]. After you
84-
reload the settings, the internal `s3` clients, used to transfer the snapshot
83+
{ref}/secure-settings.html#reloadable-secure-settings[reloadable].
84+
You can define these settings before the node is started,
85+
or call the <<cluster-nodes-reload-secure-settings,Nodes reload secure settings API>>
86+
after the settings are defined to apply them to a running node.
87+
88+
After you reload the settings, the internal `s3` clients, used to transfer the snapshot
8589
contents, will utilize the latest settings from the keystore. Any existing `s3`
8690
repositories, as well as any newly created ones, will pick up the new values
8791
stored in the keystore.

0 commit comments

Comments
 (0)