Install profiles and upgrades

Install profiles and upgrades#

Profiles#

Profile id

Title

Version

pas.plugins.identity:default

Install

1000

pas.plugins.identity:rebuild-catalog

Rebuild the user catalog

—

pas.plugins.identity:uninstall

Uninstall

—

pas.plugins.identity.server:default

Authorization server

1000

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 and UserGroup 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

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 How to 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#

Important

There are no upgrade steps.

upgrades/configure.zcml contains a commented-out example and nothing else. Both installable profiles are at version 1000, and portal_setup will never offer to upgrade this add-on.

A change to a registry record, a content type, a workflow or 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 How to upgrade for the procedure.

Contents