Skip to content

Commit

Permalink
Disable retention strategy close for new installs (#17552)
Browse files Browse the repository at this point in the history
* disable retention strategy close

* update CL

* revise wording; remove offending space from list

* Update changelog/unreleased/pr-17552.toml

Co-authored-by: Marco Pfatschbacher <marco@graylog.com>

* Update misc/graylog.conf

Co-authored-by: Marco Pfatschbacher <marco@graylog.com>

---------

Co-authored-by: Marco Pfatschbacher <marco@graylog.com>
  • Loading branch information
patrickmann and mpfz0r committed Dec 5, 2023
1 parent bde833e commit 612c4f9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 5 deletions.
12 changes: 9 additions & 3 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ Now this can be achieved by registering a `navigation` plugin.
The plugin entity needs the `description` `System` and `children` (array).
Every child represents a dropdown option and needs a `path` and `description` attribute.

## Configuration File Changes
| Option | Action | Description |
|------------------------------------------------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `disabled_retention_strategies` | **added** | Disables the specified retention strategies. By default, strategies `none` and `close` are now disabled in new installations.<br/>Strategies can be re-enabled simply by removing from this list.<br/>**Do not extend this list on existing installs!** |


## Asset Import Changes

Graylog 5.2 introduced the Assets feature and the ability to import Assets from Active Directory.
Expand All @@ -32,9 +38,9 @@ Any existing Active Directory User Asset import configurations will be automatic

The following Java Code API changes have been made.

| File/method | Description |
|-------------------------------|--------------------------|
| `ExampleClass#exampleFuntion` | TODO placeholder comment |
| File/method | Description |
|--------------------------------|--------------------------|
| `ExampleClass#exampleFunction` | TODO placeholder comment |

## REST API Endpoint Changes

Expand Down
12 changes: 12 additions & 0 deletions changelog/unreleased/pr-17552.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
type = "f"
message = "By default, `none` and `close` index retention strategies are disabled for new installations."

issues = ["graylog-plugin-enterprise#5888"]
pulls = ["17552"]

details.user = """
Configuration setting `disabled_retention_strategies` disables the specified retention strategies.
This is introduced in order to deprecate obsolete strategies in new installations. Strategies can be re-enabled
simply by removing from this list.<br/>
**Do not extend this list on existing installs!**
"""
4 changes: 2 additions & 2 deletions misc/graylog.conf
Original file line number Diff line number Diff line change
Expand Up @@ -394,8 +394,8 @@ stream_aware_field_types=false
# - delete # Deletes the index completely (Default)
# - close # Closes the index and hides it from the system. Can be re-opened later.
# - none # No operation is performed. The index stays open. (Not recommended)
# WARNING: At least one strategy must be enabled
disabled_retention_strategies = none
# WARNING: At least one strategy must be enabled. Be careful when extending this list on existing installations!
disabled_retention_strategies = none,close

# How many indices do you want to keep for the delete and close retention types?
#
Expand Down

0 comments on commit 612c4f9

Please sign in to comment.