Skip to content

[DOCS] Remove xref - 'tls' and remove 'ccr' from tag names #153

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.

Sign up for GitHub

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

Merged
setiah merged 3 commits into from
Mar 14, 2021
Merged

[DOCS] Remove xref - 'tls' and remove 'ccr' from tag names #153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3ebcfa0
Remove xref - <<tls-transport - Nodes reload secure settings
Feb 27, 2021
454bec1
Remove xref - <<configuring-tls - remote clusters
Feb 27, 2021
508c526
Remove 'ccr' from tag '[[ccr-index-soft-delete]]' and '[[ccr-index-so…
Feb 27, 2021
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
2 changes: 1 addition & 1 deletion docs/reference/cluster/nodes-reload-secure-settings.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ When the {es} keystore is password protected and not simply obfuscated, you must
provide the password for the keystore when you reload the secure settings.
Reloading the settings for the whole cluster assumes that all nodes' keystores
are protected with the same password; this method is allowed only when
<<tls-transport,inter-node communications are encrypted>>. Alternatively, you can
inter-node communications are encrypted. Alternatively, you can
reload the secure settings on each node by locally accessing the API and passing
the node-specific {es} keystore password.

Expand Down
12 changes: 6 additions & 6 deletions docs/reference/index-modules.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,24 +95,24 @@ indices.
than the `index.number_of_shards` unless the `index.number_of_shards` value is also 1.
See <<routing-index-partition>> for more details about how this setting is used.

[[ccr-index-soft-deletes]]
// tag::ccr-index-soft-deletes-tag[]
[[index-soft-deletes]]
// tag::index-soft-deletes-tag[]
`index.soft_deletes.enabled`::
deprecated:[7.6.0, Creating indices with soft-deletes disabled is deprecated and will be removed in future Elasticsearch versions.]
Indicates whether soft deletes are enabled on the index. Soft deletes can only
be configured at index creation and only on indices created on or after
{es} 6.5.0. Defaults to `true`.
// end::ccr-index-soft-deletes-tag[]
// end::index-soft-deletes-tag[]

[[ccr-index-soft-deletes-retention-period]]
//tag::ccr-index-soft-deletes-retention-tag[]
[[index-soft-deletes-retention-period]]
//tag::index-soft-deletes-retention-tag[]
`index.soft_deletes.retention_lease.period`::
The maximum period to retain a shard history retention lease before it is
considered expired. Shard history retention leases ensure that soft deletes are
retained during merges on the Lucene index. If a soft delete is merged away
before it can be replicated to a follower the following process will fail due
to incomplete history on the leader. Defaults to `12h`.
//end::ccr-index-soft-deletes-retention-tag[]
//end::index-soft-deletes-retention-tag[]

[[load-fixed-bitset-filters-eagerly]] `index.load_fixed_bitset_filters_eagerly`::

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/index-modules/history-retention.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,6 @@ there>>. {ccr-cap} will not function if soft deletes are disabled.
[discrete]
=== History retention settings

include::{es-ref-dir}/index-modules.asciidoc[tag=ccr-index-soft-deletes-tag]
include::{es-ref-dir}/index-modules.asciidoc[tag=index-soft-deletes-tag]

include::{es-ref-dir}/index-modules.asciidoc[tag=ccr-index-soft-deletes-retention-tag]
include::{es-ref-dir}/index-modules.asciidoc[tag=index-soft-deletes-retention-tag]
3 changes: 1 addition & 2 deletions docs/reference/modules/remote-clusters.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,11 +324,10 @@ separately.
The number of socket connections to open per remote cluster. The default is
`18`.

[role="xpack"]
`cluster.remote.<cluster_alias>.server_name`::

An optional hostname string which is sent in the `server_name` field of
the TLS Server Name Indication extension if
<<configuring-tls,TLS is enabled>>. The TLS transport will fail to open
Copy link
Contributor

@setiah setiah Mar 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isn't this only supported for x-pack?

Copy link
Contributor Author

@tlfeng tlfeng Mar 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right. My concerns is if a remote cluster enabled TLS by external plugins (such as ODFE security plugin), the setting server_name may be available for the remote cluster, but I didn't validate this idea.
I saw the setting server_name is implemented in the server directory which exists in this repo.
https://github.com/opendistro-for-elasticsearch/search/blob/8f879208552904c49459aea5c163b320b9e219db/server/src/main/java/org/elasticsearch/transport/ProxyConnectionStrategy.java#L75
What do you think?

Copy link
Contributor Author

@tlfeng tlfeng Mar 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm. ODFE security plugin has got the "host name verification", but seems it's not utilizing the value from this setting.

Copy link
Contributor Author

@tlfeng tlfeng Mar 9, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The situation is the setting server_name exists in the "server" directory, but it is not used in Opensearch core or ODFE security plugin.

TLS is enabled. The TLS transport will fail to open
remote connections if this field is not a valid hostname as defined by the
TLS SNI specification.