Using Buildout, GenericSetup and a Policy Package to Rule the World
3 likes790 views
The document discusses using Buildout, GenericSetup, and a policy package to create repeatable Plone site environments, including setting up profiles for installation and upgrades, content packages for initial content, and a Plone site recipe for Buildout to automate site creation. It also provides an example of setting up a policy package, various profiles, and using GenericSetup and upgrades to manage a site configuration.
![Add to buildout PLONE SYMPOSIUM EAST 2012
[buildout]
extensions = mr.developer
auto-checkout = True
parts = instance
[sources]
pse12.policy = git <git url here>
[instance]
eggs = pse12.policy](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-13-320.jpg)
![Dependencies PLONE SYMPOSIUM EAST 2012
# pse12.policy/setup.py
install_requires=[
'setuptools',
'Plone',
'Pillow',
'plone.app.caching',
],](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-14-320.jpg)
![ZCML PLONE SYMPOSIUM EAST 2012
# pse12.policy setup.py
entry_points="""
[z3c.autoinclude.plugin]
target = plone
""",
<!-- pse12.policy configure.zcml -->
<includePlugins package="." />
<includeDependencies package="." />](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-15-320.jpg)
![Package PLONE SYMPOSIUM EAST 2012
# Inside setup.py
install_requires=[
...
‘plonetheme.transition’,
],](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-21-320.jpg)
![Blog PLONE SYMPOSIUM EAST 2012
# Inside pse12.policy setup.py
install_requires=[
...
‘collective.blog.star’,
],](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-25-320.jpg)
![Package PLONE SYMPOSIUM EAST 2012
# Inside pse12.initialcontent setup.py
install_requires=[
‘quintagroup.transmogrifier’,
],](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-29-320.jpg)
![Setuphandlers PLONE SYMPOSIUM EAST 2012
from sixfeetup.utils import helpers as sfutils
def importVariousInitial(context):
"""Run the setup handlers for the initial profile"""
if context.readDataFile('pse12_policy-initial.txt') is None:
return
members = [
{'id': 'staff',
'password': 'staff',
'roles': ['Manager', 'Member'],
'properties': {
'email': 'changeme@example.com',
'fullname': 'Site Staff',
'username': 'staff'
}
}
]
sfutils.addUserAccounts(members)](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-34-320.jpg)
![from zope.app.component.hooks import getSite
PLONE SYMPOSIUM EAST 2012
from Products.CMFCore.utils import getToolByName
from sixfeetup.utils import helpers as sfutils
def intranet_setup(context):
"""Set up the placeful workflow for the intranet
"""
portal = getSite()
# If the intranet doesn't exist, bail out
if 'intranet' not in portal.objectIds():
return
intranet = portal['intranet']
# If the placeful workflow is already in place, bail out
if '.wf_policy_config' in intranet.objectIds():
return
placeful_workflow = getToolByName(portal, 'portal_placeful_workflow')
product = 'CMFPlacefulWorkflow'
intranet.manage_addProduct[product].manage_addWorkflowPolicyConfig()
config = placeful_workflow.getWorkflowPolicyConfig(intranet)
policy = 'intranet'
config.setPolicyBelow(policy=policy)
config.setPolicyIn(policy=policy)
# Make everything in the intranet `private`
path = '/'.join(intranet.getPhysicalPath())
sfutils.publishEverything(context, path, 'hide')](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-39-320.jpg)
![from zope.app.component.hooks import getSite
PLONE SYMPOSIUM EAST 2012
def default_pages(context):
"""There is a bug in quintagroup.transmogrifier that prevents
the default page from being set. We will handle it here
instead.
"""
portal = getSite()
items = {
'about': dict(
id='default_page',
type='string',
value='about-us'),
'blog': dict(
id='layout',
type='string',
value='blog_view'),
}
for path, prop in items.items():
obj = portal.unrestrictedTraverse(path, None)
# If the object doesn't exist, bail out
if obj is None:
continue
target_obj = None
if prop['id'] == 'default_page':
target_obj = obj.unrestrictedTraverse(prop['value'], None)
# Bail out if the default page target does not exist
if target_obj is None:
continue
obj._setProperty(prop['id'], prop['value'], prop['value'])
if target_obj is not None:
# ensure that it doesn't show in the navigation
target_obj.reindexObject()](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-40-320.jpg)
![Add it to buildout PLONE SYMPOSIUM EAST 2012
[buildout]
parts = plonesite
[plonesite]
recipe = collective.recipe.plonesite
instance = instance
zeoserver = zeoserver
site-id = Plone
admin-user = admin](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-43-320.jpg)
![Add profiles PLONE SYMPOSIUM EAST 2012
[plonesite]
...
profiles-initial = pse12.policy:initial
profiles = pse12.policy:default](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-44-320.jpg)
![Buildout run PLONE SYMPOSIUM EAST 2012
$ bin/buildout install plonesite
Installing plonesite.
Retrieved the admin user
Added Plone Site
Quick installing: []
Running profiles: ['pse12.policy:initial']
Finished
Running profiles: ['pse12.policy:default',
'sixfeetup.customfolderalert:default',
'plone.app.debugtoolbar:default']](https://image.slidesharecdn.com/ruletheworld-120523134709-phpapp02/85/Using-Buildout-GenericSetup-and-a-Policy-Package-to-Rule-the-World-45-320.jpg)
Using Buildout, GenericSetup and a Policy Package to Rule the World
- 1. Using Buildout, GenericSetup and a Policy Package to Rule the World Clayton Parker | Senior Developer PLONE SYMPOSIUM EAST 2012
- 2. Who Am I
- 3. What will we learn? PLONE SYMPOSIUM EAST 2012 • Policy Package • GenericSetup • Plone Site Buildout Recipe http://github.com/sixfeetup
- 4. Demo
- 7. Realization • Repeatable environments • Fewer commands • Repeatable product installation
- 8. PLONE SYMPOSIUM EAST 2012
- 9. Human Err0r PLONE SYMPOSIUM EAST 2012 “Hey Bob, did you run the fizzbang.widget profile on production” “I think so, Doug” “Do you know why the client is yelling at me right now?” “Maybe I didn’t, let me fix that real quick”
- 10. Policy Package
- 11. Create the package* PLONE SYMPOSIUM EAST 2012 $ cd path/to/buildout/src $ zopeskel sfu_policy pse12.policy $ cd pse12.policy .. git init / add / etc ... * This example uses sixieskel for brevity, you might use the “plone” template
- 12. Package layout PLONE SYMPOSIUM EAST 2012 !"" setup.py #"" src #"" pse12 !"" __init__.py #"" policy !"" __init__.py !"" configure.zcml !"" profiles % !"" default % % #"" metadata.xml % #"" initial % #"" metadata.xml !"" setuphandlers.py !"" upgrades.py #"" upgrades.zcml
- 13. Add to buildout PLONE SYMPOSIUM EAST 2012 [buildout] extensions = mr.developer auto-checkout = True parts = instance [sources] pse12.policy = git <git url here> [instance] eggs = pse12.policy
- 14. Dependencies PLONE SYMPOSIUM EAST 2012 # pse12.policy/setup.py install_requires=[ 'setuptools', 'Plone', 'Pillow', 'plone.app.caching', ],
- 15. ZCML PLONE SYMPOSIUM EAST 2012 # pse12.policy setup.py entry_points=""" [z3c.autoinclude.plugin] target = plone """, <!-- pse12.policy configure.zcml --> <includePlugins package="." /> <includeDependencies package="." />
- 16. Generic Setup
- 17. Default profile PLONE SYMPOSIUM EAST 2012 <!-- pse12.policy configure.zcml --> <genericsetup:registerProfile name="default" title="pse12.policy (default)" directory="profiles/default" description="Installation profile for pse12.policy" provides="Products.GenericSetup.interfaces.EXTENSION" />
- 18. Initial profile PLONE SYMPOSIUM EAST 2012 <!-- pse12.policy configure.zcml --> <genericsetup:registerProfile name="initial" title="pse12.policy (initial)" directory="profiles/initial" description="Initial profile for pse12.policy" provides="Products.GenericSetup.interfaces.EXTENSION" />
- 19. Metadata PLONE SYMPOSIUM EAST 2012 <?xml version="1.0"?> <metadata> <version>001</version> <dependencies>...</dependencies> </metadata>
- 20. Add-ons
- 21. Package PLONE SYMPOSIUM EAST 2012 # Inside setup.py install_requires=[ ... ‘plonetheme.transition’, ],
- 22. Package PLONE SYMPOSIUM EAST 2012 <?xml version="1.0"?> <!-- pse12.policy metadata.xml --> <metadata> <version>001</version> <dependencies> <dependency>profile-plone.app.theming:default</dependency> </dependencies> </metadata>
- 23. Package PLONE SYMPOSIUM EAST 2012
- 24. Package PLONE SYMPOSIUM EAST 2012 # profiles/default/registry.xml <registry> <record field="enabled" interface="plone.app.theming.interfaces.IThemeSettings" name="plone.app.theming.interfaces.IThemeSettings.enabled"> <field type="plone.registry.field.Bool"> <default>False</default> <description>enable_theme_globally</description> <title>enabled</title> </field> <value>True</value> </record> <record field="absolutePrefix" interface="plone.app.theming.interfaces.IThemeSettings" name="plone.app.theming.interfaces.IThemeSettings.absolutePrefix"> <field type="plone.registry.field.TextLine"> <description>convert_relative_url</description> <required>False</required> <title>absolute_url_prefix</title> </field> <value>/++theme++plonetheme.transition</value> </record> <record field="currentTheme" interface="plone.app.theming.interfaces.IThemeSettings" name="plone.app.theming.interfaces.IThemeSettings.currentTheme"> <field type="plone.registry.field.TextLine"> <description>current_theme_description</description> <title>current_theme</title> </field> <value>plonetheme.transition</value> </record> <record field="rules" interface="plone.app.theming.interfaces.IThemeSettings" name="plone.app.theming.interfaces.IThemeSettings.rules"> <field type="plone.registry.field.TextLine"> <description>rules_file_path</description> <required>False</required> <title>rules_file</title> </field> <value>/++theme++plonetheme.transition/rules.xml</value> </record> </registry>
- 25. Blog PLONE SYMPOSIUM EAST 2012 # Inside pse12.policy setup.py install_requires=[ ... ‘collective.blog.star’, ],
- 26. Blog PLONE SYMPOSIUM EAST 2012 <?xml version="1.0"?> <!-- pse12.policy metadata.xml --> <metadata> <version>001</version> <dependencies> ... <dependency>profile-collective.blog.star:default</dependency> </dependencies> </metadata>
- 27. Content
- 28. Package PLONE SYMPOSIUM EAST 2012 $ zopeskel plone pse12.initialcontent
- 29. Package PLONE SYMPOSIUM EAST 2012 # Inside pse12.initialcontent setup.py install_requires=[ ‘quintagroup.transmogrifier’, ],
- 30. Package PLONE SYMPOSIUM EAST 2012 <!-- pse12.initialcontent configure.zcml --> <genericsetup:registerProfile name="default" title="pse12.initialcontent (default)" directory="profiles/default" description="Content generation package" provides="Products.GenericSetup.interfaces.EXTENSION" />
- 31. Package PLONE SYMPOSIUM EAST 2012 <?xml version="1.0"?> <!-- pse12.initialcontent metadata.xml --> <metadata> <version>001</version> <dependencies> <dependency>profile-pse12.policy:default</dependency> </dependencies> </metadata>
- 32. !"" __init__.py !"" configure.zcml PLONE SYMPOSIUM EAST 2012 !"" profiles # %"" default # !"" metadata.xml # !"" pse12_initialcontent-default.txt # !"" quintagroup.transmogrifier-import.txt # %"" structure # !"" .objects.xml # !"" .portlets.xml # !"" .properties.xml # !"" about # # !"" .marshall.xml # # !"" .objects.xml # # !"" .portlets.xml # # !"" .properties.xml # # !"" about-us # # # !"" .marshall.xml # # # %"" .portlets.xml # # %"" meet-the-team # # !"" .marshall.xml # # %"" .portlets.xml # !"" files # # !"" .marshall.xml # # %"" .portlets.xml # !"" front-page # # !"" .marshall.xml # # %"" .portlets.xml # %"" images # !"" .marshall.xml # !"" .objects.xml # %"" .portlets.xml !"" setuphandlers.py !"" upgrades.py %"" upgrades.zcml
- 34. Setuphandlers PLONE SYMPOSIUM EAST 2012 from sixfeetup.utils import helpers as sfutils def importVariousInitial(context): """Run the setup handlers for the initial profile""" if context.readDataFile('pse12_policy-initial.txt') is None: return members = [ {'id': 'staff', 'password': 'staff', 'roles': ['Manager', 'Member'], 'properties': { 'email': '[email protected]', 'fullname': 'Site Staff', 'username': 'staff' } } ] sfutils.addUserAccounts(members)
- 35. Setuphandlers PLONE SYMPOSIUM EAST 2012 <genericsetup:importStep name="pse12.policy: initial" title="pse12.policy: Various Initial steps" description="Initial Setup handlers for pse12.policy" handler="pse12.policy.setuphandlers.importVariousInitial"> <depends name="content"/> </genericsetup:importStep>
- 36. Setuphandlers PLONE SYMPOSIUM EAST 2012 from sixfeetup.utils import helpers as sfutils def importVarious(context): """Run the setup handlers for the default profile""" if context.readDataFile('pse12_policy-default.txt') is None: return # automagically run a plone migration if needed sfutils.runPortalMigration() # automagically run the upgrade steps for this package sfutils.runUpgradeSteps(u'pse12.policy:default')
- 37. Setuphandlers PLONE SYMPOSIUM EAST 2012 from sixfeetup.utils import helpers as sfutils def importVarious(context): """Run the setup handlers for the default profile""" if context.readDataFile('pse12_initialcontent-default.txt') is None: return # automagically run the upgrade steps for this package sfutils.runUpgradeSteps(u'pse12.initialcontent:default')
- 38. Upgrades PLONE SYMPOSIUM EAST 2012 <!-- pse12.initialcontent upgrades.zcml --> <genericsetup:upgradeStep title="Set up intranet section" description="" source="001" destination="002" handler="pse12.initialcontent.upgrades.intranet_setup" sortkey="10" profile="pse12.initialcontent:default" /> <genericsetup:upgradeStep title="Set up the default pages" description="" source="001" destination="002" handler="pse12.initialcontent.upgrades.default_pages" sortkey="20" profile="pse12.initialcontent:default" />
- 39. from zope.app.component.hooks import getSite PLONE SYMPOSIUM EAST 2012 from Products.CMFCore.utils import getToolByName from sixfeetup.utils import helpers as sfutils def intranet_setup(context): """Set up the placeful workflow for the intranet """ portal = getSite() # If the intranet doesn't exist, bail out if 'intranet' not in portal.objectIds(): return intranet = portal['intranet'] # If the placeful workflow is already in place, bail out if '.wf_policy_config' in intranet.objectIds(): return placeful_workflow = getToolByName(portal, 'portal_placeful_workflow') product = 'CMFPlacefulWorkflow' intranet.manage_addProduct[product].manage_addWorkflowPolicyConfig() config = placeful_workflow.getWorkflowPolicyConfig(intranet) policy = 'intranet' config.setPolicyBelow(policy=policy) config.setPolicyIn(policy=policy) # Make everything in the intranet `private` path = '/'.join(intranet.getPhysicalPath()) sfutils.publishEverything(context, path, 'hide')
- 40. from zope.app.component.hooks import getSite PLONE SYMPOSIUM EAST 2012 def default_pages(context): """There is a bug in quintagroup.transmogrifier that prevents the default page from being set. We will handle it here instead. """ portal = getSite() items = { 'about': dict( id='default_page', type='string', value='about-us'), 'blog': dict( id='layout', type='string', value='blog_view'), } for path, prop in items.items(): obj = portal.unrestrictedTraverse(path, None) # If the object doesn't exist, bail out if obj is None: continue target_obj = None if prop['id'] == 'default_page': target_obj = obj.unrestrictedTraverse(prop['value'], None) # Bail out if the default page target does not exist if target_obj is None: continue obj._setProperty(prop['id'], prop['value'], prop['value']) if target_obj is not None: # ensure that it doesn't show in the navigation target_obj.reindexObject()
- 42. What is it? PLONE SYMPOSIUM EAST 2012 • Create a Plone site • Run profiles • Re-create a site
- 43. Add it to buildout PLONE SYMPOSIUM EAST 2012 [buildout] parts = plonesite [plonesite] recipe = collective.recipe.plonesite instance = instance zeoserver = zeoserver site-id = Plone admin-user = admin
- 44. Add profiles PLONE SYMPOSIUM EAST 2012 [plonesite] ... profiles-initial = pse12.policy:initial profiles = pse12.policy:default
- 45. Buildout run PLONE SYMPOSIUM EAST 2012 $ bin/buildout install plonesite Installing plonesite. Retrieved the admin user Added Plone Site Quick installing: [] Running profiles: ['pse12.policy:initial'] Finished Running profiles: ['pse12.policy:default', 'sixfeetup.customfolderalert:default', 'plone.app.debugtoolbar:default']
- 46. Dynamic options PLONE SYMPOSIUM EAST 2012 $ bin/buildout plonesite:enabled=false $ bin/buildout plonesite:site-replace=true
- 47. Upgrade Demo
- 48. Links PLONE SYMPOSIUM EAST 2012 • sixieskel (http://github.com/sixfeetup/sixieskel) • pse12-example-buildout (http://github.com/sixfeetup/pse12-example-buildout) • pse12.policy (http://github.com/sixfeetup/pse12.policy) • pse12.initialcontent (http://github.com/sixfeetup/pse12.initialcontent) • quintagroup.transmogrifier (http://pypi.python.org/pypi/quintagroup.transmogrifier) • collective.blog.star (http://pypi.python.org/pypi/collective.blog.star) • plonetheme.transition (http://pypi.python.org/pypi/plonetheme.transition/)
- 49. Photo Credits PLONE SYMPOSIUM EAST 2012 • http://www.flickr.com/photos/naturegeak/5642083189/ (who) • https://secure.flickr.com/photos/campuspartymexico/5965708420/ (demo) • https://secure.flickr.com/photos/aon/2171253511/ (realization) • https://secure.flickr.com/photos/walkingsf/6930636483/ (policy) • https://secure.flickr.com/photos/myklroventine/3261364899/ (GS) • https://secure.flickr.com/photos/oskay/2157686638/ (add-ons) • https://secure.flickr.com/photos/simonpholzman/5132795241/ (plone site) • https://secure.flickr.com/photos/bitterjug/488731963// (upgrades) • https://secure.flickr.com/photos/campuspartymexico/5965153009/ (upgrade) • https://secure.flickr.com/photos/friarsbalsam/4609212148/ (content) Thanks to
- 50. Questions? heck out /demos C tup .com si xfee