Skip to content

Commit

Permalink
Generate release notes for v8.3.0 (elastic#87294)
Browse files Browse the repository at this point in the history
* Generate release notes for v8.3.0

* [DOCS] Add 8.3 migration file to index

* Fixed version number

* Fix formatting of deprecation in 85326

* Use asciidoc format for deprecations

* Extract static content from migration/index

* This was just an enhancement

* Nope, it was an upgrade

* Added migration/index.asciidoc generation support (elastic#87318)

Including extracting static content from migration/index, so the template would be as light as possible.

The reason for this work is because the gradle task `generateReleaseNotes` was not correctly adding new links and imports to the migrations/index and that caused documentation to fail building for 8.3.0.

* [DOCS] Add ml-cpp PRs to release notes

* Added back incorrectly deleted changlog

* Added missing highlight

* Fixed spelling of StackOverflowError

Co-authored-by: lcawl <[email protected]>
  • Loading branch information
craigtaverner and lcawl committed Jun 29, 2022
1 parent 100f5ac commit 303b088
Show file tree
Hide file tree
Showing 6 changed files with 490 additions and 11 deletions.
17 changes: 17 additions & 0 deletions docs/changelog/86261.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
pr: 86261
summary: Snapshots as simple archives
area: Search
type: feature
issues:
- 81210
highlight:
title: Reading indices from older Elasticsearch versions
body: |-
Elasticsearch has full query and write support for indices created in the previous major
version. If you have indices created in Elasticsearch versions 5 or 6, you can now use
the archive functionality to import and query these indices as well.
The archive functionality provides slower read-only access to older data,
for compliance or regulatory reasons, the occasional lookback or investigation,
or to rehydrate parts of it. Access to the data is expected to be infrequent,
and can therefore happen with limited performance and query capabilities.
notable: true
4 changes: 3 additions & 1 deletion docs/reference/migration/index.asciidoc
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
include::migration_intro.asciidoc[]

* <<migrating-8.1,Migrating to 8.2>>
* <<migrating-8.3,Migrating to 8.3>>
* <<migrating-8.2,Migrating to 8.2>>
* <<migrating-8.1,Migrating to 8.1>>
* <<migrating-8.0,Migrating to 8.0>>
include::migrate_8_3.asciidoc[]
include::migrate_8_2.asciidoc[]
include::migrate_8_1.asciidoc[]
include::migrate_8_0.asciidoc[]
Expand Down
62 changes: 62 additions & 0 deletions docs/reference/migration/migrate_8_3.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
[[migrating-8.3]]
== Migrating to 8.3
++++
<titleabbrev>8.3</titleabbrev>
++++

This section discusses the changes that you need to be aware of when migrating
your application to {es} 8.3.

See also <<release-highlights>> and <<es-release-notes>>.

coming::[8.3.0-SNAPSHOT]


[discrete]
[[breaking-changes-8.3]]
=== Breaking changes

There are no breaking changes in {es} 8.3.


[discrete]
[[deprecated-8.3]]
=== Deprecations

The following functionality has been deprecated in {es} 8.3
and will be removed in a future version.
While this won't have an immediate impact on your applications,
we strongly encourage you take the described steps to update your code
after upgrading to 8.3.

To find out if you are using any deprecated functionality,
enable <<deprecation-logging, deprecation logging>>.


[discrete]
[[deprecations_83_cluster_and_node_setting]]
==== Cluster and node setting deprecations

[[configuring_bind_dn_in_an_ldap_or_active_directory_ad_realm_without_corresponding_bind_password_deprecated]]
.Configuring a bind DN in an LDAP or Active Directory (AD) realm without a corresponding bind password is deprecated
[%collapsible]
====
*Details* +
For LDAP or AD authentication realms, setting a bind DN (via the
`xpack.security.authc.realms.ldap.*.bind_dn` realm setting) without a
bind password is a misconfiguration that may prevent successful
authentication to the node. In the next major release, nodes will fail
to start if a bind DN is specified without a password.
*Impact* +
If you have a bind DN configured for an LDAP or AD authentication
realm, set a bind password for {ref}/ldap-realm.html#ldap-realm-configuration[LDAP]
or {ref}/active-directory-realm.html#ad-realm-configuration[Active Directory].
Configuring a bind DN without a password generates a warning in the
deprecation logs.
*Note:* This deprecation only applies if your current LDAP or AD
configuration specifies a bind DN without a password. This scenario is
unlikely, but might impact a small subset of users.
====

2 changes: 2 additions & 0 deletions docs/reference/release-notes.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@

This section summarizes the changes in each release.

* <<release-notes-8.3.0>>
* <<release-notes-8.2.3>>
* <<release-notes-8.2.2>>
* <<release-notes-8.2.1>>
Expand All @@ -24,6 +25,7 @@ This section summarizes the changes in each release.

--

include::release-notes/8.3.0.asciidoc[]
include::release-notes/8.2.3.asciidoc[]
include::release-notes/8.2.2.asciidoc[]
include::release-notes/8.2.1.asciidoc[]
Expand Down
Loading

0 comments on commit 303b088

Please sign in to comment.