-
Notifications
You must be signed in to change notification settings - Fork 74
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Release notes for 1.6 Co-authored-by: Simon Dumas <[email protected]>
- Loading branch information
Showing
8 changed files
with
167 additions
and
93 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
11 changes: 11 additions & 0 deletions
11
docs/src/main/paradox/docs/releases/v1.5-to-v1.6-migration.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # v1.5 To v1.6 Migration | ||
|
|
||
| The v1.6 release of Delta includes a change on how project statistics are computed which requires to run a query against the Cassandra primary store. | ||
|
|
||
| ## Delete the project statistics row in the projections_progress table | ||
|
|
||
| This command has to be run after stopping Delta 1.5 and before starting Delta 1.6 | ||
|
|
||
| DELETE FROM {delta_1_5}.projections_progress where projection_id = 'ProjectsCounts'; | ||
|
|
||
| Note that as project statistics will be recomputed according to all events in the system, it may take some time for the statistics computation to reach back to the most recent events. |
104 changes: 104 additions & 0 deletions
104
docs/src/main/paradox/docs/releases/v1.6-release-notes.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,104 @@ | ||
| # v1.6 Release Notes | ||
|
|
||
| > This is an incremental software release that adds several improvements across the board. The API is backwards | ||
| compatible to v1.5. | ||
|
|
||
| //TODO update the issue link if needed | ||
| For the detailed list of updates in this release, see the | ||
| @link:[list of addressed issues](https://github.com/BlueBrain/nexus/issues?q=is%3Aissue+is%3Aclosed+created%3A2021-05-01..2021-10-12+){ open=new } | ||
| since v1.5. | ||
|
|
||
| If you are currently using Nexus Delta from 1.5.x, please | ||
| visit the @ref:[migration instructions](v1.5-to-v1.6-migration.md) for the necessary steps to successfully upgrade. | ||
|
|
||
| ## Nexus Delta | ||
|
|
||
| The main goal of this release is to allow users to search across multiple projects through @ref:[global search](../getting-started/running-nexus/search-configuration.md) | ||
|
|
||
| Secondary goals include: | ||
|
|
||
| * The possibility for Delta to query a secured Elasticsearch cluster | ||
| * The introduction of a dedicated Blazegraph client for user-defined queries with the possibility to define a timeout to improve Blazegraph stability | ||
| * Synchronous indexing | ||
| * The analysis of properties and relationships of resources within a project through the @ref:[graph analytics plugin](../delta/api/graph-analytics-api.md) | ||
| * The listing of resources within an organization and within all projects | ||
| * The configuration of the RDF parser | ||
| * @ref:[The deletion of projects and all its resources](../delta/api/projects-api.md#delete) | ||
| * Automatic project provisioning | ||
| * @ref:[The introduction of quotas](../delta/api/quotas.md) | ||
| * Tagging resources after deprecation | ||
|
|
||
| A series of bugs have also been fixed with this new release. | ||
|
|
||
| ### Deprecations | ||
|
|
||
| These two features are now marked as deprecated and will be removed in an upcoming release: | ||
| - @ref:[Nexus client](../utilities/index.md#nexus-cli) | ||
| - @ref:[Indexing data in other systems](../utilities/index.md#indexing-data-in-other-systems) | ||
| - @ref:[RemoteDiskStorage](../delta/api/storages-api.md#remote-disk-storage) | ||
|
|
||
| ### Global search | ||
|
|
||
| Before 1.6, searching across several projects was not available in Nexus. The first version of Global search included in this release | ||
| aims to fill this blank. | ||
|
|
||
| Global search is composed of 2 parts: | ||
|
|
||
| * A Delta plugin which allows to index and query resources according to a given configuration | ||
| * A matching plugin in Fusion allows to query the endpoints provided by Delta to filter/sort results and customize how these results are displayed to the users | ||
|
|
||
| More details about search and how to configure it is provided @ref:[here](../getting-started/running-nexus/search-configuration.md) | ||
|
|
||
| Please note that this first version is experimental in both Delta and Fusion and that improvements and possibly breaking | ||
| changes may be introduced in the upcoming releases. | ||
|
|
||
| ### Secure the Delta Elasticsearch client | ||
|
|
||
| With 1.6, it is now possible to define credentials to query a secured Elasticsearch cluster: @ref:[Elasticsearch configuration](../getting-started/running-nexus/configuration/index.md#elasticsearch-views-plugin-configuration). | ||
|
|
||
| ### Dedicated Blazegraph client for user-defined queries | ||
|
|
||
| User-defined queries could bring instability to Blazegraph because of their complexity. In 1.6, a @link:[dedicated client with a timeout](https://github.com/BlueBrain/nexus/blob/master/delta/plugins/blazegraph/src/main/resources/blazegraph.conf#L34) which triggers a circuit breaker in Blazegraph has been introduced in order to solve that problem. | ||
|
|
||
| ### Synchronous indexing | ||
|
|
||
| From 1.6, the different types of resources can be @ref:[indexed directly after creation/modification](../delta/api/resources-api.md#indexing) without waiting for the background indexing process to pick it up. | ||
|
|
||
| ### Graph analytics | ||
|
|
||
| This @ref:[new plugin](../delta/api/graph-analytics-api.md) helps users to inspect the properties and relationships of the different resources in a given project. | ||
|
|
||
| Only the Delta endpoints are available in this release but a Nexus Fusion plugin will be released soon to make use of it. | ||
|
|
||
| ### Listings | ||
|
|
||
| The different types of resources can now be listed at the @ref:[organization level](../delta/api/resources-api.md#within-an-organization) and @ref:[within all the projects](../delta/api/resources-api.md#within-all-projects) the current user has access to. | ||
|
|
||
| ### Configurable RDF parser | ||
|
|
||
| The RDF parser allowing to validate incoming data can now be @link:[configured](https://github.com/BlueBrain/nexus/blob/master/delta/app/src/main/resources/app.conf#L83) in order to be more or less strict. | ||
|
|
||
| ### Automatic project provisioning | ||
|
|
||
| When enabled, a dedicated project is created for the current user on its first access to the Nexus platform. | ||
|
|
||
| How to enable and configure it is detailed @ref:[here](../getting-started/running-nexus/configuration/index.md#automatic-project-provisioning) | ||
|
|
||
| ### Deletion of projects | ||
|
|
||
| The deletion of projects and all its enclosed resources is now possible by enabling a configuration flag via a @ref:[dedicated endpoint](../delta/api/projects-api.md#delete). | ||
|
|
||
| ### Quotas | ||
|
|
||
| It is now possible to define via static configurations @ref:[quotas on projects](../delta/api/quotas.md). | ||
|
|
||
| ### Tagging resources after deprecation | ||
|
|
||
| The different types of resources can now be tagged after their deprecation. | ||
|
|
||
| ## Nexus Fusion | ||
| TODO | ||
|
|
||
| ## Nexus Forge | ||
|
|
||
| See @link:[Nexus Forge](https://nexus-forge.readthedocs.io/en/latest/index.html){ open=new } documentation for release notes. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters