Content Comparison

...

elm-sync configuration is done in the Spring Boot application.yml file. The configuration associates one CDCM space with one or more ELM GCM serverservers, and lists the CDCM Configuration Areas that should be synchronized with ELM GCM. Configuration includes the following topics:

• The elm-sync server configurationThe

• spring application configuration including

  • security for oauth2 for CDCM access

  • SQLite database configuration for elm-sync

• cdcm sever and API

• ibm-elm server and API information

• spring security for oauth2 for CDCM access

• OAuth1.0a configuration for access to ELM GCM

• The cdcm Configuration Area to ELM GCM server mappings

...

elm-sync uses the configuration information in the application.yml file to configure the CDCM and ELM GCM server URLs, access control and API information, and the list of CDCM Configuration Areas to sync. elm-sync then uses the CDCM TRS provider to read the change long log to replicate changes in CDCM in the corresponding project areas and resources in ELM GCM. elm-sync does not use the CDCM TRS base to determine what configuration areas to sync. Rather these the CDCM Configuration Areas to sync are explicitly defined in the configuration.area.mapping elements.

elm-sync also does not currently use the trs:cutoffEvent, assuming as it is always 0. This effectively means elm-sync assumes the TRS base is empty and all the TRS provider information is in the change log. This may need to be updated if when CDCM implements change log pruning.

...

The application.yml defines various information elm-sync uses to determine what CDCM configuration areas should be synced to ELM GCM and how to access them through their authenticated APIs. Here’s an example application.yml file.

springelm-sync:  # security:configuration for the elm-sync server
oauth2:  instance:
    clientname: ELM-SYNC-1
       registrationmax-number-of-retries: 100
  retry-backoff: 100
  max-number-of-unique-title-retries: 100

customserver:
#'custom' here canport: be8080
anything  servlet:
    context-path: "/sandbox"

spring:
  client-idsecurity:
${CLIENT_ID:genoslc-development} #genoslc-development   oauth2:
         client-secret: ${CLIENT_SECRET:z0AMmptqxxuQBBiZc7FMJVAisvGmMadD}
            redirect-uri: http://localhost:${server.port}/${server.servlet.context-path}/login/oauth2/code/customregistration:
            scopecdcm-client:
${CLIENT_SCOPE:openid}             authorization-grant-type: authorization_codeclient-id: cdcm-client-id
            providerclient-secret: secret
         custom: #'custom' here can be anythingscope: service-user-roles
             issuer-uri: https://keycloak.mid.de/realms/Smartfacts-Developmentauthorization-grant-type: client_credentials
        provider:
     user-name-attribute: ${USER_NAME_ATTRIBUTE:preferred_username}     cdcm-client:
             user-info-authentication-method: ${USER_INFO_AUTHENTICATION_METHOD:form} # header, form, queryissuer-uri: https://keycloak/realms/cdcm
            resourceserveruser-name-attribute: preferred_username
       jwtresourceserver:
        jwt:
          issuer-uri: https://keycloak.mid.de/realms/Smartfacts-Developmentcdcm
  datasource:
elm-sync:  # configuration for the elm-sync server
  instance:
url: "jdbc:sqlite:/opt/elmsync/data/elmsync.db"
    driver-class-name: org.sqlite.JDBC
   name username: ELM-SYNC-1sa
  configuration:  password: sa
 cdcm-configuration-url: http://localhost:8080/api/v1/objectMappings jpa:
    cdcmdatabase-urlplatform: https://www.example.com/
  max-number-of-retries: 6
  retry-backoff: 2
  max-number-of-unique-title-retries: 50

server:
  port: ${PORT:8080}
  servlet:
    context-path: "/sandbox"org.hibernate.community.dialect.SQLiteDialect
    hibernate:
      ddl-auto: update
    show-sql: false

cdcm:  # the CDCM server instance and Space to use, one instance per elm-sync server
  api:
    host: https://cdcm.demo.smartfacts.com
    space-key: CDCM-IPKvRuZYUps1space_key

ibm-elm:  # the IBM ELM server instance to use, corresponds to a CDCM Space
  api:
    host: https://elmdemoelm.smartfacts.com:9443
    pa-creation-path: /gc/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/projectArea
    pa-get-path: /gc/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/allProjectAreas
    config-update-path: /gc/gc.webui.updateConfiguration

datasourcesmartfacts:
  oauth10a:
  url: jdbc:sqlite:/Users/jamsden/data/sqlite/elmsync.db
    driver-class-name: org.sqlite.JDBC active: true
    usernameoutbound:
 sa     passworddetails:
sa   jpa:     database-platform name: org.hibernate.community.dialect.SQLiteDialectelm.com
    hibernate:       ddl-auto: update
    show-sql: true

smartfacts:
  oauth10a:protected-url-roots: https://elm.com:9443/jts/**,https://elm.com:9443/rm/**,https://elm.com:9443/gc/**
          activeconsumer-key: truekey
    outbound:elm       details:consumer-secret: secret
         - namerootservices: elmdemo.smartfacts.com
          protected-url-roots: https://elmdemo.smartfactselm.com:9443/jts/**,https://elmdemo.smartfacts.com:9443/rm/**,https://elmdemo.smartfacts.com:9443/gc/**rootservices

    inbound:
      consumerrealm-keyname: jamsden_authsandbox-realm
      auto-approve-consumer-keys: true
  consumer-secret: Chajas3mat#   auto-approve-tokens: true
      rootservices: https://elmdemo.smartfacts.com:9443/jts/rootservicesdetails:
        - name: ibm-elm-qminbound
          protectedconsumer-url-roots: https://elmdemo.smartfacts.com:9443/qm
     key: key
          consumer-secret: secret

configuration:
  area:
    consumer-keymapping:
consumer-key      -
      consumer-secret: secret source: cdcm_area_id
        rootservicestarget: https://elmdemoelm.smartfacts.com:9443/qm/rootservices
      -
 inbound:       realm-namesource: sandbox-realmcdcm_area_id
       auto-approve-consumer-keys: true target: https://elm.com:9443
      auto-approve-tokens:
 true       detailssource: cdcm_area_id
       - nametarget: mid-elm-inbound
          consumer-key: bc2a6767-af53-417a-a97c-c9487804d5df
          consumer-secret: secret

configuration:
  area:
    mapping:
      -
        source: 664f38242aac9257b5b0c79c
        target: https://elmdemo.smartfacts.com:9443
      -
        source: 664f383b2aac9257b5b0c7a0
        target: https://elmdemo.smartfacts.com:9443
      -
        source: 664c7d15f7eb227a1021a7ce
        target: https://elmdemo.smartfacts.com:9443

elm-sync server configuration

This section defines the elm-server configuration including the server port and context-path for accessing the elm-sync controllers, and server instance information.

 elm-sync:  # configuration for the elm-sync server
  instance:
    name: ELM-SYNC-1
  configuration:
    cdcm-configuration-url: http://localhost:8080/api/v1/objectMappings
    cdcm-url: https://www.example.com/
  max-number-of-retries: 6
  retry-backoff: 2
  max-number-of-unique-title-retries: 50

server:
  port: ${PORT:8080}
  servlet:
    context-path: "/sandbox"

elm-syn SQLite database configuration

elm-sync uses SQLite for persisting information about the CDCM configuration areas and ELM GCM project areas that are being synchronized. The information includes:

• The Configuration Area id

• The ELM Server URL and corresponding project area URL

• The trs:order number of the last trs:change event processed by elm-sync. Changes after this event will be processed on the next elm-sync scan cycle.

  datasource:  # tge /SQLite data source used by elm-sync
    url: jdbc:sqlite:/data/sqlite/elmsync.db
    driver-class-name: org.sqlite.JDBC
    username: sa
    password: sa
  jpa:
    database-platform: org.hibernate.community.dialect.SQLiteDialect
    hibernate:
      ddl-auto: update
    show-sql: true

CDCM Server and API

This section defines the CDCM server and space that is the source of configuration areas that will be synced to ELM GCM project areas.

cdcm:  # the CDCM server instance and Space to use, one instance per elm-sync server
  api:
    host: https://cdcm.demo.smartfacts.com
    space-key: CDCM-IPKvRuZYUps1

IBM ELM server and API information

This section specifies the IBM ELM GCM server that will be synchronized with the CDCM space.

ibm-elm:  # the IBM ELM server instance to use, corresponds to a CDCM Spacehttps://elm.com:9443

elm-sync server configuration

This section defines the elm-server configuration including the server port and context-path for accessing the elm-sync controllers, and server instance information. Note: the elm-sync controllers are only used for development and unit testing, there are no elm-sync REST services intended for customer use.

elm-sync:  # configuration for the elm-sync server
  instance:
    name: ELM-SYNC-1
  max-number-of-retries: 6
  retry-backoff: 2
  max-number-of-unique-title-retries: 50

server:
  port: 8080
  servlet:
    context-path: "/sandbox"

elm-syn Spring Boot Application Configuration

The elm-sync Spring Boot application configuration specifies information about:

1. CDCM OAuth2.0 security information

2. An SQLite database for persisting information about the CDCM configuration areas and ELM GCM project areas that are being synchronized.

Access to CDCM uses AOuth 2 which is configured for the Spring Boot application using the cdcm-client. Your CDCM administrator can provide your client-id and client-secret, and information on the provider.cdcm-client that does the authentication.

The database information includes:

• The Configuration Area id

• The ELM Server URL and corresponding project area URL

• The trs:order number of the last trs:change event processed by elm-sync. Changes after this event will be processed on the next elm-sync scan cycle.

spring:
  security:
    oauth2:
      client:
        registration:
          cdcm-client:
            client-id: cdcm-client-id
            client-secret: secret
            scope: service-user-roles
            authorization-grant-type: client_credentials
        provider:
          cdcm-client:
            issuer-uri: https://keycloak/realms/cdcm
            user-name-attribute: preferred_username
      resourceserver:
        jwt:
          issuer-uri: https://keycloak/realms/cdcm
  datasource:
    url: "jdbc:sqlite:/opt/elmsync/data/elmsync.db"
    driver-class-name: org.sqlite.JDBC
    username: sa
    password: sa
  jpa:
    database-platform: org.hibernate.community.dialect.SQLiteDialect
    hibernate:
      ddl-auto: update
    show-sql: false

CDCM Server and API

This section defines the CDCM server and space that is the source of configuration areas that will be synced to ELM GCM project areas.

cdcm:  # the CDCM server instance and Space to use, one instance per elm-sync server
  api:
    host: https://elmdemocdcm.smartfacts.com:9443
    paspace-creation-path: /gc/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/projectArea
    pa-get-path: /gc/service/com.key: space_key

IBM ELM server and API information

This section specifies the IBM ELM GCM server that will be synchronized with the CDCM space.

ibm-elm:  # the IBM ELM server instance to use, corresponds to a CDCM Space
  api:
    host: https://elm.com
    pa-creation-path: /gc/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/allProjectAreasprojectArea
    configpa-updateget-path: /gc/gc.webui.updateConfiguration

...

service/com.ibm.team.process.internal.service.web.IProcessWebUIService/allProjectAreas
    config-update-path: /gc/gc.webui.updateConfiguration

Future considerations:

1. The pa-creation-path, pa-get-path and config-update-path are specified in ELM GCM private API. These paths are unlikely to change or could possibly be discovered and may not need to be configured manually. See https://jazz.net/gc/doc/scenarios.

CDCM Security Configuration

Access to CDCM uses AOuth 2 which is configured for the Spring Boot application

...

1. The ibm-elm.api.host property limits elm-sync to syncing a single CDCM space to a single ELM GCM server. This will be updated to support multiple ELM GCM servers and this property will be removed, instead getting the value from the configuration.area.mapping.target value.

ELM GCM OAuth1.0a Security Configuration

elm-sync uses OAuth1.0a to access ELM GCM through the REST APIs. This access is done through a functional user whose ID is associated with a consumer key and secret.

smartfacts:
  oauth10a:
    active: true
    outbound:
      details:
   custom: #'custom' here can be anything- name: elm.com
          clientprotected-url-idroots: ${CLIENT_ID:genoslc-development} #genoslc-developmenthttps://elm.com:9443/jts/**,https://elm.com:9443/rm/**,https://elm.com:9443/gc/**
          consumer-key: key
 client-secret: ${CLIENT_SECRET:z0AMmptqxxuQBBiZc7FMJVAisvGmMadD}        consumer-secret: secret
   redirect-uri       rootservices: httphttps://localhost:${server.port}/${server.servlet.context-path}/login/oauth2/code/customelm.com:9443/jts/rootservices

    inbound:
      scope: ${CLIENT_SCOPE:openid}realm-name: sandbox-realm
      auto-approve-consumer-keys: true
      authorizationauto-grantapprove-typetokens: authorization_codetrue
        providerdetails:
        -  customname: #'custom' here can be anythingelm-inbound
                issuer-uri: https://keycloak.mid.de/realms/Smartfacts-Developmentconsumer-key: key
            user-name-attribute: ${USER_NAME_ATTRIBUTE:preferred_username}
            user-info-authentication-method: ${USER_INFO_AUTHENTICATION_METHOD:form} # header, form, query
      resourceserver:
        jwt:
          issuer-uri: https://keycloak.mid.de/realms/Smartfacts-Development

ELM GCM OAuth1.0a Security Configuration

elm-sync uses OAuth1.0a to access ELM GCM through the REST APIs. This access is done through a functional user whose ID is associated with a consumer key and secret.

smartfacts:
  oauth10a:
    active: true
    outbound:elm
      details:
        - name: elmdemo.smartfacts.com
          protected-url-roots: https://elmdemo.smartfacts.com:9443/jts/**,https://elmdemo.smartfacts.com:9443/rm/**,https://elmdemo.smartfacts.com:9443/gc/**
          consumer-key: jamsden_auth
          consumer-secret: some_passwordconsumer-secret: secret

The outbound.details provide the information elm-sync need to be able to access ELM GCM services using OAuth1.0a for authentication.

The smartfacts.oauth10a.inbound.relm-name is required, but not currentluy used. It is included for future use.

Creating the ELM GCM functional id

elm-sync access the ELM GCM REST APIs using OAuth1.0a and a functional id. The is the most reliable way to do server to server communication with ELM servers because they all use OAuth1.0a to configure consumer/friend relationships to allow the ELM servers to talk to each other. OAuth1.0a can be reliably depended on to be supported by ELM servers.

For elm-sync to access ELM GCM, you must register elm-sync with the ELM Jazz Team Server (JTS) as a consumer (inbound) connection, with consumer key and secret. Then you need to associate that consumer with a functional id that has JazzAdmins, JazzUsers and JazzProjectAdmins repository permissions. Here a brief summary of the steps

1. Navigate to the Jazz Team Server Administration Home page

2. Manage or create users and create the functional id with JazzAdmins, JazzUsers and JazzProjectAdmins repository permissions

   Image Added

3. Click Manage Server and then Communication > Consumers (Inbound)

4. Use the Register Consumer form to create a Trusted Consumer Key with a Consumer Secret. This is the same information that will be used in the smartfacts.oauth10a.outbound.details entry in the application.yml file.

5. Edit the newly created Authorized Key and set the Functional User ID to the Id you create above:

   Image Added

CDCM Configuration Area to ELM GCM Server Mappings

This section maps the CDCM configuration area to the ELM GCM server used to create the corresponding project area.

configuration:
  area:
    mapping:
      -
        source: cdcm_area_id
          rootservicestarget: https://elmdemoelm.smartfacts.com:9443/jts/rootservices
      -
     - name: ibm-elm-qm source: cdcm_area_id
        protected-url-rootstarget: https://elmdemoelm.smartfacts.com:9443/qm
          consumer-key: consumer-key
          consumer-secret: secretsource: cdcm_area_id
           rootservicestarget: https://elmdemo.smartfacts.com:9443/qm/rootservices

    inbound:
      realm-name: sandbox-realm
      auto-approve-consumer-keys: true
      auto-approve-tokens: true
      details:
        - name: mid-elm-inbound
          consumer-key: bc2a6767-af53-417a-a97c-c9487804d5df
          consumer-secret: secret

The outbound.details provide the information elm-sync need to be able to access ELM GCM services using OAuth1.0a for authentication.

The inbound.relm-name is used for the elm-sync REST API services defined in the com.mid.smartfacts.cdcm.elmc.controllers classes:

• ElmApplicationController: provides rootservices, service provider catalog and about information for elm-sync

• TestConfigurationAreaReaderController: implements various fixed test cases for accessing CDCM Configuration Areas

• TestController: implements various test cases for accessing CDCM and ELM GCM resources, useful for developing automate test cases and for exploring implementation options and issues

Creating the ELM GCM functional id

elm-sync access the ELM GCM REST APIs using OAuth1.0a and a functional id. The is the most reliable way to do server to server communication with ELM servers because they all use OAuth1.0a to configure consumer/friend relationships to allow the ELM servers to talk to each other. OAuth1.0a can be reliably depended on to be supported by ELM servers.

For elm-sync to access ELM GCM, you must register elm-sync with the ELM Jazz Team Server (JTS) as a consumer (inbound) connection, with consumer key and secret. Then you need to associate that consumer with a functional id that has JazzAdmins, JazzUsers and JazzProjectAdmins repository permissions. Here a brief summary of the steps

1. Navigate to the Jazz Team Server Administration Home page

2. Manage or create users and create the functional id with JazzAdmins, JazzUsers and JazzProjectAdmins repository permissions

   Image Removed

3. Click Manage Server and then Communication > Consumers (Inbound)

4. Use the Register Consumer form to create a Trusted Consumer Key with a Consumer Secret. This is the same information that will be used in the smartfacts.oauth10a.outbound.details entry in the application.yml file.

5. Edit the newly created Authorized Key and set the Functional User ID to the Id you create above:

   Image Removed

CDCM Configuration Area to ELM GCM Server Mappings

This section maps the CDCM configuration area to the ELM GCM server used to create the corresponding project area.

configuration:
  area:
    mapping:
      -
        source: 664f38242aac9257b5b0c79c
        target: https://elmdemo.smartfacts.com:9443
      -
        source: 664f383b2aac9257b5b0c7a0
        target: https://elmdemo.smartfacts.com:9443
      -
        source: 664c7d15f7eb227a1021a7ce
        target: https://elmdemo.smartfacts.com:9443

Note: Although a configuration.area.mapping.target specifies the URL of the ELM GCM server, this URL must be the same as ibm-elm.api.host. elm-sync is currently configured to sync one CDCM server with one ELM GCM server. A different instance of elm-sync could be used to sync different CDCM and ELM GCM servers.

Future consideration: Support configuration of multiple CDCM and ELM GCM servers in a single elm-sync implementation:

1. Change configuration.area.mapping.source to a URL link to the CDCM configuration area, instead of just its ID

2. Derive the ibm-elm.api information for the configuration.area.mapping.target URL through discovery

Configuration

elm-sync is configured using the Spring Boot project file application.yml. This file has to be put in the application’s resources folder. Spring Boot profiles can be used for different configurations such as application-local.ymlfor local development, and application-prod.yml for production.

Kubernetes

The application.yml contains security sensitive information such as consumer keys and secrets, and should be placed into a kubernetes secret, and mounted into the CDCM container. The name of this secret is "elm-sync", the value of is the application.yml file.

To integrate the application.yml file into your CDCM deployment, you need to create a secret called “elm-sync” in the namespace of your CDCM deployment.

There are two ways to do this:

1. Use kubectl

kubectl create secret generic elm-sync --from-file=application.yml=./resources/application.yml -n cdcm

2. If the secret has to be created manually or from a vault, use this template:

apiVersion: v1
data:
  application.yml: <base64 encoded content of the file application.yml>
kind: Secret
metadata:
  name: elm-sync
  namespace: cdcm
type: Opaque

Save the file as application.yml and apply it with:

kubectl apply -f application.yml -n <namespace>

Reference

The following tables define each of the leave properties in the elm-sync configuration. See the example above for the property paths.

elm-sync Server Configuration: elm-sync, server

...

Key

...

Description

...

elm-sync.instance.name

...

A name for this elm-sync server instance

...

elm-sync.configuration.cdcm_configuration-url

...

The URL to access the current CDCM to ELM Sync mapping information, the data from the SQLite object_mapping table.

...

elm-sync.configuration.cdcm-url

...

elm-sync.max-number-of-retries

...

Maximum number of retries for REST calls.

...

elm-sync.retry-backoff

...

Number of seconds between retries.

...

elm-sync.max-numer-of-unique-title-retries

...

Maximum number of retries for unique dcterms.title for an ELM GCM resource.

...

server.port

...

The port for the elm-sync server

...

server.servlet.context-path

...

/sandbox, the path for the elm-sync controllers e.g., http://localhost:8080/sandbox/api/v1/objectMappings

elm-sync Persistance: datasource

CDCM Server: cdcm

Specifies the CDCM server and space key to synchronize with ELM GCM:

CDCM Security: spring.security.oauth2

Specifies the CDCM OAuth 2 security information.

IBM ELM Server: ibm-elm

Specifies the IBM ELM GCM server that will be synchronized with the CDCM Space.

...

Key

...

Description

...

ibm-elm.api.host

...

URL of the ELM GCM server to synchronize with

...

ibm-elm.api.pa-creation-path

...

Path of the ELM GCM service to create a project area.

...

ibm-elm.api.pa-get-path

...

Path of the ELM GCM service to update a configuration.

...

ibm-elm.api.config-update-path

...

A name for the connection

...

protected-url-roots

...

A comma separated list of URI patters to resources protected by this connection configuration

...

consumer-key

...

The consumer key for the consumer connection

...

consumer-secret

...

The consumer secret for the consumer-key

...

rootservices

...

The URL of the root services resource for the ELM application used to establish the consumer inbound connection, usually the roots services URL for the Jazz Team Server for those ELM applications that authentication using JTS.

...

inbound

...

Specifies the OAuth1.0a information for incoming REST calls to elm-sync

...

inbound.relm-name

...

The relm name for this elm-sync application instance

...

inbound.auto-approve-consumer-keys

...

Whether elm-sync automatically approves consumer keys

...

inbound.auto-approve-token

...

Whether elm-sync automatically approves tokens

...

inbound.details.name

...

A name for the inbound consumer connection

...

inbound.details.consumer-key

...

Consumer key for the inbound connection

...

inbound.details.consumer-secret

...

elm.com:9443

Note: Although a configuration.area.mapping.target specifies the URL of the ELM GCM server, this URL must currently be the same as ibm-elm.api.host. elm-sync is currently configured to sync one CDCM server with one ELM GCM server. A different instance of elm-sync could be used to sync different CDCM and ELM GCM servers.

Future consideration: Support configuration of multiple CDCM and ELM GCM servers in a single elm-sync implementation:

1. Change configuration.area.mapping.source to a URL link to the CDCM configuration area, instead of just its ID

2. Derive the ibm-elm.api information for the configuration.area.mapping.target URL

Configuration

elm-sync is configured using the Spring Boot project file application.yml. The location of this files specified in the docker-compose.yaml file. Spring Boot profiles can be used for different configurations such as application-local.ymlfor local development, and application-prod.yml for production.

Kubernetes

The application.yml contains security sensitive information such as consumer keys and secrets, and should be placed into a kubernetes secret, and mounted into the elm-sync container. The name of this secret is "elm-sync", the value of is the application.yml file.

To integrate the application.yml file into your elm-syn deployment, you need to create a secret called “elm-sync” in the namespace of your elm-sync deployment.

There are two ways to do this:

1. Use kubectl

kubectl create secret generic elm-sync --from-file=application.yml=./resources/application.yml -n cdcm

2. If the secret has to be created manually or from a vault, use this template:

apiVersion: v1
data:
  application.yml: <base64 encoded content of the file application.yml>
kind: Secret
metadata:
  name: elm-sync
  namespace: cdcm
type: Opaque

Save the file as application.yml and apply it with:

kubectl apply -f application.yml -n <namespace>

Reference

The following tables define each of the properties in the elm-sync configuration that users will need to provide. See the example above for the property paths.

elm-sync Server Configuration: elm-sync, server

elm-sync Persistance: datasource

CDCM Server: cdcm

Specifies the CDCM server and space key to synchronize with ELM GCM:

CDCM Security: spring.security.oauth2

Specifies the CDCM OAuth 2 security information.

IBM ELM Server: ibm-elm

Specifies the IBM ELM GCM server that will be synchronized with the CDCM Space.

Future consideration: these API paths are defined by the GCM REST API at https://jazz.net/gc/doc/scenarios and https://jazz.net/jts/doc/scenarios and may not be need to be configured manually.

...

CDCM Configuration Area Mappings: configuration.area.mapping

...