|
1 | | -Upgrading to Graylog 7.0.x |
| 1 | +Upgrading to Graylog 7.1.x |
2 | 2 | ========================== |
3 | 3 |
|
4 | 4 | ## Breaking Changes |
5 | 5 |
|
6 | | -### Java 21 |
7 | | - |
8 | | -Graylog now requires Java 21 to run. Earlier versions are no longer supported. |
9 | | - |
10 | | -Our operating system packages and container images are shipping with the |
11 | | -correct Java version. |
12 | | - |
13 | | -### Mongo DB 7.0 |
14 | | - |
15 | | -Graylog now requires at least Mongo DB version 7.0. Earlier versions are no longer supported. |
16 | | - |
17 | | -In general, MongoDB upgrades must be done from one minor release to the next, going to the latest bug fix version |
18 | | -in that release. Please refer to the Mongo DB upgrade documentation for details: |
19 | | -- [Upgrade tutorial](https://www.mongodb.com/docs/manual/tutorial/upgrade-revision/#std-label-upgrade-to-latest-revision/) |
20 | | -- [6.0](https://www.mongodb.com/docs/v6.0/release-notes/6.0/#upgrade-procedures) |
21 | | -- [7.0](https://www.mongodb.com/docs/manual/release-notes/7.0-upgrade/) |
22 | | -- [8.0](https://www.mongodb.com/docs/manual/release-notes/8.0-upgrade/) |
23 | | - |
24 | | -Graylog users who cannot upgrade to MongoDB >= 7.0 prior to upgrading Graylog to 7.0.x can disable Graylog's preflight |
25 | | -check via its configuration setting (`skip_preflight_checks = true`) to let Graylog start regardless of the used MongoDB |
26 | | -version. This approach is not recommended though, as Graylog might start using MongoDB 7.0 features over the course of |
27 | | -the Graylog 7.x series. |
28 | | - |
29 | | -### Kafka Inputs |
30 | | - |
31 | | -The `kafka-clients` library was updated to 4.x which removes support for Kafka |
32 | | -brokers with version 2.0 and earlier. That means all Graylog 7.0 Kafka inputs |
33 | | -can only talk to Kafka brokers with version 2.1 or newer. |
34 | | - |
35 | | -### Enterprise Theme Color Customization |
36 | | - |
37 | | -The logic for generating color shades based on custom-defined color variants (error, informative, etc.) |
38 | | -has been slightly adjusted. This change ensures that the exact color specified in the customization settings |
39 | | -is now used as the primary color for elements like buttons and badges in the UI. |
40 | | - |
41 | | -### Renaming "Data Warehouse" to "Data Lake" |
42 | | -The feature previously known as "Data Warehouse" is now completely renamed to "Data Lake". That includes not only text |
43 | | -visible to the user, but with version 7.0 also a lot of places being usually invisible to the regular user, such as API |
44 | | -endpoints, the content of the database, permissions and much more. |
45 | | - |
46 | | -#### API Endpoints and permissions |
47 | | -All endpoints related to data lake have changed their URLs accordingly. As also noted in |
48 | | -the [REST API endpoint Changes](#rest-api-endpoint-changes), all endpoints previously accessible at |
49 | | -`/api/plugins/org.graylog.plugins.datawarehouse/data_warehouse/...` are now moved to |
50 | | -`/api/plugins/org.graylog.plugins.datalake/data_lake/...`. Similarly, all permissions regarding data lake are renamed |
51 | | -from `data_warehouse...` to `data_lake...`. |
52 | | - |
53 | | -#### Database content |
54 | | -Three entire collections are renamed: |
55 | | -- `data_warehouse_archive_config` to `data_lake_archive_config` |
56 | | -- `data_warehouse_backends` to `data_lake_backends` |
57 | | -- `data_warehouse_catalog` to `data_lake_catalog` |
58 | | - |
59 | | -Also, documents of the following collections are updated to reflect the change in names: |
60 | | -- `cluster_config` for migrations related to data lake |
61 | | -- `enterprise_traffic` |
62 | | -- `scheduler_job_definitions` |
63 | | -- `scheduler_triggers`, in case a data lake optimization job is already scheduled. |
64 | | - |
65 | | -#### Audit logs |
66 | | -Audit logs having been written before the update are not changed. However, all audit logs from after the update contain |
67 | | -the term "Data Lake" instead of "Data Warehouse". |
68 | | - |
69 | | -#### Metrics |
70 | | -Just like audit logs, metrics from before the update to version 7.0 are not changed. Starting with version 7.0, the |
71 | | -names of data lake related metrics change accordingly. |
72 | | - |
| 6 | +tbd |
73 | 7 |
|
74 | 8 | ## Configuration File Changes |
75 | 9 |
|
76 | 10 | | Option | Action | Description | |
77 | 11 | |--------|-----------|-------------| |
78 | 12 | | `tbd` | **added** | | |
79 | 13 |
|
80 | | -## Default Configuration Changes |
81 | | - |
82 | | -- The permission to view the "Cluster Configuration" page was removed from the `Reader` role. This permission is now |
83 | | - available with the `Cluster Configuration Reader` role. There is an automatic one-time migration to add this role to |
84 | | - all existing users with the `Reader` role to ensure backwards compatibility. New users that will be created in the |
85 | | - future need to be explicitly assigned to the `Cluster Configuration Reader` role if they should be able to access the |
86 | | - page. |
87 | | -- Only admins are allowed to create a new API token. Existing tokens are not affected by this change. Also, new tokens |
88 | | - will expire after 30 days by default. |
89 | | - |
90 | 14 | ## Java API Changes |
91 | 15 |
|
92 | 16 | - tbd |
93 | 17 |
|
94 | | -## General REST API Changes |
95 | | - |
96 | | -- In Graylog 7.0, an issue was fixed that previously allowed additional unknown JSON properties to be accepted |
97 | | - (and ignored) in API requests on the Graylog leader node. Now that the issue has been fixed, API requests on the |
98 | | - leader node will once again only accept JSON payloads that contain explicitly mapped/supported properties. |
99 | | -- APIs for entity creation now use a parameter `CreateEntityRequest` to keep entity fields separated from sharing |
100 | | - information. This is a breaking change for all API requests that create entities, such as streams, dashboards, etc. |
101 | | - <br> Affected entities: |
102 | | - - Search / Dashboard |
103 | | - - Search Filter |
104 | | - - Report |
105 | | - - Event Definition |
106 | | - - Stream |
107 | | - - Notifications |
108 | | - - Sigma rules |
109 | | - - Event procedure |
110 | | - - Event step |
111 | | - - Content Pack installation |
112 | | - - Teams |
113 | | - - Illuminate Pack installation |
114 | | - |
115 | | - <br> For example, the request payload to create a stream might now look like this: |
116 | | - |
117 | | -```json |
118 | | -{ |
119 | | - "entity": { |
120 | | - "index_set_id": "65b7ba138cdb8c534a953fef", |
121 | | - "description": "An example stream", |
122 | | - "title": "My Stream", |
123 | | - "remove_matches_from_default_stream": false |
124 | | - }, |
125 | | - "share_request": { |
126 | | - "selected_grantee_capabilities": { |
127 | | - "grn::::search:684158906442150b2eefb78c": "own" |
128 | | - } |
129 | | - } |
130 | | -} |
131 | | -``` |
132 | | - |
133 | | -- Access to the API browser now requires the `api_browser:read` permission. This permission can be granted by assigning |
134 | | - the new “API Browser Reader” role to a user. |
135 | | - |
136 | 18 | ## REST API Endpoint Changes |
137 | 19 |
|
138 | 20 | The following REST API changes have been made. |
139 | 21 |
|
140 | | -| Endpoint | Description | |
141 | | -|-----------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| |
142 | | -| `GET /system/urlallowlist` | Renamed from `GET /system/urlwhitelist`. The corresponding REST API permission is renamed to `urlallowlist:read`. | |
143 | | -| `PUT /system/urlallowlist` | Renamed from `PUT /system/urlwhitelist`. The corresponding REST API permission is renamed to `urlallowlist:write` | |
144 | | -| `POST /system/urlallowlist/check` | Renamed from `POST /system/urlwhitelist/check` | |
145 | | -| `POST /system/urlallowlist/generate_regex` | Renamed from `POST /system/urlwhitelist/generate_regex` | |
146 | | -| All `/api/plugins/org.graylog.plugins.datalake/data_lake/...` | Renamed from `/api/plugins/org.graylog.plugins.datawarehouse/data_warehouse/...`. The corresponding permissions are also renamed to `data_lake...` | |
147 | | -| All `/api/plugins/org.graylog.plugins.securityapp.asset/assets/history/...` | Removed all endpoints. Contents of underlying `asset_history` MongoDB collection migrated to `Asset History` Index set and Stream | |
148 | | -| `GET /<endpoint>` | description | |
149 | | - |
150 | | - |
151 | | -## Deprecation of old Search Backends |
152 | | - |
153 | | -### Deprecation of Elasticsearch |
154 | | - |
155 | | -Graylog introduced support for OpenSearch as its new search backend in 2022. To simplify the installation and management |
156 | | -of OpenSearch, the Graylog Data Node component was later developed. Today, Data Node or a self-managed OpenSearch |
157 | | -deployment are the preferred search backend options for running Graylog. |
158 | | - |
159 | | -Starting with Graylog 7.0, the use of Elasticsearch as a search backend is deprecated. |
160 | | - |
161 | | -Graylog users are encouraged to migrate to Data Node or self-managed OpenSearch, as Elasticsearch support will be |
162 | | -removed entirely in Graylog 8.0. |
163 | | - |
164 | | -### Deprecation of OpenSearch 1.x |
165 | | - |
166 | | -According to the official OpenSearch Maintenance Policy, the OpenSearch 1.x maintenance window ended in May 2025. As a |
167 | | -result, OpenSearch 1.x will no longer receive back-port fixes or features. |
168 | | - |
169 | | -Therefore, starting with Graylog 7.0, the use of OpenSearch 1.x is deprecated. Support for OpenSearch 1.x will be |
170 | | -removed in Graylog 8.0. |
171 | | - |
172 | | -Graylog users are encouraged to use Graylog Data Node or a supported, self-managed version of OpenSearch. See Graylog's |
173 | | -Compatibility Matrix for details on supported OpenSearch versions. |
174 | | - |
175 | | -Links: |
176 | | -- [OpenSearch Release Schedule and Maintenance Policy](https://opensearch.org/releases/) |
177 | | -- [Graylog Data Node](https://go2docs.graylog.org/current/downloading_and_installing_graylog/install_graylog_data_node.htm) |
178 | | -- [Graylog Compatibility Matrix](https://go2docs.graylog.org/current/downloading_and_installing_graylog/compatibility_matrix.htm) |
| 22 | +| Endpoint | Description | |
| 23 | +|----------------------|------------------------------------| |
| 24 | +| `GET /<endpoint>` | Description of the endpoint change | |
0 commit comments