Setting up global configurations

Application administrators can use the following information to understand what to configure and where to configure it so that Global Configuration Management (GCM) works with the IBM® Engineering Lifecycle Management (ELM) applications that are enabled for configuration management.

Prerequisites

About this topic

This topic describes a typical deployment, which has one GCM instance (regardless of the number of Jazz Team Server instances) across the deployment. If your organization has teams with isolated ELM deployments that need to collaborate across multiple lines of business, you can set up multiple GCM instances in a deployment so that teams can share global configurations. This is an advanced feature. To set up your deployment in this way, read this topic carefully, and then see Enabling GCM servers to contribute configurations to other GCM servers.

Note: A GCM installation has a self-signed certificate for the local host (localhost), but users access GCM through the fully qualified domain name. Therefore, browsers display a warning if the site is untrusted. Even after you add a security exception, the browser might block key dialog boxes, such as those that list configurations from ELM applications. The following solution fixes the problem:
  • Request a certificate that is signed by a trusted certificate authority (CA). The signed certificate eliminates the warnings from the browser. For details, see Installing a security certificate.

Setup

  1. Run the Jazz Team Server setup, which registers and sets up all the ELM applications that you installed on the Jazz Team Server, including GCM. In a distributed environment, you must run the Jazz Team Server setup on the other Jazz Team Server instances to ensure that the applications are registered correctly. For details, see Completing the installation of Jazz Team Server and ELM applications.
  2. If the ELM and GCM applications are registered to the same Jazz Team Server, activate configuration management as described in Setting up ELM applications to use local configurations. Otherwise, follow the steps in Additional steps for a multiple Jazz Team Server topology.

Additional steps for a multiple Jazz Team Server topology

Some distributed deployments have multiple Jazz Team Server instances, which can improve scalability, increase redundancy, or avoid a single point of failure. To set up global configurations in a distributed deployment, you must complete the following steps.

Note:
  • These steps are applicable if there are multiple Jazz Team Server instances and GCM needs a friend relationship with the applications that are not already registered with its own Jazz Team Server instance.
  • If your browser blocks pop-up dialog boxes that you need to log in to GCM or ELM, see Pop-up blocker preventing GCM or ELM login.
  1. From the Jazz Team Server of the GCM application, set up a directional friend relationship to each contributing ELM application (RM, QM, and CCM) present on the other Jazz Team Server instance.

    Add the applications that GCM needs as friends. On the Server Administration page, on the Server tab, in the Communication section, under Friends (Outbound), add a friend relationship to each ELM application.

    Ensure that you accept each incoming friend relationship in either of the following ways:

    1. At the time of the friend creation.

      If you are an administrator of the target friend server, you can authorize the provisional key immediately after its creation. To authorize the friend relationship, on the Add friend wizard, after you create a friend, click Next > Grant access for the provisional key.

      In the same step, set a functional user for the authorized friends. The functional user does not require any privileges and can be any user on that Jazz Team Server instance. For convenience, you can use the pre-defined application users (such as ccm_user, qm_user, rm_user, dm_user, and gc_user) for the respective ELM application.

      For details, see Establishing friend relationships.

    2. After the friend creation, from within the respective ELM application.
      • For the RM application: Authorize the friend relationship on the OAuth Consumers page of the Jazz Team Server of the RM application, not on the RM Administration page. On the toolbar, click Administration > Jazz Team Server Home > Manage Server > Consumers (Inbound).
      • For other applications (CCM and QM): Authorize the friend relationship on that application's administration page: Application Administration page > Consumers (Inbound) > OAuth Consumers page.

      For details, see Configuring friends.

      On the OAuth Consumers pages, set a functional user for each authorized friend (one for each ELM application).

      For details, see Editing consumer keys.

    Use the same steps in 1 to set up a directional friend relationship from the Jazz Team Server of the contributing ELM applications (RM, QM, and CCM) to GCM and each contributing ELM application present on the other Jazz Team Server instance.

  2. Set the Global Configuration Provider URL property for each Jazz Team Server in the topology, except the one that GCM is registered to so that contributing applications use the correct GCM instance.

    This property is on the Jazz Team Server server properties page, in the Global Configuration SDK set of server properties. The URL must have a fully qualified domain, for example, https://example:9443/gc/.

    For details, see Configuring advanced properties.

  3. Specify the link index (LDX) provider URL on the Jazz Team Server properties page for each Jazz Team Server in the topology, except the one that LDX is registered to.

    Edit the Link Index Provider URL property in the Links Component set of server properties. The value must be a URL with a fully qualified domain, for example, https://example:9443/ldx/.

    For details, see Configuring advanced properties.

  4. Activate configuration management as described in Setting up ELM applications to use local configurations.

The setup is complete.