diff --git a/docs/src/main/paradox/docs/delta/api/files-api.md b/docs/src/main/paradox/docs/delta/api/files-api.md index cd0efca7e7..b816cd3761 100644 --- a/docs/src/main/paradox/docs/delta/api/files-api.md +++ b/docs/src/main/paradox/docs/delta/api/files-api.md @@ -467,7 +467,7 @@ Request (metadata) Response (metadata) : @@snip [fetched-metadata.json](assets/files/fetched-metadata.json) -If the @ref:[redirect to Fusion feature](../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch tags diff --git a/docs/src/main/paradox/docs/delta/api/projects-api.md b/docs/src/main/paradox/docs/delta/api/projects-api.md index ebcfe34501..b718a79e25 100644 --- a/docs/src/main/paradox/docs/delta/api/projects-api.md +++ b/docs/src/main/paradox/docs/delta/api/projects-api.md @@ -253,7 +253,7 @@ Request Response : @@snip [fetched.json](assets/projects/fetched.json) -If the @ref:[redirect to Fusion feature](../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the project will be returned. ## Fetch (specific version) diff --git a/docs/src/main/paradox/docs/delta/api/resolvers-api.md b/docs/src/main/paradox/docs/delta/api/resolvers-api.md index 0acb3f229f..8cb8204032 100644 --- a/docs/src/main/paradox/docs/delta/api/resolvers-api.md +++ b/docs/src/main/paradox/docs/delta/api/resolvers-api.md @@ -210,7 +210,7 @@ Request Response : @@snip [fetched.json](assets/resolvers/fetched.json) -If the @ref:[redirect to Fusion feature](../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch original payload diff --git a/docs/src/main/paradox/docs/delta/api/resources-api.md b/docs/src/main/paradox/docs/delta/api/resources-api.md index edd4653e14..e48b2425fd 100644 --- a/docs/src/main/paradox/docs/delta/api/resources-api.md +++ b/docs/src/main/paradox/docs/delta/api/resources-api.md @@ -327,7 +327,7 @@ Request Response : @@snip [fetched.json](assets/resources/fetched.json) -If the @ref:[redirect to Fusion feature](../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch original payload diff --git a/docs/src/main/paradox/docs/delta/api/schemas-api.md b/docs/src/main/paradox/docs/delta/api/schemas-api.md index b7cefb4844..6b5a8c18bb 100644 --- a/docs/src/main/paradox/docs/delta/api/schemas-api.md +++ b/docs/src/main/paradox/docs/delta/api/schemas-api.md @@ -247,7 +247,7 @@ Request Response : @@snip [schema-fetched.json](assets/schemas/fetched.json) -If the @ref:[redirect to Fusion feature](../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch original payload diff --git a/docs/src/main/paradox/docs/delta/api/search-api.md b/docs/src/main/paradox/docs/delta/api/search-api.md index 4b89be9f41..0fa2bdb26f 100644 --- a/docs/src/main/paradox/docs/delta/api/search-api.md +++ b/docs/src/main/paradox/docs/delta/api/search-api.md @@ -15,7 +15,7 @@ The search plugin relies on @ref:[composite views](./views/composite-view-api.md indices to which user has access to, i.e. has `views/query` permission. For instructions on how to configure global search in Nexus and how it works please visit the -@ref:[Search configuration](../../getting-started/running-nexus/search-configuration.md) page. +@ref:[Search configuration](../../running-nexus/search-configuration.md) page. @@@ note { .tip title="Api Mapping" } diff --git a/docs/src/main/paradox/docs/delta/api/storages-api.md b/docs/src/main/paradox/docs/delta/api/storages-api.md index d760280508..3232e02266 100644 --- a/docs/src/main/paradox/docs/delta/api/storages-api.md +++ b/docs/src/main/paradox/docs/delta/api/storages-api.md @@ -221,7 +221,7 @@ Request Response : @@snip [fetched.json](assets/storages/fetched.json) -If the @ref:[redirect to Fusion feature](../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch original payload diff --git a/docs/src/main/paradox/docs/delta/api/supervision-api.md b/docs/src/main/paradox/docs/delta/api/supervision-api.md index 4e4888be1a..819f7d0ad6 100644 --- a/docs/src/main/paradox/docs/delta/api/supervision-api.md +++ b/docs/src/main/paradox/docs/delta/api/supervision-api.md @@ -64,7 +64,7 @@ and the number of triples per individual view. The unassigned part allows to spot orphan namespaces, that is to say namespaces which may not have been properly deleted when a view got modified or deprecated. -This is an indicator which helps to scale correctly the @ref:[Blazegraph instance](../../getting-started/running-nexus/blazegraph.md). +This is an indicator which helps to scale correctly the @ref:[Blazegraph instance](../../running-nexus/blazegraph.md). ``` GET /v1/supervision/blazegraph diff --git a/docs/src/main/paradox/docs/delta/api/views/composite-sink.md b/docs/src/main/paradox/docs/delta/api/views/composite-sink.md index 6ec7fe89f5..c719041418 100644 --- a/docs/src/main/paradox/docs/delta/api/views/composite-sink.md +++ b/docs/src/main/paradox/docs/delta/api/views/composite-sink.md @@ -16,7 +16,7 @@ selected via configuration. By default, Nexus Delta will use the Single Composite Sink. This sink performs one query to the Blazegraph common namespace for each resource in the project. The queries are done in chronological order (by the `updatedAt` time of the resources). -We recommend reading through the @ref:[search configuration example use case](../../../getting-started/running-nexus/search-configuration.md#example-use-case) and the @ref[Composite View API reference](composite-view-api.md) to learn more about Composite Views. +We recommend reading through the @ref:[search configuration example use case](../../../running-nexus/search-configuration.md#example-use-case) and the @ref[Composite View API reference](composite-view-api.md) to learn more about Composite Views. ## Batch Composite Sink diff --git a/docs/src/main/paradox/docs/delta/api/views/composite-view-api.md b/docs/src/main/paradox/docs/delta/api/views/composite-view-api.md index 8b3c34ccd4..7af1e406cd 100644 --- a/docs/src/main/paradox/docs/delta/api/views/composite-view-api.md +++ b/docs/src/main/paradox/docs/delta/api/views/composite-view-api.md @@ -500,7 +500,7 @@ Request Response : @@snip [fetched.json](../assets/views/composite/fetched.json) -If the @ref:[redirect to Fusion feature](../../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch original payload diff --git a/docs/src/main/paradox/docs/delta/api/views/elasticsearch-view-api.md b/docs/src/main/paradox/docs/delta/api/views/elasticsearch-view-api.md index 10a3f126d9..1936f963ef 100644 --- a/docs/src/main/paradox/docs/delta/api/views/elasticsearch-view-api.md +++ b/docs/src/main/paradox/docs/delta/api/views/elasticsearch-view-api.md @@ -332,7 +332,7 @@ Request Response : @@snip [fetched.json](../assets/views/elasticsearch/fetched.json) -If the @ref:[redirect to Fusion feature](../../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. Note that for retro-compatibility purposes, fetching an elasticsearch view returns legacy fields. diff --git a/docs/src/main/paradox/docs/delta/api/views/sparql-view-api.md b/docs/src/main/paradox/docs/delta/api/views/sparql-view-api.md index 33414becb4..f216cb80b7 100644 --- a/docs/src/main/paradox/docs/delta/api/views/sparql-view-api.md +++ b/docs/src/main/paradox/docs/delta/api/views/sparql-view-api.md @@ -211,7 +211,7 @@ Request Response : @@snip [fetched.json](../assets/views/blazegraph/sparql/fetched.json) -If the @ref:[redirect to Fusion feature](../../../getting-started/running-nexus/configuration/index.md#fusion-configuration) is enabled and +If the @ref:[redirect to Fusion feature](../../../running-nexus/configuration/index.md#fusion-configuration) is enabled and if the `Accept` header is set to `text/html`, a redirection to the fusion representation of the resource will be returned. ## Fetch original payload diff --git a/docs/src/main/paradox/docs/faq.md b/docs/src/main/paradox/docs/faq.md index 756a14120b..6b0c16a47f 100644 --- a/docs/src/main/paradox/docs/faq.md +++ b/docs/src/main/paradox/docs/faq.md @@ -17,8 +17,8 @@ There are many ways to run Nexus. Our public Sandbox is running @link:[here](htt and you can use it to test Nexus on small, non-sensitive data. Our @ref:[tutorial](getting-started/try-nexus.md) can help you to run Nexus step by step. -Meanwhile if you want to run it locally you can do so using @ref:[Docker](getting-started/running-nexus/index.md#docker). You can also deploy Nexus -@ref:[“on premise”](getting-started/running-nexus/index.md#on-premise-cloud-deployment), as a single instance or as a cluster. +Meanwhile if you want to run it locally you can do so using @ref:[Docker](running-nexus/index.md#docker). You can also deploy Nexus +@ref:[“on premise”](running-nexus/index.md#on-premise-cloud-deployment), as a single instance or as a cluster. Blue Brain Nexus has also been deployed and tested on AWS using @link:[Kubernetes](https://kubernetes.io/){ open=new }. ### How can I try Blue Brain Nexus without installing it? @@ -75,7 +75,7 @@ There are several channels provided to address different issues: On macOS and Windows, Docker effectively runs containers inside a VM created by the system hypervisor. Nexus requires at least 2 CPUs and 8 GB of memory in total. You can increase the limits in Docker settings in the menu -_Preferences > Advanced_. More details are in the dedicated @ref:[page](getting-started/running-nexus/index.md). +_Preferences > Advanced_. More details are in the dedicated @ref:[page](running-nexus/index.md). ### What is JSON-LD? diff --git a/docs/src/main/paradox/docs/getting-started/index.md b/docs/src/main/paradox/docs/getting-started/index.md index ed1cd3c16f..84ff7b3ff4 100644 --- a/docs/src/main/paradox/docs/getting-started/index.md +++ b/docs/src/main/paradox/docs/getting-started/index.md @@ -3,7 +3,6 @@ - @ref:[Understanding Knowledge Graphs](understanding-knowledge-graphs.md) - @ref:[Neuroscience Tutorial](try-nexus.md) - @ref:[MovieLens Tutorial](try-nexus-movielens.md) -- @ref:[Running Nexus](running-nexus/index.md) @@@ @@ -13,4 +12,4 @@ The Nexus ecosystem is a data catalog with several technologies and techniques u One of the powerful ways to query data is through the Knowledge Graph built in Nexus. For that reason we encourage you to get familiar with these concepts reading @ref:[Understanding Knowledge Graphs](understanding-knowledge-graphs.md). -The next steps would be to either try Nexus using the @ref:[Sandbox](try-nexus.md) deployment or @ref:[run Nexus locally](running-nexus/index.md). \ No newline at end of file +The next steps would be to either try Nexus using the @ref:[Sandbox](try-nexus.md) deployment or @ref:[run Nexus locally](../running-nexus/index.md). \ No newline at end of file diff --git a/docs/src/main/paradox/docs/getting-started/try-nexus.md b/docs/src/main/paradox/docs/getting-started/try-nexus.md index 66c7804c36..18ebbc79f7 100644 --- a/docs/src/main/paradox/docs/getting-started/try-nexus.md +++ b/docs/src/main/paradox/docs/getting-started/try-nexus.md @@ -116,7 +116,7 @@ You will need the names of the organisation and project for the next parts of th ### 1.2. Running your Own Instance of Nexus -We do not recommend to setup your own instance for this tutorial. If you are interested to install your own instance, @ref:[check our guide](./running-nexus/index.md). +We do not recommend to setup your own instance for this tutorial. If you are interested to install your own instance, @ref:[check our guide](../running-nexus/index.md). ## Step 2: Download and Register Data from a Single Source diff --git a/docs/src/main/paradox/docs/index.md b/docs/src/main/paradox/docs/index.md index efd6ad618c..639432fcad 100644 --- a/docs/src/main/paradox/docs/index.md +++ b/docs/src/main/paradox/docs/index.md @@ -2,6 +2,7 @@ - [Versions](versions.md) - [Quick Start Guide](getting-started/index.md) +- [Running Nexus](running-nexus/index.md) - [Releases](releases/index.md) - [Roadmap](roadmap.md) - [Nexus Fusion](fusion/index.md) @@ -67,7 +68,7 @@ Do you know know what a knowledge graph is? Or want to deepen your understanding Want to get started with Nexus right away? We provide a @ref:[tutorial](getting-started/try-nexus.md) that uses our @link:[sandbox](https://sandbox.bluebrainnexus.io/){ open=new } environment to let you try the functionalities. -Ready to deploy your own instance of Nexus? Follow our @ref:[guide](getting-started/running-nexus/index.md). +Ready to deploy your own instance of Nexus? Follow our @ref:[guide](running-nexus/index.md). ## Versions diff --git a/docs/src/main/paradox/docs/releases/v1.11-release-notes.md b/docs/src/main/paradox/docs/releases/v1.11-release-notes.md index 713346c8e2..52c0444679 100644 --- a/docs/src/main/paradox/docs/releases/v1.11-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.11-release-notes.md @@ -26,7 +26,7 @@ Nexus now supports conditional requests. Nexus now allows to provision realms at start up so as to simplify automated deployments. -@ref[More here](../getting-started/running-nexus/configuration/index.md#realm-provisioning) +@ref[More here](../running-nexus/configuration/index.md#realm-provisioning) ### Remote storage server diff --git a/docs/src/main/paradox/docs/releases/v1.6-release-notes.md b/docs/src/main/paradox/docs/releases/v1.6-release-notes.md index c3242ef80f..d84af33459 100644 --- a/docs/src/main/paradox/docs/releases/v1.6-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.6-release-notes.md @@ -12,7 +12,7 @@ visit the @ref:[migration instructions](v1.5-to-v1.6-migration.md) for the neces ## 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) +The main goal of this release is to allow users to search across multiple projects through @ref:[global search](../running-nexus/search-configuration.md) Secondary goals include: @@ -47,14 +47,14 @@ 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) +More details about search and how to configure it is provided @ref:[here](../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). +With 1.6, it is now possible to define credentials to query a secured Elasticsearch cluster: @ref:[Elasticsearch configuration](../running-nexus/configuration/index.md#elasticsearch-views-plugin-configuration). ### Dedicated Blazegraph client for user-defined queries @@ -82,7 +82,7 @@ The RDF parser allowing to validate incoming data can now be @link:[configured]( 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) +How to enable and configure it is detailed @ref:[here](../running-nexus/configuration/index.md#automatic-project-provisioning) ### Deletion of projects diff --git a/docs/src/main/paradox/docs/releases/v1.7-release-notes.md b/docs/src/main/paradox/docs/releases/v1.7-release-notes.md index e34f0f4a39..1d756149ad 100644 --- a/docs/src/main/paradox/docs/releases/v1.7-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.7-release-notes.md @@ -90,7 +90,7 @@ This change implies a @ref:[migration when updating Nexus Delta to 1.7](v1.6-to- Besides JVM properties and environment variables, Delta configuration can now be defined via a external file. -@ref:[Read More about Delta configuration](../getting-started/running-nexus/configuration/index.md) +@ref:[Read More about Delta configuration](../running-nexus/configuration/index.md) ### Deleting tags on resources diff --git a/docs/src/main/paradox/docs/releases/v1.7-to-v1.8-migration.md b/docs/src/main/paradox/docs/releases/v1.7-to-v1.8-migration.md index 4f07005b6d..89bc2af22b 100644 --- a/docs/src/main/paradox/docs/releases/v1.7-to-v1.8-migration.md +++ b/docs/src/main/paradox/docs/releases/v1.7-to-v1.8-migration.md @@ -248,7 +248,7 @@ The following environment variables need to be set when launching Delta v1.8 in | S3 storage enabling | plugins.storage.storages.amazon.enabled | true/false | For more information on the configuration of Delta, please refer to the -@ref:[Nexus configuration page](../getting-started/running-nexus/configuration/index.md). +@ref:[Nexus configuration page](../running-nexus/configuration/index.md). ## Migrating events from Cassandra to PostgreSQL diff --git a/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md b/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md index 8ab2185f7d..c0d4388eb4 100644 --- a/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md +++ b/docs/src/main/paradox/docs/releases/v1.8-to-v1.9-migration.md @@ -61,5 +61,5 @@ Currently, both remote storages and composite views with remote sources can hold A remote storage might currently have a token stored in the storage definition. In 1.9, this should be moved to `plugins.storage.storages.remote-disk.credentials`. -A composite view might currently have a token stored in the view definition. In 1.9, this should be moved to `plugins.composite-views.remote-source-credentials`, as shown @ref:[here](../getting-started/running-nexus/configuration/index.md#composite-views-plugin-configuration) +A composite view might currently have a token stored in the view definition. In 1.9, this should be moved to `plugins.composite-views.remote-source-credentials`, as shown @ref:[here](../running-nexus/configuration/index.md#composite-views-plugin-configuration) diff --git a/docs/src/main/paradox/docs/releases/v1.9-release-notes.md b/docs/src/main/paradox/docs/releases/v1.9-release-notes.md index 6b19de5b03..6d0acc327d 100644 --- a/docs/src/main/paradox/docs/releases/v1.9-release-notes.md +++ b/docs/src/main/paradox/docs/releases/v1.9-release-notes.md @@ -151,7 +151,7 @@ Preserving the intermediate space also reduces the fragmentation of the Blazegra Rather than storing an auth token in the composite view, it is now expected to specify an authentication method in the Delta configuration. -@ref:[More information](../getting-started/running-nexus/configuration/index.md#composite-views-plugin-configuration) +@ref:[More information](../running-nexus/configuration/index.md#composite-views-plugin-configuration) #### Remove the resourceTag field in projections of composite views @@ -224,7 +224,7 @@ The automatic detection of the media type can now be customized at the Delta lev NB: The media type provided by the user still prevails over automatic detection. -@ref:[More information](../getting-started/running-nexus/configuration/index.md#file-configuration) +@ref:[More information](../running-nexus/configuration/index.md#file-configuration) #### Tagging at creation/update @@ -307,7 +307,7 @@ The 1.9 release of Nexus Fusion focuses on enhancing user interaction, resource The Nexus storage app also benefits from the changes in automatic file detection. -@ref:[More information](../getting-started/running-nexus/configuration/index.md#file-configuration) +@ref:[More information](../running-nexus/configuration/index.md#file-configuration) ### Removing Delta callback to validate the caller identity diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/blazegraph.md b/docs/src/main/paradox/docs/running-nexus/blazegraph.md similarity index 94% rename from docs/src/main/paradox/docs/getting-started/running-nexus/blazegraph.md rename to docs/src/main/paradox/docs/running-nexus/blazegraph.md index aac68d7994..2b1ec1320d 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/blazegraph.md +++ b/docs/src/main/paradox/docs/running-nexus/blazegraph.md @@ -38,8 +38,8 @@ It is likely to happen when reindexing after updating search but if it happens r Blazegraph will use the available RAM in 2 ways, JVM heap and the file system cache so like Elasticsearch, the JVM garbage collection frequency and duration are also important to monitor. -Using the supervision endpoints for @ref:[Blazegraph](../../delta/api/supervision-api.md#blazegraph) -and @ref:[composite views](../../delta/api/supervision-api.md#composite-views) and +Using the supervision endpoints for @ref:[Blazegraph](../delta/api/supervision-api.md#blazegraph) +and @ref:[composite views](../delta/api/supervision-api.md#composite-views) and the @link:[RAM guidance from Blazegraph](https://github.com/blazegraph/database/wiki/Hardware_Configuration#ram-sizing-guidance) gives some insights on how much memory can be assigned. @@ -56,8 +56,8 @@ to reduce the disk usage, but it takes quite a bit a time and requires taking th An alternative can be to reindex on a fresh instance of Blazegraph, this approach also allows to reconfigure the underlying namespaces. -Using the supervision endpoints for @ref:[Blazegraph](../../delta/api/supervision-api.md#blazegraph) -and @ref:[composite views](../../delta/api/supervision-api.md#composite-views) and +Using the supervision endpoints for @ref:[Blazegraph](../delta/api/supervision-api.md#blazegraph) +and @ref:[composite views](../delta/api/supervision-api.md#composite-views) and the @link:[Data on disk guidance from Blazegraph](https://github.com/blazegraph/database/wiki/Hardware_Configuration#data-on-disk-sizing-guidance) gives some insights on how much storage can be assigned. diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md b/docs/src/main/paradox/docs/running-nexus/configuration/index.md similarity index 99% rename from docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md rename to docs/src/main/paradox/docs/running-nexus/configuration/index.md index ed54967bd9..1e9b049526 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/index.md +++ b/docs/src/main/paradox/docs/running-nexus/configuration/index.md @@ -59,7 +59,7 @@ Nexus Delta uses a service account to perform automatic tasks under the hood. Ex Realm provisioning allows to create one or several realm at startup. -It is useful to start a new deployment with having to call the @ref:[realm API](../../../delta/api/realms-api.md) to create those. +It is useful to start a new deployment with having to call the @ref:[realm API](../../delta/api/realms-api.md) to create those. Exemple: ```hocon @@ -114,7 +114,7 @@ When fetching a resource, Nexus Delta allows to return a redirection to its repr ## Projections configuration -Projections in Nexus Delta are asynchronous processes that can replay the event log and process this information. For more information on projections, please refer to the @ref:[Architecture page](../../../delta/architecture.md). +Projections in Nexus Delta are asynchronous processes that can replay the event log and process this information. For more information on projections, please refer to the @ref:[Architecture page](../../delta/architecture.md). @link:[The `projections` section](https://github.com/BlueBrain/nexus/blob/$git.branch$/delta/app/src/main/resources/app.conf#L281) of the configuration allows to configure the projections. @@ -126,7 +126,7 @@ Since 1.5.0, Nexus Delta supports plugins. Jar files present inside the local di Each plugin configuration is rooted under `plugins.{plugin_name}`. All plugins have a `plugins.{plugin_name}.priority` configuration flag used to determine the order in which the routes are handled in case of collisions. -For more information about plugins, please refer to the @ref:[Plugins page](../../../delta/plugins/index.md). +For more information about plugins, please refer to the @ref:[Plugins page](../../delta/plugins/index.md). ### Elasticsearch views plugin configuration diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/configuration/logback.xml b/docs/src/main/paradox/docs/running-nexus/configuration/logback.xml similarity index 100% rename from docs/src/main/paradox/docs/getting-started/running-nexus/configuration/logback.xml rename to docs/src/main/paradox/docs/running-nexus/configuration/logback.xml diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/delta.md b/docs/src/main/paradox/docs/running-nexus/delta.md similarity index 100% rename from docs/src/main/paradox/docs/getting-started/running-nexus/delta.md rename to docs/src/main/paradox/docs/running-nexus/delta.md diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/docker/delta.conf b/docs/src/main/paradox/docs/running-nexus/docker/delta.conf similarity index 100% rename from docs/src/main/paradox/docs/getting-started/running-nexus/docker/delta.conf rename to docs/src/main/paradox/docs/running-nexus/docker/delta.conf diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/docker/docker-compose.yaml b/docs/src/main/paradox/docs/running-nexus/docker/docker-compose.yaml similarity index 69% rename from docs/src/main/paradox/docs/getting-started/running-nexus/docker/docker-compose.yaml rename to docs/src/main/paradox/docs/running-nexus/docker/docker-compose.yaml index aad6c59b65..ce189a1c8b 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/docker/docker-compose.yaml +++ b/docs/src/main/paradox/docs/running-nexus/docker/docker-compose.yaml @@ -1,19 +1,21 @@ services: delta: depends_on: - - blazegraph - - elasticsearch - - postgres - image: bluebrain/nexus-delta:1.10.0-M13 + elasticsearch: + condition: service_healthy + blazegraph: + condition: service_healthy + postgres: + condition: service_started + image: bluebrain/nexus-delta:1.10.0 environment: DELTA_PLUGINS: "/opt/docker/plugins/" DELTA_EXTERNAL_CONF: "/config/delta.conf" KAMON_ENABLED: "false" - entrypoint: [ "bin/wait-for-it.sh", "-s", "-t", "0", "postgres:5432", "--", - "bin/wait-for-it.sh", "-s", "-t", "0", "elasticsearch:9200", "--", - "./bin/delta-app", - "-Xmx512m" - ] + entrypoint: + - '/bin/bash' + - '-c' + - '/opt/docker/bin/delta-app -Xmx512m' volumes: - ${PWD}/delta.conf:/config/delta.conf deploy: @@ -29,6 +31,11 @@ services: xpack.security.enabled: "true" ingest.geoip.downloader.enabled: "false" ELASTIC_PASSWORD: "password" + healthcheck: + test: [ "CMD", "curl", "-f", "http://elastic:password@localhost:9200/" ] + interval: 1s + timeout: 2s + retries: 60 ports: - "9200" deploy: @@ -48,6 +55,11 @@ services: JAVA_OPTS: "-Djava.awt.headless=true -XX:MaxDirectMemorySize=64m -Xmx512m -XX:+UseG1GC" ports: - "9999" + healthcheck: + test: [ "CMD", "curl", "-f", "http://localhost:9999/blazegraph/" ] + interval: 1s + timeout: 2s + retries: 60 deploy: resources: limits: @@ -56,7 +68,7 @@ services: web: depends_on: - delta - image: bluebrain/nexus-web:1.9.9 + image: bluebrain/nexus-web:1.10.0-M2-studio-open-tag-in-drawer environment: BASE_PATH: "/" HOST_NAME: "http://localhost" diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/docker/nginx.conf b/docs/src/main/paradox/docs/running-nexus/docker/nginx.conf similarity index 100% rename from docs/src/main/paradox/docs/getting-started/running-nexus/docker/nginx.conf rename to docs/src/main/paradox/docs/running-nexus/docker/nginx.conf diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/elasticsearch.md b/docs/src/main/paradox/docs/running-nexus/elasticsearch.md similarity index 100% rename from docs/src/main/paradox/docs/getting-started/running-nexus/elasticsearch.md rename to docs/src/main/paradox/docs/running-nexus/elasticsearch.md diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/index.md b/docs/src/main/paradox/docs/running-nexus/index.md similarity index 97% rename from docs/src/main/paradox/docs/getting-started/running-nexus/index.md rename to docs/src/main/paradox/docs/running-nexus/index.md index c1c9448f71..5c8941dab3 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/index.md +++ b/docs/src/main/paradox/docs/running-nexus/index.md @@ -121,7 +121,7 @@ $ curl http://localhost/v1/version | jq #### Using Fusion -Fusion can be accessed by opening `http://localhost` in your web browser. You can start by creating an organization from the `http://localhost/admin` page. +Fusion can be accessed by opening `http://localhost` in your web browser. You can start by creating an organization from the `http://localhost/orgs` page. @@@ note { .warning } @@ -214,7 +214,7 @@ Details on how to deploy, run and monitor the different components are described ### Choice of hardware Depending on the target throughput, usage profiles and data volume the hardware specification can vary greatly; please -take a look at the @ref:[benchmarks section](../../delta/benchmarks/v1.4.2.md) to get an idea of what you should expect in terms +take a look at the @ref:[benchmarks section](../delta/benchmarks/v1.4.2.md) to get an idea of what you should expect in terms of throughput with various hardware configurations. When the usage profiles are unknown a couple of rules of thumb should narrow the scope: @@ -224,7 +224,7 @@ should narrow the scope: access, so: * prefer local storage over network storage for lower latency when doing IO, * prefer SSD over HDDs because random access speed is more important than sequential access, - * one exception is the file storage (@ref:[file resources](../../delta/api/files-api.md) which are stored as + * one exception is the file storage (@ref:[file resources](../delta/api/files-api.md) which are stored as binary blobs on the filesystem) where the network disks should not be a cause for concern, nor random access speed; this assumes that accessing attachments is not the at the top in the usage profile 2. Nexus Delta and most of the "off the shelf" products are built to run on top of the JVM which usually @@ -258,4 +258,4 @@ While different approaches are possible depending on how and where Nexus is depl Prometheus has been the historical solution for monitoring Nexus at BBP for its popularity and its versatility as it allows to monitor all components. -![Monitoring with Prometheus](../assets/prometheus-monitoring.png) \ No newline at end of file +![Monitoring with Prometheus](../getting-started/assets/prometheus-monitoring.png) \ No newline at end of file diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/postgresql.md b/docs/src/main/paradox/docs/running-nexus/postgresql.md similarity index 97% rename from docs/src/main/paradox/docs/getting-started/running-nexus/postgresql.md rename to docs/src/main/paradox/docs/running-nexus/postgresql.md index 1db7b1e561..2c4d216de4 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/postgresql.md +++ b/docs/src/main/paradox/docs/running-nexus/postgresql.md @@ -83,7 +83,7 @@ Some of those actions may fail as it relies on external components (like a Blaze which may be down at this moment. This table allows to save the failures in order to be able to a posteriori call -@ref:[the supervision healing endpoint](../../delta/api/supervision-api.md#project-healing). +@ref:[the supervision healing endpoint](../delta/api/supervision-api.md#project-healing). **project_last_updates:** Stores the last_update and last_ordering properties for the different projects. @@ -142,7 +142,7 @@ Low memory indicates swapping and degraded performance. **Storage:** There should be enough available space for PostgreSQL to operate properly. -As described in the @ref:[architecture section](../../delta/architecture.md) the generally adopted +As described in the @ref:[architecture section](../delta/architecture.md) the generally adopted persistence model is an EventSourced model in which the data store is used as an _append only_ store. This has implications to the total amount of disk used by the primary store. diff --git a/docs/src/main/paradox/docs/getting-started/running-nexus/search-configuration.md b/docs/src/main/paradox/docs/running-nexus/search-configuration.md similarity index 95% rename from docs/src/main/paradox/docs/getting-started/running-nexus/search-configuration.md rename to docs/src/main/paradox/docs/running-nexus/search-configuration.md index 1162474ddc..70b9febf55 100644 --- a/docs/src/main/paradox/docs/getting-started/running-nexus/search-configuration.md +++ b/docs/src/main/paradox/docs/running-nexus/search-configuration.md @@ -20,10 +20,10 @@ There are several aspects that have been taken into consideration when adding gl Considering the requirements listed above, the implementation relies on existing Nexus features, namely: -- @ref:[Composite Views](../../delta/api/views/composite-view-api.md) as control resources for partitioning of indices, +- @ref:[Composite Views](../delta/api/views/composite-view-api.md) as control resources for partitioning of indices, how data is indexed, what information to collect, what permissions are required for querying -- @ref:[Automatic provisioning](../../delta/plugins/index.md#dependency-injection) of project resources after creation -- @ref:[Plugins](../../delta/plugins/index.md) for orchestrating the behaviour and exposing specific endpoints +- @ref:[Automatic provisioning](../delta/plugins/index.md#dependency-injection) of project resources after creation +- @ref:[Plugins](../delta/plugins/index.md) for orchestrating the behaviour and exposing specific endpoints When the search plugin is enabled and configured it will automatically create within each project a CompositeView that controls what resources are indexed and what information is collected for each resource. The reasons for using one @@ -43,18 +43,18 @@ CompositeViews have been chosen because they are quite versatile, support a wide - simple transformations More information about CompositeViews can be found in the -@ref:[API Reference](../../delta/api/views/composite-view-api.md). +@ref:[API Reference](../delta/api/views/composite-view-api.md). The search plugin introduces a new namespace (`/v1/search`) with two sub-resources (`query` and `config`). -The @ref:[query endpoint](../../delta/api/search-api.md#query) accepts submitting an +The @ref:[query endpoint](../delta/api/search-api.md#query) accepts submitting an @link:[Elasticsearch query](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) via `POST`, similar to other views based on Elasticsearch, like `ElasticSearchView`, `AggregateElasticSearchView` or `CompositeView` with configured Elasticsearch projections. The query will be dispatched to all ElasticSearch indices managed by the CompositeViews created by the search plugin (the ones that share the id mentioned above) for which the client has access to. This ensures that access to information is restricted based on each project's access control. -The @ref:[config endpoint](../../delta/api/search-api.md#configuration) allows clients to discover the underlying index +The @ref:[config endpoint](../delta/api/search-api.md#configuration) allows clients to discover the underlying index data model such that it can present users (like in the case of Fusion) an appropriate interface for querying, filtering, sorting, aggregations etc. A minimal response for the config endpoint is like the following example: @@ -131,7 +131,7 @@ the rest of the search configuration: The search plugin must also be enabled using the `plugins.search.enabled=true` setting. These additional settings pertain to the configuration of the CompositeViews that are automatically provisioned by the -search plugin. The @ref:[CompositeView API Reference](../../delta/api/views/composite-view-api.md) provides a detailed +search plugin. The @ref:[CompositeView API Reference](../delta/api/views/composite-view-api.md) provides a detailed explanation on how CompositeViews work and how these options affect the generation of the indices. ## Example use case @@ -141,7 +141,7 @@ uses four related data types (`Dataset`, `DataDownload`, `Person` and `License`) ability to query resources of type `Dataset` along with information registered in related resources (of type `DataDownload`, `Person` or `License`). -[![Data Model](../assets/search-use-case.png "Data Model")](../assets/search-use-case.png) +[![Data Model](../getting-started/assets/search-use-case.png "Data Model")](../getting-started/assets/search-use-case.png) There are a couple of things to notice in the data model diagram: