off the treadmill: building a drupal platform for your organization
DESCRIPTION
Drupal Distributions! We know and love Commons, Open Atrium, Open Publish, COD and other off the shelf projects. But what about your organization’s unique needs and use cases? You want to stop building websites and start building a repeatable system of your own. But how? In this talk I share lessons learned from my time in Drupal consulting, including a one year establishing a common platform at a magazine publisher (30+ titles) as well as what I see on the front lines at Acquia. I want attendees to walk away with a vision to move from site building and into internal product development. For attendees already on this path I want to share lessons from my time in the trenches. Specific takeaways: How to get off the site building treadmill and into developing a product. “We don’t have the time” will no longer be an excuse. How to deal with inconsistencies between sites. Decide what should be unique vs. what should be standardized. Your love/hate relationship with Features (for example, how to deal with feature overrides). How to deal with tricky upgrade path issues as your platform matures.TRANSCRIPT
![Page 1: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/1.jpg)
Off the Treadmill: Building a Drupal Platform for Your OrganizationRick Vugteveen (@rickvug)Pacific Northwest Drupal Summit 2013
Wednesday, 9 October, 13
![Page 2: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/2.jpg)
Hello!
• @rickvug on Twitter, Drupal.org etc.
• Drupal and I have history: Dev, Business Dev, Technical Architect, Product manager.
• Currently work in Solutions Architecture at Acquia.
Wednesday, 9 October, 13
![Page 3: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/3.jpg)
What will we be talking about?
• Code management strategies. Understanding your options and trade-offs.
• How to structure your code into re-usable Platform functionality vs. Site specific code.
• How to deal with problems with Features.
• Consistency and upgrade path issues.
• Whatever you want!
Wednesday, 9 October, 13
![Page 4: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/4.jpg)
Things I like but don’t expect to talk about
• How branching works or other Git fundamentals
• Drush Make
• The basics of Features
• Strongarm
• Exportables
Wednesday, 9 October, 13
![Page 5: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/5.jpg)
Setting the stage
Wednesday, 9 October, 13
![Page 6: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/6.jpg)
• Duplication of content"
• Disparate sources"
• Disconnected reporting"
• Islands of excellence"
Inside Many Large Organizations, the Web Is Broken
Wednesday, 9 October, 13
![Page 7: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/7.jpg)
Assemble solutions in Drupal
Drupal core! Drupal + recommended!modules!
Solution Distributions!
Wednesday, 9 October, 13
![Page 8: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/8.jpg)
The Dream
Department sites!
Data portals!Primary site!
Microsites!
Collaboration Intranet !
Departmental Sites!
Wednesday, 9 October, 13
![Page 9: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/9.jpg)
Wednesday, 9 October, 13
![Page 10: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/10.jpg)
Wednesday, 9 October, 13
![Page 11: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/11.jpg)
Does this sound familiar?
• “All of our Drupal sites have slight differences. It is difficult to keep track of the differences and maintain them all.”
• “I feel like we keep on developing the same functionality over and over again.”
• “Bug-fixing and fire-fighting never ends. We need to get back to creating new business value”.
• “We don’t have time to build things the right way”.
Wednesday, 9 October, 13
![Page 12: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/12.jpg)
Wednesday, 9 October, 13
![Page 13: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/13.jpg)
Code management & deployment strategies
Wednesday, 9 October, 13
![Page 14: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/14.jpg)
Site (Yellow):/sites/foo/modules/*/sites/foo/themes/*/sites/bar/modules/*/sites/bar/themes/*
Platform (Brown):/profiles/foo/modules/*/profiles/foo/themes/*
Core (Blue):/modules/*/themes/*/includes... etc.
DrupalCore
Platform Theme, Modules & Features
Site specific Theme,
Modules & Features
Wednesday, 9 October, 13
![Page 15: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/15.jpg)
Multi-site model
SiteB
SiteA
SiteC
SiteD
Git Repo
Wednesday, 9 October, 13
![Page 16: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/16.jpg)
Vendor branching model
SiteA
DrupalCore
Features
Site Code
SiteB
SiteC
SiteD
Git Repos
Sites
Platform
Wednesday, 9 October, 13
![Page 17: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/17.jpg)
SiteB
SiteA
SiteC
SiteD
SiteA
SiteB
SiteC
SiteD
DrupalCore
Features
Site Code
Drupal Multisite Architecture✓ Makes it easy to keep core and platform changes
in sync among many sites- Makes it really hard to test and assure quality on
core or platform changes that may a!ect tens or hundreds of sites
- Is di"cult to divide responsibility among di!erent teams of developers and testers
Independent Drupal codebases✓ Lets each site be tested, QA'd individually at their
own pace✓ Lets independent teams work on individual sites
without breaking others- Can lead to forking of core and platform code- Is di"cult to maintain
Lots of Code, Lots of Sites, Lots of Compromises
Wednesday, 9 October, 13
![Page 18: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/18.jpg)
Mmmmm... Cake
Site Stuff
Platform Stuff
Core Stuff
▪ Segregate responsibility for site-speci!c development, platform development and QA
▪ Let dev teams use the tools they're used to (git, Github, Drupal)
▪ Combine the bene!ts of multisite and independent codebases
Wednesday, 9 October, 13
![Page 19: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/19.jpg)
How does it do it?
Dev Stage Prod
Platform/SitePush to production
(manual and automated)
SiteA
SiteB
SiteC
SiteA
Site CodePublishingProcess
Hosting Environments
Git Repos
Git Repos
DrupalCore
Features
Site Code
Managed Cloud
Distribution Environment
Site A Setup
Tag
Platform 10Platform
1.4.3
Site Tag 4.3.6
TargetTag newfeaturebranchTarget
Repo Dev 3
Code Distribution Management
Platform 10
Platform 11
Platform 12
Platform 10
Wednesday, 9 October, 13
![Page 20: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/20.jpg)
Who does Layer Cake work for?
Site DeveloperCommits themes,
modules to Site repo
Platform DeveloperCommits changes to
repos managing Drupal core, platform features and modules
Dev EnvironmentsDeveloper sandbox
environments
Production HostingProduction
environment(s)
Platform AdminManages available
deployment environments, setup
QA TeamTests and pushes approved
code to production, for 1 site or 100's
Wednesday, 9 October, 13
![Page 21: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/21.jpg)
Developers!
DevelopersCommit to repos
they've been granted access to in Github
Developer's personal sandbox where they can test against replica of production stack
Use Layer Cake to deploy their repos
periodically to sandboxes
Wednesday, 9 October, 13
![Page 22: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/22.jpg)
Admins!
Developer CSandbox
Production HostingProduction HA environments
Platform AdminSets holds the keys to
creating new mappings
Site A Setup
Tag
Platform 10Platform
1.4.3
Site Tag 4.3.6
TargetTag newfeaturebranchTarget
Repo DevCloud 3
Developer ASandbox
Developer DSandbox
Wednesday, 9 October, 13
![Page 23: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/23.jpg)
Quality Assurance!
Production HostingProduction HA environments
QA TeamTests and pushes approved
code to production, for 1 site or 100's
Platform 10b
Keyword text
Filter Sites
Deploy Stage -> Prod
Site Version
4.5
7.2
3.1
1.0
134.2
Site
Site B
Site D
Platform Version
10b
Site C
Site E
10b
Site A
10b
10b
10b
Deploy Cancel
Wednesday, 9 October, 13
![Page 24: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/24.jpg)
Site/Code management gotchas
• Testing the upgrade path on all sites. Shoot for eventual consistency but beware of the dangers of falling out of sync.
• Watch out for update.php, or what we call “the Upgrade Dance”.
• When using the Layer Cake approach beware Platform and Site compatibility issues.
Wednesday, 9 October, 13
![Page 25: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/25.jpg)
Flexibility vs. Effort
• Multi-tenant: One database, one Drupal installation (ie. Domain Access).
• Hybrid: Multiple databases, one Drupal installation. (Multi-site, potentially a true Distribution)
• Multi-instance: Multiple databases, multiple Drupal installations. (potentially Vendor Branching)
Wednesday, 9 October, 13
![Page 26: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/26.jpg)
But I’m already a Cowboy!
Wednesday, 9 October, 13
![Page 27: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/27.jpg)
Baby steps
• Do an inventory. How many sites do we have? How similar are they? Are we looking at one platform or many?
• You can start just by moving modules around.
• Then start standardizing the list of modules you are using.
• Once modules are standardized, start capturing yourcommon configurations into Features.
Wednesday, 9 October, 13
![Page 28: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/28.jpg)
Features. Love them. Hate them. Use them.
Wednesday, 9 October, 13
![Page 29: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/29.jpg)
Where I’m coming from
30 magazines, up to 60 sites (long term), ~10 legacy content management systems.
Goal: One Drupal Platform.
Wednesday, 9 October, 13
![Page 30: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/30.jpg)
Wednesday, 9 October, 13
![Page 31: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/31.jpg)
Wednesday, 9 October, 13
![Page 32: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/32.jpg)
Wednesday, 9 October, 13
![Page 33: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/33.jpg)
Wednesday, 9 October, 13
![Page 34: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/34.jpg)
Wednesday, 9 October, 13
![Page 35: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/35.jpg)
Dennis Publishing Example
• Dennis Core:
• Base theme
• Media Management
• WYSIWYG
• Image cache settings
• Contexts (or Panels)
• Base Menus
Wednesday, 9 October, 13
![Page 36: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/36.jpg)
Dennis Publishing Example
• Optional:
• Article
• Gallery
• Carousel
• Video player
Wednesday, 9 October, 13
![Page 37: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/37.jpg)
Wednesday, 9 October, 13
![Page 38: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/38.jpg)
Overridden Features
• Problem: Feature overridden due to configuration changes done in dev, stage or prod.
• Fix: You’re doing it wrong!
• Adopt a proper dev-> stage -> prod workflow.
• Automatically revert Features on deployments. Script drush fr.
• “drush fu” your workflow. (best Drush command ever!)
Wednesday, 9 October, 13
![Page 39: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/39.jpg)
Overridden Features because of site differences
• Problem: I want to set defaults but I don’t need them enforced on each site.
• Example: Comment settings should have a default but may change on a per site basis.
• Potential Solution:
• Don’t be afraid of .install files, hook_update_N(), variable_set and friends. Only Strongarm variables you don’t want to change.
• Or structure your Features differently...
Wednesday, 9 October, 13
![Page 40: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/40.jpg)
Structuring Features
• Make your Features granular with a proper dependency chain.
• Example: Blog Feature and Gallery Feature both depend on the Categories vocabulary. Create a Categories Feature with only that vocabulary. Have other Features depend on that.
• Capture your data structure in your Platform. Move display setting into a Site modules.
• Example:/profiles/distroname/features/distroname_blog_structure/sites/sitename/features/sitename_blog_display(or have shared base fields as their own Feature)
Wednesday, 9 October, 13
![Page 41: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/41.jpg)
Wednesday, 9 October, 13
![Page 42: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/42.jpg)
Wednesday, 9 October, 13
![Page 43: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/43.jpg)
Wednesday, 9 October, 13
![Page 44: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/44.jpg)
What the hell is a Skeleton Feature?
• Located at /profile/dennis_distro/modules/skel/*
• Naming convention: skel_blog_display, skel_gallery_display etc.
• 1. On distro install automatically copy over skel modules from profile/platformname/modules/skel/* to sites/sitename/modules/features/*.
• 2. Automatically find and replace “skel” with “sitename”. Eg. changes hook implementation from skel_blog_display_menu() to sitename_blog_display_menu().
• 3. hook_info_alter() any modules with the prefix “skel_”. You’ll never see them and Features will ignore.
• After install: /sites/sitename/modules/features/sitename_blog_display.Wednesday, 9 October, 13
![Page 45: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/45.jpg)
Features upgrade path issues
• No silver bullet for data structure changes. Avoid at all costs. Get your hands dirty if needed.
• Start with multiple implementations of a Platform Feature to ensure the structure is generic enough.
• Push back on asks for site specific data structure. Get creative with Taxonomy.
• Adding to data structure on a per site basis is fine.
Wednesday, 9 October, 13
![Page 46: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/46.jpg)
Wrapping up. What we (hopefully) learned
• Code management strategies. Understanding your options and trade-offs.
• How to structure your code into re-usable Platform functionality vs. Site specific code.
• How to deal with problems with Features.
• Consistency and upgrade path issues.
Wednesday, 9 October, 13
![Page 47: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/47.jpg)
Additional Resources
• Phase2 Blog post on Features Base Fields: http://www.phase2technology.com/blog/new-field-bases-and-instances-in-features/
• Patch for Features Base Fields: https://drupal.org/node/1064472
• Multi-headed Drupal: http://palantir.net/blog/multi-headed-drupal
• The Drupal-Powered Enterprise White Paper: https://www.acquia.com/resources/whitepapers/drupal-powered-enterprise
Wednesday, 9 October, 13
![Page 48: Off the Treadmill: Building a Drupal Platform for Your Organization](https://reader034.vdocuments.net/reader034/viewer/2022051323/54b755524a795967588b479a/html5/thumbnails/48.jpg)
Thanks!
Rick Vugteveen@rickvug
[email protected]@acquia.com
PS - I’m hiring! Let’s talk.
Wednesday, 9 October, 13