Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Deployers have multiple metadata aggregates from which to choose. This page outlines available options. Policy considerations and general configuration issues are discussed on the Metadata Consumption page. Guidance on how to configure specific metadata clients Metadata Client Software is also available elsewhere in this wiki.

Info
titleStatus of InCommon Metadata on December 18, 2013
Wiki Markup

{div:style=padding-left:1.5em;text-indent:-1.5em;}The _production metadata aggregate_ will be signed using a new self-signed signing certificate (but with the same key) and a [SHA-2|https://en.wikipedia.org/wiki/SHA-2] digest algorithm (specifically, SHA-256).{div}
{div:style=padding-left:1.5em;text-indent:-1.5em;}The _fallback metadata aggregate_ will be identical to the production metadata aggregate except that the fallback metadata aggregate will be signed using the SHA-1 digest algorithm. On June 30, 2014, the fallback metadata aggregate will be sync'd with the production metadata aggregate.{div}
{div:style=padding-left:1.5em;text-indent:-1.5em;}The _preview metadata aggregate_ will be identical to the production metadata aggregate.{div}
{div:style=padding-left:1.5em;text-indent:-1.5em;}The _legacy metadata aggregate_ will remain as-is until March 29, 2014, at which time an HTTP redirect from the legacy metadata aggregate to the fallback metadata aggregate will be installed.{div}
{div}

See the [InCCollaborate:Phase 1 Implementation Plan] of the Metadata Distribution Working Group for more information.

A description of each metadata aggregate follows.

Metadata Aggregates

Note

All aggregates listed below are production-quality metadata aggregates.

The InCommon Export Aggregate (which is not intended for end entities) is described in a separate wiki topic.

Metadata Aggregates

Div
stylefloat:right;margin-left:1em;margin-bottom:1ex;width:22em
Note

Obtain a diff of consecutively published metadata aggregates via web or email

InCommon Operations distributes multiple production-quality On December 18, 2013, InCommon Operations will deploy three new metadata aggregates at the following permanent HTTP locations:

The new locations will ultimately replace the current HTTP location of production metadata:and

Moving forward, all new metadata services will be deployed on vhost md.incommon.org. Legacy vhost wayf.incommonfederation.org will be phased out.

  • IdP-only)

Note

You may also use TLS (https) to download the aggregates noted above. You are strongly advised not to depend solely on TLS for the security of your metadata downloads, and to continue the critical practice of verifying the signature on metadata according to the instructions on the Metadata Consumption page. Clients that are capable of doing so should continue to download metadata over unencrypted http.


All metadata aggregates are signed using the same metadata signing key and the SHA-256 digest algorithm. To verify the signature on an aggregate, a consumer must obtain an authentic copy of the InCommon Metadata Signing Certificate.

Note
titleUsing the IdP-only Aggregate
The IdP-only Aggregate is for SP deployments only!

Operationally, structural changes to metadata are first introduced into the Preview Aggregate and subsequently synchronized with the Main Aggregate and the Fallback Aggregate, in that order. Time between synchronization events depends on the nature of the structural change.

Info
titleCurrent Status of InCommon Metadata

Differences between the various metadata aggregates are recorded and archived daily:

  1. Vertical diff between two consecutive instances of the Main Aggregate

  2. Horizontal diff between the Main Aggregate and the Preview Aggregate

  3. Horizontal diff between the Fallback Aggregate and the Main Aggregate

The vertical diff captures changes to metadata over time. The horizontal diffs record the flow of metadata through the preview-main-fallback pipeline.

Multiple metadata aggregates allows InCommon to deploy changes to metadata more quickly, easily, and safely. Metadata consumers choose exactly one of the three aggregates in the pipeline depending on the immediate requirements of their deployment.

Advanced Tables - Table Plus
columnAttributesstyle="padding-left:1em;text-align:right;,style="padding-left:1em;padding-right:1em;text-align:center;,style="padding-left:1em;padding-right:1em;text-align:center;,style="padding-left:1em;padding-right:1em;text-align:center;",style="padding-left:1em;padding-right:1em;text-align:center;"

...

 


Availability

Stability

Reliability

Affinity

...

Preview Aggregate

24x7

experimental

leading edge

persistent

...

Main Aggregate

24x7

stable

mainstream

persistent

...

Fallback Aggregate

24x7

legacy

trailing edge

transient

...

Multiple metadata aggregates allow InCommon to deploy changes to metadata more quickly, easily, and safely.

Image Added

Preview Metadata Aggregate

The Preview Metadata Aggregate helps manage the introduction of potentially breaking changes into InCommon metadata. Before such a change is deployed to the Main Aggregate, it is first introduced in preview mode. Any issues that surface are addressed before the change is synced with the Main Aggregate.

The Preview Aggregate is designed for deployments on the leading edge, such as test and dev deployments. Such deployments are strongly encouraged to consume the Preview Aggregate instead of the Main Aggregate.

Tip
titleConsume Main or Preview Aggregate?

An important decision point for each deployment is whether to consume the Main Aggregate or the Preview Aggregate.

Main Metadata Aggregate

In the best possible world, a deployment would configure itself to refresh its metadata store from the production metadata aggregate Main Metadata Aggregate and that would be the end of it. The problem is that metadata aggregates are brittle by their very nature, that is, a small change to metadata may have unexpected effects downstream. If this happens, a deployment can “fall back” to a previous version of metadata that is known to be backward compatible.

...

As suggested in the previous section, the fallback metadata aggregate Fallback Metadata Aggregate comes into play when a breaking change is inadvertently introduced into InCommon metadata. When a change is made to the production metadata aggregateMain Aggregate, and that change breaks a downstream metadata process, an affected deployment can temporarily migrate to the fallback metadata aggregateFallback Aggregate. This gives the deployment time to adjust to the breaking change.

Tip
titleConsume the Fallback Aggregate?

A deployment should consume the Fallback Aggregate only when it has to, that is, when it is unable to consume the Main Aggregate. Consuming the Fallback Aggregate is a temporary measure while a deployment reacts to a breaking change introduced into InCommon metadata. See the article Using the Fallback Aggregate for more information.

The fallback metadata aggregate Fallback Aggregate is transient in the sense that backward compatibility is provided for a limited, predetermined period of time. This forces deployments to adjust to breaking changes to production metadata albeit in a controlled environment.

Preview Metadata Aggregate

Like the fallback metadata aggregate, the preview metadata aggregate helps manage the introduction of potentially breaking changes into InCommon metadata. Before such a change is deployed in production, it is first introduced in preview mode. Any issues that surface are addressed before the change is moved to production.

The preview metadata aggregate is designed for deployments on the leading edge, such as test and dev deployments. Such deployments are strongly encouraged to consume the preview metadata aggregate instead of the production metadata aggregate.

...

titleProduction or Preview?

...

.