Install profiles and upgrades

Install profiles and upgrades#

Profiles#

Profile id

Title

Version

pas.plugins.identity:default

Install

1010

pas.plugins.identity:rebuild-catalog

Rebuild the user catalog

—

pas.plugins.identity:uninstall

Uninstall

—

pas.plugins.identity.server:default

Authorization server

1001

pas.plugins.identity.server:uninstall

Uninstall the authorization server

—

All are EXTENSION profiles.

pas.plugins.identity:default#

One profile installs everything the core layer needs:

  • the Identity providers control panel

  • the identity PAS plugin, for extraction, authentication and credentials reset

  • the identity_profile PAS plugin, at the top of IPropertiesPlugin

  • the UserProfile, UserGroup and PrincipalsContainer content types

  • user_profile_workflow and the group workflow

  • the user catalog the two types are filed in

  • the registry records in Settings, pointed at this package's own types

  • the permissions and rolemap in Permissions

Import and export steps#

Beside the steps GenericSetup and Plone already register, this profile carries one of its own.

Step

File

What it does

identity-catalog

identity-catalog.xml

The user catalog's lexicon, indexes and metadata columns

It exists because GenericSetup's own catalog step resolves its target with queryUtility(ICatalogTool), which answers portal_catalog and has no notion of a second catalog. The filename differs for the same reason: a catalog.xml here would be read by that step and applied to the site catalog.

The step is additive and re-runnable, and it exports as well as imports. It does not populate what it creates—see Add an index to the user catalog.

pas.plugins.identity:rebuild-catalog#

Re-catalogs every principal and reports what it repaired.

Apply it when enumeration or group membership returns stale answers—typically after a release that changed what the catalog stores. See Upgrade.

pas.plugins.identity.server:default#

The authorization server: the OAuth and OpenID Connect endpoints in Endpoints, the client registry, the signing keys, and the consent screen.

It is its own entry in the add-ons control panel, with its own install and uninstall button. The panel shows no version beside it, because the entry is named after a package rather than a distribution.

The uninstall profiles#

Every installable profile has a matching uninstall profile, and uninstalling is tested: the test installs, uninstalls, and asserts the site still works with no plugin, registry key, or tool left behind.

Uninstalling removes the catalog, the content types and the workflows. It leaves every UserProfile object and its data exactly where it is.

Upgrades#

pas.plugins.identity:default is at version 1010. upgrades/ holds one package per version, each registering the steps that take a site to it, and portal_setup offers them to a site installed against an earlier release. pas.plugins.identity.server:default is at 1001, with its steps laid out the same way in server/upgrades/. Upgrade lists what each step does.

An upgrade step is for what a reapplied profile cannot carry. Everything else—a registry record, a content type, a workflow, a plugin—reaches an existing site only if the profile is reapplied.

This is what the alpha status means in practice. See Stability for what that implies, and Upgrade for the procedure.

Contents