Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
364 lines (298 sloc) 16.5 KB
title review labels toc confluence tree_item_index version_override history
Upgrade from 5.8 to 6.0
comment date status
2017-01-20
ok
lts2016-ok
multiexcerpt
content-review-lts2017
true
ajs-parent-page-id ajs-parent-page-title ajs-space-key ajs-space-name canonical canonical_source page_id shortlink shortlink_source source_link
3343538
Upgrading the Nuxeo Platform
NXDOC
Nuxeo Platform Developer Documentation
Upgrade+from+5.8+to+6.0
17794754
woYPAQ
/display/NXDOC/Upgrade+from+5.8+to+6.0
400
LTS 2015 6.0
710/admindoc/upgrade-from-58-to-60
60/admindoc/upgrade-from-58-to-60
author date message version
Manon Lumeau
2016-06-10 15:36
33
author date message version
Solen Guitter
2016-04-06 07:25
Fix link to page How to upgrade Nuxeo
32
author date message version
Solen Guitter
2015-12-16 17:01
31
author date message version
Solen Guitter
2015-12-16 15:47
NXDOC-747: Add section Setting up Caches for Directories
30
author date message version
Solen Guitter
2015-11-27 15:33
NXDOC-658: Marketplace packages are now called Nuxeo Packages
29
author date message version
Benoit Delbosc
2015-09-07 07:41
28
author date message version
Florent Guillaume
2015-05-12 13:57
Added Document interface change
27
author date message version
Solen Guitter
2015-04-14 14:20
26
author date message version
Manon Lumeau
2014-12-05 15:55
25
author date message version
Manon Lumeau
2014-12-05 15:54
24
author date message version
Solen Guitter
2014-11-25 15:07
23
author date message version
Solen Guitter
2014-11-25 14:34
fix typos, add links, cap titles
22
author date message version
Julien Carsique
2014-11-25 11:08
21
author date message version
Julien Carsique
2014-11-25 11:06
20
author date message version
Alain Escaffre
2014-11-25 00:34
19
author date message version
Alain Escaffre
2014-11-25 00:33
18
author date message version
Alain Escaffre
2014-11-25 00:31
17
author date message version
Alain Escaffre
2014-11-25 00:31
16
author date message version
Alain Escaffre
2014-11-25 00:30
15
author date message version
Alain Escaffre
2014-11-24 16:22
14
author date message version
Solen Guitter
2014-11-18 16:09
13
author date message version
Solen Guitter
2014-10-24 10:43
Add PDF export of upgrades note
12
author date message version
Solen Guitter
2014-10-23 17:16
11
author date message version
Julien Carsique
2014-08-08 17:29
Fix issues filter links
10
author date message version
Manon Lumeau
2014-08-08 17:12
9
author date message version
Manon Lumeau
2014-08-08 17:12
8
author date message version
Solen Guitter
2014-07-23 11:57
7
author date message version
Solen Guitter
2014-07-23 11:57
Added missing 5.9.3 and 5.9.4 upgrade and release notes
6
author date message version
Solen Guitter
2014-03-18 11:19
5
author date message version
Solen Guitter
2014-03-18 09:25
4
author date message version
Solen Guitter
2013-12-12 11:22
3
author date message version
Solen Guitter
2013-12-12 11:20
2
author date message version
Solen Guitter
2013-12-12 11:20
1

For the general upgrade process, see the [How to Upgrade Nuxeo]({{page page='upgrading-the-nuxeo-platform'}}) page.

{{! multiexcerpt name='from-5.8-to-6.0'}}

You may also be interested in the 6.0 Release Notes.

This chapter highlights some major information about upgrade from Nuxeo Platform 5.8 LTS to Nuxeo Platform 6.0 LTS. We strongly encourage you to also have a quick read of the detailed list ofupgrade notes for 6.0.

1. Updating Your Target Platform in Studio to Nuxeo Platform 6.0

You can read [how to Update the Version of Your Target Platform in Studio]({{page space='studio' page='update-the-version-of-your-target-platform'}}).

Due to some feature moves, you should also report to the page [Specific Upgrade Instructions]({{page space='studio' page='specific-upgrade-instructions#to-60'}}) to migrate your project.

2. Defining Your Base Application

Upgrade your Nuxeo Packages dependency list. Several feature moves have been done between 5.8 LTS and 6.0 LTS, with some features being moved in separate packages, some deprecated, some "migrated". You should read the page [packages changes and deprecation]({{page space='admindoc60' page='packaging-changes-and-deprecations'}}).

3. Deciding How You Would like to Use Elasticsearch

Nuxeo Platform 6.0 comes with Elasticsearch, which brings you more scalability and new features in terms of search experience ([more accurate full text search]({{page space='nxdoc60' page='configuring-the-elasticsearch-mapping'}}) + [facets and aggregates]({{page space='nxdoc60' page='page-provider-aggregates'}})).

Page Providers and Content Views

It is easy to override existing queries of your application to [define the ones that should hit the Elasticsearch index]({{page space='nxdoc60' page='how-to-make-a-page-provider-or-content-view-query-elasticsearch-index'}}).

You can also read the page [How to Configure a Search Filter With Facets and Other Aggregates]({{page space='nxdoc60' page='how-to-configure-a-search-filter-with-facets-and-other-aggregates'}}) for configuring facets (aka aggregates) on a given content view.

Migrating Negative Permissions

In Nuxeo Platform 6.0, negative permissions (i.e. Deny Read to John) are disabled by default.

Elasticsearch is not compliant with negative permissions. If some code or Nuxeo Studio configuration sets such negative permissions, you should remove those part of code/configuration. More generally, if you were using negative ACLs in your previous version of the Nuxeo Platform, you will need to reorganize your security policy.

If you don’t use Elasticsearch, you can re-enable negative ACL (deny permissions) in the UI by adding the following line to your [nuxeo.conf]({{page space='admindoc60' page='configuration-parameters-index-nuxeoconf'}}):

nuxeo.security.allowNegativeACL=true

Upgrading Your Production Architecture

Elasticsearch is not mandatory: you can [keep on querying VCS (the database)]({{page space='ADMINDOC60' page='Elasticsearch Setup#ElasticsearchSetup-DisablingElasticsearch'}}) and use the database full-text index.

{{#> callout type='warning' }}

If you want to benefit from the Elasticsearch Indexing Service in production, which is enabled by default, you should setup[ an Elasticsearch cluster]({{page space='admindoc60' page='elasticsearch-setup'}}) and you need to [index the existing content]({{page space='ADMINDOC60' page='Elasticsearch Setup#ElasticsearchSetup-RebuildingtheIndex'}}).

{{/callout}}

4. Migrating Your Custom Java Code

Migrating to Maven 3

Nuxeo Platform now uses Maven 3 for building.

Migrating Your Custom Code and Templates

Nuxeo Platform has been migrated to JSF2. If you have implemented some custom UI templates, you should migrate them to JSF2 too. [A tool is provided]({{page space='nxdoc60' page='upgrade-to-jsf2'}}) to help you auditing what has been done.

More information on the page [Upgrade to JSF2]({{page space='nxdoc60' page='upgrade-to-jsf2'}}).

Tooltip Library Change

Tooltip library has been changed from jQuery tooltip to tipsy, see NXP-13842.

If you were using this library, you should remove calls similar too:

<script>
  jQuery(document).ready(function() {
    jQuery(".widgetHelpLabel").tooltip({relative: true, position: 'bottom center'});
  });
</script>

To enable a tooltip on any HTML element, specify the tooltip content in the 'title' attribute and add 'tipsyShow' css style class, for example:

<h:outputText value="#{myLabel}"
  styleClass="tipsyShow tipsyGravityNW" />

Migrating your Security Policy or Versioning Service

If you have Java code implementing a SecurityPolicy (defined using the policies extension point), or a VersioningService (defined using the versioningService extension point), your code uses the low-level Document interface which changed a bit in Nuxeo Platform 6.0. In particular, to get a property's value you need to use the getPropertyValue method directly, as the getProperty method doesn't exist anymore. This does not impact functionality.

5. Setting up Caches for Directories

If your directories, wether for vocabularies, users or groups, were already using a cache, you must update them to use new caches.

  1. [Define two new core caches]({{page space='nxdoc60' page='how-to-configure-a-new-directory-cache'}}) (one for entry with references, another for entry without references) contributed to org.nuxeo.ecm.core.cache.CacheServiceImpl.
  2. In these caches define your implementation class, maxSize, ttl and concurrencyLevel.
  3. Remove the deprecated tags from the directory config file:
    • cacheMaxSize
    • cacheTimeOut
  4. Add new tags with your cache name in the directory config file:
    • cacheEntryName
    • cacheEntryWithoutReferencesName

6. If You Were Using the REST API in 5.8

  • "Rest Contributors" have been renamed "Content Enrichers”, and the extension points has been modified. See the [Content Enricher page]({{page space='nxdoc60' page='content-enricher'}}).
  • The Nuxeo Platform now returns all the properties by default on the Rest API. if you want to limit the schemas you want to get client side, you should specify them explicitly using the X-NXDocumentProperties header.
  • URL of the binary that is given in the “data” property of the JSON object has changed: see https://jira.nuxeo.com/browse/NXP-13616.

Noteworthy

CMIS Join

If you use CMIS Join operator in CMISQL queries, you need to switch the way CMIS queries are transformed. To re-enable the previous mode allowing JOINs and using VCS, set the following property in nuxeo.conf:

org.nuxeo.cmis.joins=true

Multi-Tenant

If you use multi-tenant, you should pay attention to https://jira.nuxeo.com/browse/NXP-13724

Virtual Navigation

The Multi-navigation view that came with Virtual Navigation (to add new tabs beside the tree) has been moved to CAP. See https://jira.nuxeo.com/browse/NXP-15242 for details.

Fast Track Versions Upgrade Notes

The Fast Track per Fast Track upgrade notes path is still available below:

  • 5.8 -> 5.9.1: JIRA - [PDF]({{file name='UpgradeNotes-NuxeoPlatform5.9.1.pdf' space='admindoc60' page='upgrade-from-58-to-60'}})
  • 5.9.1 -> 5.9.2: JIRA - [PDF]({{file name='UpgradeNotes-NuxeoPlatform5.9.2.pdf' space='admindoc60' page='upgrade-from-58-to-60'}})
  • 5.9.2 -> 5.9.3: JIRA - [PDF]({{file name='UpgradeNotes-NuxeoPlatform5.9.3.pdf' space='admindoc60' page='upgrade-from-58-to-60'}})
  • 5.9.3 -> 5.9.4: JIRA - [PDF]({{file name='UpgradeNotes-NuxeoPlatform5.9.4.pdf' space='admindoc60' page='upgrade-from-58-to-60'}})
  • 5.9.4 -> 5.9.5: JIRA - [PDF]({{file name='UpgradeNotes-NuxeoPlatform5.9.5.pdf' space='admindoc60' page='upgrade-from-58-to-60'}})
  • 5.9.5 -> 6.0: JIRA

You may also want to have a look at the release notes:

{{! /multiexcerpt}}

{{#> panel heading='Related Documentation'}}
  • [Nuxeo Platform 6.0 Packaging Changes and Deprecations]({{page page='nuxeo-platform-60-packaging-changes-and-deprecations'}})
  • [Upgrade to JSF2]({{page page='upgrade-to-jsf2'}})
  • [Upgrading the Nuxeo Platform]({{page page='upgrading-the-nuxeo-platform'}})
  • [Studio Project Specific Upgrade Instructions]({{page space='studio' page='specific-upgrade-instructions'}})

{{/panel}}

 

You can’t perform that action at this time.