Originally presented at PNW Drupal Summit 2013. Revised for BADCamp 2013.
You have an aging Drupal 6 or even a Drupal 5 site. You know it's time to move up to Drupal 7. Now, how? There are two main ways to get there. You can perform a traditional upgrade, or you can migrate the data from the old site to a brand new site. In this session I will show how you can use these methods and discuss their benefits and drawbacks, including a thought process to go through when evaluating these options, drawing from some recent projects.
2. Overview
• Getting your Drupal 6 site onto Drupal 7
• Use traditional upgrade or migrate data to
new site
• Look at the benefits and drawbacks of both
approaches
• Primarily for people who have not gone
through either process
Your site is unique, so take what you find today and let it help you in your decision making. I
won't be saying always do it one way.
Both approaches do require work.
5. Deployment
• Same issues as replacing any site, unless the
D6 site is incredibly simple.
I won't be dwelling on this today because it is such a common task.
6. Upgrade overview
• Swap out the foundation, house in place.
• Replace codebase, run upgrade scripts on
existing data & files.
• Built into core and contrib.
• UI based
Lift the house, swap in a new foundation, set the house down on the new foundation.
The upgrade scripts essentially upgrade the plumbing and wiring to be compatible with the
new foundation.
UI centered, but drush can be used for most upgrades as well. 'drush updb'
7. Upgrade drawbacks
• Hard to get rid of legacy cruft
• Field names
• Content type structures
• Anything else that seems old or odd
8. Migrate overview
• Build new house on a new foundation.
• Build new site. Import data from old site.
• Write custom code to define the specifics
of the migration.
The details of a migration must be handled by writing custom code. There is also helpful
support in the UI.
9. Migrate drawbacks
• Very code-centric
• Very granular
Averse to custom coding? Maybe prefer upgrade. But Migrate isn't so hard, I promise!
Granular: you generally have to specify everything (image alt, title, language, etc.). Of course,
that could also be a good thing. You're in full control.
10. Feeds
• Best fit is to regularly import new data.
• Not usually a good fit for full migrations.
• Easy to learn, but it usually falls short when
getting into the details, such as handling
relationships and very large datasets.
I really like feeds, and it can be super for importing data into Drupal. But it's just not a
module I generally recommend for a full site migration.
11. Initial preparation
• Regular D7 system requirements
(drupal.org/requirements)
• Local development environment that can
support several copies of the site
• Reference site
• Data source
• Development
CHAPTER 1
D7: PHP 5.3 recommended, MySQL 5.
Local Dev: for testing, experimenting, practicing
12. Architecture of current
site
• Inventory of modules, libraries, themes
•drush pml | grep Enabled
• Content Types, fields
• Views, other configuration
• Important pages, capabilities, workflows
• Reference copy of the site
Save lists of directories (list of modules)
Save drush output
Save certain pages
Have a clear idea of exactly what it is you're upgrading from
14. Determine upgrade
path
• Module to D7 options
• same module (pathauto)
• different module
• moved into core (CCK to fields)
• nothing available, so custom solution
This is where most of the upgrade work will be.
Be sure to check if D7 version of modules have their own dependencies. Views adds a ctools
dependency. Others will likely require the libraries module.
15. Determine upgrade
path
• Custom modules
• Converting 6.x modules to 7.x:
http://drupal.org/node/224333
• Coder module
Any custom code will need to be updated to match the Drupal 7 API and coding standards.
16. Determine upgrade
path
• Theme
• Update or replace base theme
• Update or rebuild subtheme
• Upgrading 6.x themes to 7.x
https://drupal.org/node/254940
A custom theme is custom code, so needs same attention.
17. Prepare the source
• Install a copy of the site to use as the
source.
• Remove all disabled or unused modules.
• Update all remaining modules to their
latest D6 versions.
18. How to Upgrade
• Practice on a copy of the site.
• 3 dev sites:
• Pristine copy of site for reference.
• Copy of site with everything D6 updated.
• Copy that is actually getting upgraded.
CHAPTER 2
19. Today's Example
• RidePDW.com Portland Design Works
• Portland company that develops bicycle
accessories
I experimented with an upgrade, but ended up doing a migration instead, primarily because
of keeping data in sync.
20.
21. Process
• Commit after each step.
• Definitely after updating each module.
• Include db exports, as outside files.
DB Exports: if not in the repo, in their own folder.
22. Upgrade core
• Refer back to your list of all enabled
modules
• Disable all enabled contrib modules
• Switch theme to Garland, including the
admin theme
23. Upgrade core
• Use the copy of the site that you have for
actually upgrading
• Replace core files manually
• Delete core directories & files
• Add the new ones
• Download Drupal, move the files into
place
I generally prefer to swap in the new files/folders, rather than building up a new codebase.
(List of "incompatible" modules helps me know where I am)
24. Update the database
• Do 'drush updb' (Or use /update.php)
• Watch output, observe warnings
• Save output to refer back to
29. Core upgrade
complete!
• Yay!
• You're running Drupal 7 now
• Commit the current state to a repo
• Next step, contrib modules
30. Upgrading contrib
modules
• Upgrade one at a time
• Module's d.o page
• Module's README.txt or INSTALL.txt or
UPGRADE.txt
• Check for special steps, instructions
• Check for new dependencies
Do a little research on each module before trying. Then go ahead and try.
Dependencies: views needs ctools. ubercart needs rules. rules needs entity.
31. Add the new code
• This works: drush dl modulename
• Or, delete existing, then add the new
32. Where to start?
• Start with the most foundational
• ctools
• views
• Or most standalone
• pathauto
• devel
33. Views
• Replace views code
• Update database
• Enable the upgraded module
This is the usual process. But it's still best to see the module's upgrade documentation first.
37. Upgrade CCK
• Download D7 version of CCK
• Enable the content_migrate module
• Use the UI to migrate CCK fields to drupal
core fields
Kind of a special case, because it's a major architectural change, bringing fields into core.
Also common pattern: contrib module providing upgrade path into core.
38. Available fields
Provides suggestions of things to do, and notes about what it will do.
Caveat: it lets you migrate fields, even if the relevant content type does not yet exist properly
in the upgraded site. Should content types come before fields?
41. Migrate CCK fields
• Install required modules
• Enable modules that define content types
• Sometimes several layers of dependencies
emerge
• Can end up being messy and difficult to
fully successfully migrate all CCK fields.
dependency chain: Nodereference field is used to refer to products. Products are defined by
ubercart. Ubercart requires Rules. Rules requires entity api.
42. That was Upgrade
• Mainly a taste of what's in store when
doing an upgrade
44. How to Migrate
• Building a whole new house, with its own
new foundation.
• Then we will move all of our data into it.
45. Plan and get organized
• Collect data and files into a safe place, to
use as a pristine, read-only source.
• Make a spreadsheet or list to plan out your
mapping
• Build out the architecture of the new site
Identify questionable or troublesome pieces, e.g. whether to keep certain fields.
Build: at least content types & fields.
Anything else that is needed by your migrated data.
46. Set up environments
• Install or get access to a reference site
• Install source database
• Install a built destination site
• An IDE for exploring the migrate API
reference site = this is how it currently is. must be inspectable.
48. Start a new module
• Install the migrate module
• Create a new module that extends classes
that are in the migrate module
49. Important functions
• addFieldMapping()
• addSimpleMappings()
• defaultValue()
• sourceMigration()
• addUnmigratedDestinations()
• addUnmigratedSources()
Just to get a flavor of what you will be using.
50. Module structure
• .info file: file list
• .module file: specify migrations via
hook_migrate_api()
• Migration class files: handle the details and
mappings of a migration
• name: sitename_migration
.info file: Mainly lists files that are used.
.module file: register migrations and their classes by using hook_migrate_api().
Migration class files: I generally prefer one class per file, but there's nothing wrong with
having multiple classes in one file too.
51. Directory list
Most basic structure that provides a functional migration. But there are many more
complicated examples.
58. Migration class
• Set description
• Define database source
• Create query to get data
• Tell migrate that this query is the source of
this migration
• Do the mappings
This is essential before you can enable your custom module without errors.
77. Repeats
• "Update" completely overwrites
• Highwater mark
In addition to rollback and reimport.
highwater mark, important for bringing in added content.
brings in any new items with a greater value of highwater than last recorded.
No other comparisons. (no import "changed")
80. migrate_d2d
• Current stable version (2.0)
• Ends up being somewhat cumbersome.
• Dev version (2.1-beta1)
• Looks very promising
Not migrate_d2d 2.0:
- complicated things for me as a newcomer to the migrate framework.
- Added too many layers and did not streamline things for me.
- Had to unmap many things that it automatically mapped for me.
81. migrate_d2d 2.1
• Provides migration setup wizard
• Provides UI for field mapping
• Requires 2.6 version of Migrate module,
which is also still in development
94. migrate_d2d drawbacks
• Still really new (alpha/beta/dev status)
• Making changes to initial settings
overwrites existing migrate configuration
• Cannot (yet) export configuration
• drupal.org/node/1983404
• Uncertain how to add regular migrate code
to what is done in the UI
• drupal.org/node/2118243
Making changes, such as database credentials or adding a content type.
Regular programmatic code = prepareRow, anything that the UI doesn't provide but is
available in the API.
96. QA. Did it work?
• Regardless whether upgrade or migrate
• Have someone else check your work
• Have the client check your work
• Pass any existing acceptance tests
SIDEBAR
Make certain. This will be the content of the next version of this site.
97. QA Questions
• Correct content?
• Correct versions of content?
• Complete number of fields?
• Complete metadata? (urls, relations, dates,
authors, tags)
• Complete number of nodes?
• Images and media? (block live site)
98. Which way do I go?
• WHY do you want to go?
CHAPTER 4
First thing to think about is why specifically do you want to move to Drupal 7?
Are there architectural things that need to be changed in your site, in order to take advantage
of what you want from D7?
99. Traditional upgrade if:
• Drupal site, only one version back
• Simple site
• Few contrib modules
• End result should mirror current site
• Content is infrequently updated
• A little downtime is OK
Downtime can still be avoided, using good deployment methods.
Also, if limited time is available (and the other conditions are met).
100. Migrate if:
• Drupal 5 site, or even a different platform
• Complex site
• Many contrib modules
• New site needs structural changes or
enhancements
• Content is frequently updated
• Minimal downtime is very important
101. Conclusion (?)
• traditional upgrade
• migrate
If you want something that is quick and your site's upgrade path supports it, go with a
traditional upgrade.
If you want to make a lot of structural changes and need fine control over the upgrade path,
go with migrate.
102. Future of upgrades and
migrations
• Migrate is being added to Drupal 8 core, to
provide a smooth upgrade path from D6
and D7 core.
• https://groups.drupal.org/imp
• http://www.drupal4hu.com/node/381
104. More Bookmarks
• Making the case for the migrate module
• http://www.verbosity.ca/getting-contentdrupal-migrate-module
• BTMash articles
• http://btmash.com/article/2011-03-02/
migrating-content-part-1-users
• http://btmash.com/article/2011-03-25/
migrating-content-part-2-nodes
• http://btmash.com/article/2011-04-27/
migrating-content-part-3-nodes-your-ownfield-handlers