mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
[Doc] Add links to the new API key based remote cluster page (#99115)
This PR adds links to the new API key based remote cluster page in multiple places. Relates: #98330
This commit is contained in:
parent
e53bf4edb2
commit
ebe4fe9f15
10 changed files with 32 additions and 29 deletions
|
@ -69,7 +69,7 @@ Refer to <<skip-unavailable-clusters>>.
|
||||||
mode is configured.
|
mode is configured.
|
||||||
|
|
||||||
`cluster_credentials`::
|
`cluster_credentials`::
|
||||||
// TODO: fix the link to new page of API key based remote clusters
|
|
||||||
beta:[]
|
beta:[]
|
||||||
This field presents and has value of `::es_redacted::` only when the remote cluster
|
This field presents and has value of `::es_redacted::` only when the
|
||||||
is configured with the API key based model. Otherwise, the field is not present.
|
<<remote-clusters-api-key,remote cluster is configured with the API key based model>>.
|
||||||
|
Otherwise, the field is not present.
|
||||||
|
|
|
@ -65,12 +65,10 @@ mode are described separately.
|
||||||
is used as the fallback setting.
|
is used as the fallback setting.
|
||||||
|
|
||||||
|
|
||||||
// TODO: fix the link to new page of API key based remote clusters
|
|
||||||
|
|
||||||
`cluster.remote.<cluster_alias>.credentials` (<<secure-settings,Secure>>)::
|
`cluster.remote.<cluster_alias>.credentials` (<<secure-settings,Secure>>)::
|
||||||
|
|
||||||
beta:[]
|
beta:[]
|
||||||
Per cluster setting for configuring remote clusters with the API Key based model.
|
Per cluster setting for configuring <<remote-clusters-api-key,remote clusters with the API Key based model>>.
|
||||||
This setting takes the encoded value of a
|
This setting takes the encoded value of a
|
||||||
<<security-api-create-cross-cluster-api-key,cross-cluster API key>> and must be set
|
<<security-api-create-cross-cluster-api-key,cross-cluster API key>> and must be set
|
||||||
in the <<secure-settings,{es} keystore>> on each node in the cluster.
|
in the <<secure-settings,{es} keystore>> on each node in the cluster.
|
||||||
|
|
|
@ -2569,6 +2569,7 @@ beta::[]
|
||||||
|
|
||||||
:ssl-prefix: xpack.security.remote_cluster_server
|
:ssl-prefix: xpack.security.remote_cluster_server
|
||||||
:component: Remote cluster server (API key based model)
|
:component: Remote cluster server (API key based model)
|
||||||
|
:enabled-by-default:
|
||||||
:client-auth-default: none
|
:client-auth-default: none
|
||||||
:verifies!:
|
:verifies!:
|
||||||
:server:
|
:server:
|
||||||
|
@ -2584,6 +2585,7 @@ beta::[]
|
||||||
|
|
||||||
:ssl-prefix: xpack.security.remote_cluster_client
|
:ssl-prefix: xpack.security.remote_cluster_client
|
||||||
:component: Remote cluster client (API key based model)
|
:component: Remote cluster client (API key based model)
|
||||||
|
:enabled-by-default:
|
||||||
:client-auth-default: none
|
:client-auth-default: none
|
||||||
:verifies:
|
:verifies:
|
||||||
:server!:
|
:server!:
|
||||||
|
@ -2636,13 +2638,14 @@ List of IP addresses to allow for this profile.
|
||||||
(<<dynamic-cluster-setting,Dynamic>>)
|
(<<dynamic-cluster-setting,Dynamic>>)
|
||||||
List of IP addresses to deny for this profile.
|
List of IP addresses to deny for this profile.
|
||||||
|
|
||||||
// TODO: fix the link to new page of API key based remote clusters
|
|
||||||
`xpack.security.remote_cluster.filter.allow`::
|
`xpack.security.remote_cluster.filter.allow`::
|
||||||
(<<dynamic-cluster-setting,Dynamic>>)
|
(<<dynamic-cluster-setting,Dynamic>>)
|
||||||
beta:[] List of IP addresses to allow just for the remote cluster server.
|
beta:[] List of IP addresses to allow just for the
|
||||||
|
<<remote-clusters-api-key,remote cluster server configured with the API key based model>>.
|
||||||
|
|
||||||
`xpack.security.remote_cluster.filter.deny`::
|
`xpack.security.remote_cluster.filter.deny`::
|
||||||
(<<dynamic-cluster-setting,Dynamic>>)
|
(<<dynamic-cluster-setting,Dynamic>>)
|
||||||
beta:[] List of IP addresses to deny just for the remote cluster server.
|
beta:[] List of IP addresses to deny just for the remote cluster server configured with
|
||||||
|
the <<remote-clusters-api-key,API key based model>>.
|
||||||
|
|
||||||
include::security-hash-settings.asciidoc[]
|
include::security-hash-settings.asciidoc[]
|
||||||
|
|
|
@ -1,11 +1,15 @@
|
||||||
==== {component} TLS/SSL settings
|
==== {component} TLS/SSL settings
|
||||||
You can configure the following TLS/SSL settings.
|
You can configure the following TLS/SSL settings.
|
||||||
|
|
||||||
ifdef::server[]
|
|
||||||
+{ssl-prefix}.ssl.enabled+::
|
+{ssl-prefix}.ssl.enabled+::
|
||||||
(<<static-cluster-setting,Static>>)
|
(<<static-cluster-setting,Static>>)
|
||||||
Used to enable or disable TLS/SSL on the {ssl-layer}. The default is `false`.
|
Used to enable or disable TLS/SSL on the {ssl-layer}.
|
||||||
endif::server[]
|
ifdef::enabled-by-default[]
|
||||||
|
The default is `true`.
|
||||||
|
endif::enabled-by-default[]
|
||||||
|
ifndef::enabled-by-default[]
|
||||||
|
The default is `false`.
|
||||||
|
endif::enabled-by-default[]
|
||||||
|
|
||||||
+{ssl-prefix}.ssl.supported_protocols+::
|
+{ssl-prefix}.ssl.supported_protocols+::
|
||||||
(<<static-cluster-setting,Static>>)
|
(<<static-cluster-setting,Static>>)
|
||||||
|
|
|
@ -69,8 +69,8 @@ without requiring basic authentication:
|
||||||
* <<security-api-update-api-key,Update REST API key>>
|
* <<security-api-update-api-key,Update REST API key>>
|
||||||
* <<security-api-bulk-update-api-keys,Bulk update REST API keys>>
|
* <<security-api-bulk-update-api-keys,Bulk update REST API keys>>
|
||||||
|
|
||||||
Use the following APIs to create and update cross-cluster API keys for
|
beta:[] Use the following APIs to create and update cross-cluster API keys for
|
||||||
API key based remote cluster access:
|
<<remote-clusters-api-key,API key based remote cluster access>>:
|
||||||
|
|
||||||
* <<security-api-create-cross-cluster-api-key,Create Cross-Cluster API key>>
|
* <<security-api-create-cross-cluster-api-key,Create Cross-Cluster API key>>
|
||||||
* <<security-api-update-cross-cluster-api-key,Update Cross-Cluster API key>>
|
* <<security-api-update-cross-cluster-api-key,Update Cross-Cluster API key>>
|
||||||
|
|
|
@ -8,7 +8,7 @@ beta::[]
|
||||||
<titleabbrev>Create Cross-Cluster API key</titleabbrev>
|
<titleabbrev>Create Cross-Cluster API key</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Creates an API key of the `cross_cluster` type for the API key based remote cluster access.
|
Creates an API key of the `cross_cluster` type for the <<remote-clusters-api-key,API key based remote cluster>> access.
|
||||||
A `cross_cluster` API key cannot be used to authenticate through the REST interface.
|
A `cross_cluster` API key cannot be used to authenticate through the REST interface.
|
||||||
On the contrary, a <<security-api-create-api-key,REST API key>> is meant to be used through the REST interface
|
On the contrary, a <<security-api-create-api-key,REST API key>> is meant to be used through the REST interface
|
||||||
and cannot be used for the API key based remote cluster access.
|
and cannot be used for the API key based remote cluster access.
|
||||||
|
|
|
@ -77,9 +77,8 @@ For more information, see
|
||||||
`remote_indices`:: beta:[] (list) A list of remote indices permissions entries.
|
`remote_indices`:: beta:[] (list) A list of remote indices permissions entries.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
// TODO: fix the link to new page of API key based remote clusters
|
NOTE: Remote indices are effective for <<remote-clusters-api-key,remote clusters configured with the API key based model>>.
|
||||||
NOTE: Remote indices are effective for remote clusters configured with the API key based model.
|
They have no effect for remote clusters configured with the <<remote-clusters-cert,certificate based model>>.
|
||||||
They have no effect for remote clusters configured with the certificate based model.
|
|
||||||
--
|
--
|
||||||
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
|
`clusters` (required)::: (list) A list of cluster aliases to which the permissions
|
||||||
in this entry apply.
|
in this entry apply.
|
||||||
|
|
|
@ -8,7 +8,7 @@ beta::[]
|
||||||
<titleabbrev>Update Cross-Cluster API key</titleabbrev>
|
<titleabbrev>Update Cross-Cluster API key</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Update an existing cross-cluster API Key.
|
Update an existing cross-cluster API Key that is used for <<remote-clusters-api-key,API key based remote cluster>> access.
|
||||||
|
|
||||||
|
|
||||||
[[security-api-update-cross-cluster-api-key-request]]
|
[[security-api-update-cross-cluster-api-key-request]]
|
||||||
|
|
|
@ -31,10 +31,9 @@ A role is defined by the following JSON structure:
|
||||||
<4> A list of indices permissions entries. This field is optional (missing `indices`
|
<4> A list of indices permissions entries. This field is optional (missing `indices`
|
||||||
privileges effectively mean no index level permissions).
|
privileges effectively mean no index level permissions).
|
||||||
<5> A list of application privilege entries. This field is optional.
|
<5> A list of application privilege entries. This field is optional.
|
||||||
// TODO: fix the link to new page of API key based remote clusters
|
|
||||||
<6> beta:[]
|
<6> beta:[]
|
||||||
A list of indices permissions entries for
|
A list of indices permissions entries for
|
||||||
<<remote-clusters,remote clusters configured with the API key based model>>.
|
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
|
||||||
This field is optional (missing `remote_indices` privileges effectively mean
|
This field is optional (missing `remote_indices` privileges effectively mean
|
||||||
no index level permissions for any API key based remote clusters).
|
no index level permissions for any API key based remote clusters).
|
||||||
|
|
||||||
|
@ -168,8 +167,7 @@ no effect, and will not grant any actions in the
|
||||||
|
|
||||||
beta::[]
|
beta::[]
|
||||||
|
|
||||||
// TODO: fix the link to new page of API key based remote clusters
|
For <<remote-clusters-api-key,remote clusters configured with the API key based model>>, remote indices privileges
|
||||||
For remote clusters configured with the API key based model, remote indices privileges
|
|
||||||
can be used to specify desired indices privileges for matching remote clusters. The final
|
can be used to specify desired indices privileges for matching remote clusters. The final
|
||||||
effective index privileges will be an intersection of the remote indices privileges
|
effective index privileges will be an intersection of the remote indices privileges
|
||||||
and the <<security-api-create-cross-cluster-api-key,cross-cluster API key>>'s indices privileges.
|
and the <<security-api-create-cross-cluster-api-key,cross-cluster API key>>'s indices privileges.
|
||||||
|
|
|
@ -21,7 +21,7 @@ Privileges to create snapshots for existing repositories. Can also list and view
|
||||||
details on existing repositories and snapshots.
|
details on existing repositories and snapshots.
|
||||||
|
|
||||||
`cross_cluster_replication`::
|
`cross_cluster_replication`::
|
||||||
beta:[] Privileges to connect to remote clusters configured with the API key based model
|
beta:[] Privileges to connect to <<remote-clusters-api-key,remote clusters configured with the API key based model>>
|
||||||
for cross-cluster replication.
|
for cross-cluster replication.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
|
@ -32,7 +32,7 @@ to manage cross-cluster API keys.
|
||||||
--
|
--
|
||||||
|
|
||||||
`cross_cluster_search`::
|
`cross_cluster_search`::
|
||||||
beta:[] Privileges to connect to remote clusters configured with the API key based model
|
beta:[] Privileges to connect to <<remote-clusters-api-key,remote clusters configured with the API key based model>>
|
||||||
for cross-cluster search.
|
for cross-cluster search.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
|
@ -301,13 +301,14 @@ requires the `manage` privilege as well, on both the index and the aliases
|
||||||
names.
|
names.
|
||||||
|
|
||||||
`cross_cluster_replication`::
|
`cross_cluster_replication`::
|
||||||
beta:[] Privileges to perform cross-cluster replication for indices located on remote clusters
|
beta:[] Privileges to perform cross-cluster replication for indices located on
|
||||||
configured with the API key based model. This privilege should only be used for
|
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
|
||||||
|
This privilege should only be used for
|
||||||
the `privileges` field of <<roles-remote-indices-priv,remote indices privileges>>.
|
the `privileges` field of <<roles-remote-indices-priv,remote indices privileges>>.
|
||||||
|
|
||||||
`cross_cluster_replication_internal`::
|
`cross_cluster_replication_internal`::
|
||||||
beta:[] Privileges to perform supporting actions for cross-cluster replication from remote clusters
|
beta:[] Privileges to perform supporting actions for cross-cluster replication from
|
||||||
configured with the API key based model.
|
<<remote-clusters-api-key,remote clusters configured with the API key based model>>.
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
NOTE: This privilege should _not_ be directly granted. It is used internally by
|
NOTE: This privilege should _not_ be directly granted. It is used internally by
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue