Skip to content

Commit ad7981a

Browse files
committed
identifiers: added related identifiers config var
1 parent c424795 commit ad7981a

File tree

2 files changed

+32
-27
lines changed

2 files changed

+32
-27
lines changed

docs/releases/vNext/upgrade-vNext.md

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ InvenioRDM v13.
1717
Always backup your database, statistics indices and files before you try to perform an upgrade.
1818

1919
!!! info "Older Versions"
20-
If your InvenioRDM installation is older than v13, you must first upgrade
21-
to v13 before proceeding with the steps in this guide.
20+
If your InvenioRDM installation is older than v13, you must first upgrade
21+
to v13 before proceeding with the steps in this guide.
2222

2323
## Upgrade Steps
2424

@@ -38,12 +38,13 @@ invenio-cli, version 1.9.0
3838
### Upgrade InvenioRDM
3939

4040
#### Requirements
41+
4142
Python 3.9 or 3.11 or 3.12 is required to run InvenioRDM v13.
4243

4344
!!! info "Python 3.9 end-of-life"
44-
Official support for Python 3.9 will end on October 31, 2025.
45-
See the [official Python version status page](https://devguide.python.org/versions/) for more information.
46-
Future releases of InvenioRDM will require a more recent Python version.
45+
Official support for Python 3.9 will end on October 31, 2025.
46+
See the [official Python version status page](https://devguide.python.org/versions/) for more information.
47+
Future releases of InvenioRDM will require a more recent Python version.
4748

4849
The minimum required OpenSearch version is now **v2.12**. See [below](#opensearch-version) on how to upgrade older versions.
4950

@@ -52,20 +53,20 @@ The minimum required OpenSearch version is now **v2.12**. See [below](#opensearc
5253
To start using the new Record Deletion feature, one needs to go through the following steps during deployment:
5354

5455
1. Update mappings and removal reasons vocabulary using new code in a terminal
55-
- Update mappings
56-
- Records and drafts have a `tombstone.deletion_policy` (optional) field
57-
- `invenio index update --no-check rdmrecords-records-record-v7.0.0`
58-
- `invenio index update --no-check rdmrecords-drafts-draft-v6.0.0`
59-
- Update OAI-PMH precolators index for records (see [recipe below](#oai-pmh-percolator-mapping-update))
60-
- Update request mappings to add the `last_reply` and `last_activity_at` fields
61-
- `invenio index update --no-check requests-request-v1.0.0`
62-
- Apply the [`invenio_request@1759321170` alembic migration](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/alembic/1759321170_add_index_to_request_events_request_id_.py)
63-
- `invenio alembic upgrade invenio_requests@1759321170` (or just `invenio alembic upgrade` if you're doing a full upgrade)
64-
- Update removal reasons vocabulary to add `request-deletion` tags
65-
- `invenio rdm-records add-to-fixture removalreasons`
66-
3. Deploy code to the rest of web and workers
67-
4. Reindex all requests to populate the `last_reply` and `last_activity_at` fields
68-
- `invenio rdm-records rebuild-all-indices --order requests`
56+
- Update mappings
57+
- Records and drafts have a `tombstone.deletion_policy` (optional) field
58+
- `invenio index update --no-check rdmrecords-records-record-v7.0.0`
59+
- `invenio index update --no-check rdmrecords-drafts-draft-v6.0.0`
60+
- Update OAI-PMH precolators index for records (see [recipe below](#oai-pmh-percolator-mapping-update))
61+
- Update request mappings to add the `last_reply` and `last_activity_at` fields
62+
- `invenio index update --no-check requests-request-v1.0.0`
63+
- Apply the [`invenio_request@1759321170` alembic migration](https://github.com/inveniosoftware/invenio-requests/blob/master/invenio_requests/alembic/1759321170_add_index_to_request_events_request_id_.py)
64+
- `invenio alembic upgrade invenio_requests@1759321170` (or just `invenio alembic upgrade` if you're doing a full upgrade)
65+
- Update removal reasons vocabulary to add `request-deletion` tags
66+
- `invenio rdm-records add-to-fixture removalreasons`
67+
2. Deploy code to the rest of web and workers
68+
3. Reindex all requests to populate the `last_reply` and `last_activity_at` fields
69+
- `invenio rdm-records rebuild-all-indices --order requests`
6970

7071
##### OAI-PMH percolator mapping update
7172

@@ -103,6 +104,7 @@ oaipmh_service.rebuild_index(identity=system_identity)
103104
```
104105

105106
#### Upgrade option 1: In-place
107+
106108
This approach upgrades the dependencies in place. At the end of the process,
107109
your virtual environment for the v13 version will be completely replaced
108110
with the vNext environment and dependencies.
@@ -176,7 +178,7 @@ source <path to virtualenvs>/bin/activate
176178
This step ensures that all subsequent commands use the correct Python environment and installed dependencies.
177179

178180
!!! note
179-
If you are upgrading in an environment that does not use a Python virtualenv, you can skip this step.
181+
If you are upgrading in an environment that does not use a Python virtualenv, you can skip this step.
180182

181183
### Database migration
182184

@@ -210,13 +212,12 @@ From v12 onwards, search indices for statistics (record's views and downloads) a
210212
affected by `invenio index destroy --yes-i-know` and are totally functional after the rebuild step.
211213

212214
!!! info "Permission issue"
213-
If you encounter an error similar to this when indexing:
214-
```
215-
opensearchpy.exceptions.AuthorizationException: AuthorizationException(403, 'security_exception', 'no permissions for [cluster:admin/component_template/put] and User [name=<my-name>, backend_roles=[], requestedTenant=null]')
215+
If you encounter an error similar to this when indexing:
216+
` opensearchpy.exceptions.AuthorizationException: AuthorizationException(403, 'security_exception', 'no permissions for [cluster:admin/component_template/put] and User [name=<my-name>, backend_roles=[], requestedTenant=null]')
216217
opensearchpy.exceptions.AuthorizationException: AuthorizationException(403, 'security_exception', 'no permissions for [indices:admin/index_template/put] and User [name=<my-name>, backend_roles=[], requestedTenant=null]')
217-
```
218-
This means your OpenSearch user does not have sufficient permissions to create or update index templates.
219-
To resolve this, grant the necessary permissions to your user in the OpenSearch cluster:
218+
`
219+
This means your OpenSearch user does not have sufficient permissions to create or update index templates.
220+
To resolve this, grant the necessary permissions to your user in the OpenSearch cluster:
220221

221222
1. Go to **OpenSearch Dashboards** -> **Security** -> **Roles** -> *<your role name>*.
222223
2. Edit the role and add the following cluster and index permissions:
@@ -247,3 +248,6 @@ Many [custom field widgets](../../operate/customize/metadata/custom_fields/widge
247248

248249
These are the new configuration variables introduced in this release. Make sure that you read the related documentation before enabling them. Add them to your `invenio.cfg` as needed:
249250

251+
##### Related Identifiers
252+
253+
Backend and frontend functionality has been extended to cover related identifiers. The new `RDM_RECORDS_RELATED_IDENTIFIERS_SCHEMES` setting defines which schemes can be used (defaulting to `RDM_RECORDS_IDENTIFIERS_SCHEMES`). Validation rules, vocabularies in the UI, and scheme label resolution have been updated to ensure identifiers and related identifiers are handled consistently.

docs/releases/vNext/version-vNext.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@ This feature is also [highly customisable](../../operate/customize/record_deleti
3030
https://github.com/inveniosoftware/invenio-previewer/pull/224
3131

3232
### Miscellaneous additions
33+
3334
Here is a quick summary of the myriad of other improvements in this release:
3435

3536
- Admin panel Jobs: Added a "Delete" action to the Jobs list so admins can remove jobs directly from the UI.
3637
- Temporarily pinned `bcrypt<5.0.0` due to compatibility issues ([flask-security-fork#82](https://github.com/inveniosoftware/flask-security-fork/pull/82)). Will be lifted in a future release.
38+
- A new configuration variable, `RDM_RECORDS_RELATED_IDENTIFIERS_SCHEMES`, enables configuring identifier schemes specifically for related identifiers, defaulting to `RDM_RECORDS_IDENTIFIERS_SCHEMES` when not defined.
3739

3840
## Deprecations
3941

@@ -63,4 +65,3 @@ If you have questions related to these release notes, don't hesitate to jump on
6365
## Credit
6466

6567
The development work of this impressive release wouldn't have been possible without the help of these great people (name or GitHub handle, alphabetically sorted):
66-

0 commit comments

Comments
 (0)