Prerequisites

Fetching the service ID and API key

Navigate to the Service ID that you created for GitHub integration in your Kyndryl Modern Operations Applications tenant. It can be located on the
IAM:Identity and Access Management
page. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
Copy the Service ID from the URL of the Kyndryl Modern Operations Applications tenant. The ID is the alphanumeric string immediately after
/service-ids/
and before
/view/
.
The service ID needs to have an access policy that at least provides the Platform - Editor and Enterprise Marketplace access - Order Administrator roles. For more information, see IAM overview.
To generate the API Key, click
Manage
→
Add API Key
.
Record the generated API Key and store it in a secure location. It will not be displayed again.

Installing the Generic Proxy Adapter

Navigate to the Developer Console. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
In the
Application
field, select
EMP
.
In the
Service
field, select
consume_common_api
.
Scroll down to the
Proxy Installer
section.
Run the
POST /common/v1/proxy/installer
API with the following parameters to download the compressed file:
Accept:
"application/zip"
Parameter content type:
"application/json"
Payload:
{}
In the
Responses
section, click
Download file
.
Save the compressed file in a convenient location on the computer or virtual machine where the proxy container will be run and extract it.
Open the
configs.env
file and change the following parameters to match your tenant:
export IAM_SERVICE_ID=<IAM service ID>
export IAM_SERVICE_API_KEY= <IAM service API key>
Copy the PROXY_ID from the
configs.env
file.

Running the proxy container

Run the
installer.sh
file to create a secure network extension (proxy) Docker image:
./installer.s
h.
Run the
run_container.sh
file to create the secure network extension (proxy) container:
./run_container
.
Run the
check_logs.sh
file to check the logs of secure network extension container to ensure that the container is deployed and is communicating with Enterprise Marketplace:
./check_logs.sh
.
The container is running and should be connected to EMP
wsmesh
.

 {
existing_proxyId = "{existing proxy ID}"
}

 

Create a connection to GitHub

Navigate to
the IAM: Identify and Access Management
page. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
In the navigation pane, click
Connections
.
Click Add New → Add Connection.
Enter the following parameters and then click
Add
:
Connection Name:
Enter a descriptive name for the connection.
Select tags:
(optional) Add tags if desired to help categorize the connection.
Description:
(optional) Enter a more detailed explanation of the connection.
Select Technology Category:
Select
Content Provider
.
Select Connection Type:
Select
GitHub
.
User ID:
Email address of the user that is used to log in to GitHub.
Host URL:
API gateway URL of the GitHub repository. In the example repository
https://github.kyndryl.net/MCMP-Marketplace/gcs-content-template
, the Host URL would be
api.github.kyndryl.net
.
ProxyID:
This is the ID that you copied from the
config.env
file that you used to create the proxy container.
Despite this field being labeled as optional, it is in fact required
.
Repository URL:
API gateway URL of the GitHub repository. In
https://github.kyndryl.net/MCMP-Marketplace/gcs-content-template
, the Repository URL is
api.github.kyndryl.net
.
User:
Owner/Organization of the repository. In
https://github.kyndryl.net/MCMP-Marketplace/gcs-content-template
, the User is
MCMP-Marketplace
.
Personal Access Token:
User specific GitHub Token. For information about generating this token, see https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens.
Project:
Name of the repository. In
https://github.kyndryl.net/MCMP-Marketplace/gcs-content-template
, the Project is
gcs-content-template
.
Branch:
Select the branch of the repository that you want to use. Generally this will be
master
.

Creating an adapter registration for GitHub provider

Navigate to the Developer Console. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
Enter these parameters:
Application:
EMP
Service:
consume_common_api
Scroll down to the
Client Management API
section.
Run the POST /emp/common/clients API to create a new subscriber with the following payload:

{
    "name":"order_fulfillment_github",
    "provider_code":"github",
    "applicable_for":[
        {
            "id":"integration",
            "values":[
                "OrderFulfillment"
            ],
            "workflowId":"",
            "eventType":""
        }
    ],
    "callback":{
        "url":"github.kyndryl.net/api/v3/repos/MCMP-Marketplace/gcs-content-template",
        "certs":{
            "endpoint_ca_cer":"",
            "endpoint_cer":"",
            "endpoint_key":""
        },
        "headers":{
            
        },
        "connection_protocol":"https"
    }
 

provider_code:

github.

values:

OrderFulfillment.

eventType:

Required if user wants to trigger repository dispatch on GitHub Action. The following payload will be received by GitHub for repository dispatch:

{
    "event_type": "value of eventType",
    "client_payload": {
        "empOrderPayload": order details in json format
    }
}
 

workflowId:

The ID of the workflow. You can also pass the workflow file name as a string. Required if user wants to trigger workflow dispatch on GitHub Action. The following payload will be received by GitHub for workflow dispatch:

{
    "ref": "GitHub branchname",
    "inputs": {
        "empOrderPayload": order details in stringify json format
    }
 

Creating a GitHub provider in Enterprise Marketplace

Navigate to the Developer Console. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.

Enter these parameters:

Application:
EMP
Service:
catalog_api

In the Catalogs section, locate and run the POST /catalog/v3/providers_adapters API with the following payload:

{
    "providers_adapters": [
        {
            "provider": "GitHub",
            "providerCode": "github",
            "adapter": "http://localhost:5000/genericcontentserver/v1/providers/github",
            "discoverContent": true,
            "providerOfferingTypes": [
                "iaas"
            ],
            "manageSOEnabled": true,
            "enableVersion": false
        }
    ]
}
 

The container is automatically connected to Enterprise Marketplace using

wsmesh

: <BASE_HOST_URL >/api/wsmesh/v3/proxy/<proxy_id>?timeout=600 with the header {"Authorization": "Bearer <wsmesh token>"} with the following request body. No intervention is needed.

{
    "body": {
      "request_id": random_uuid,
      "request_resource": encoded base64 provisioning request data
     },
     "type": "proxy"
}
 

{
  "url": "url",
  "method": "method",
  "headers": {},
  "body": {},
  "tags": {
    "orderNumber": "",
    "serviceFulfillmentId":"",
    "requestTrackingId": ""
  },
  "failureCallback": {
    "url": "url",
    "method": "method",
    "headers": {},    
    "body": {}
  }
}
 

Enabling MTLS

Edit the Dockerfile and uncomment these lines that refer to the volume mount to the docker container:

#ENV VOLUME_PATH /certs
#VOLUME ${VOLUME_PATH}

Open the

configs.env

file and update the

export CERTS_FOLDER="”

variable with the values of the folder path containing the certificates and names of the files containing the certificates, for example

export CERTS_FOLDER=”/tmp/certs”

. The folder path of your host machine where the certificates are stored will be mounted as a volume to the proxy adapter container.

Add the file names of the client key, client cert and ca cert in the following variables. The Proxy container will create the socket connection with the certificates provided.

        export CA_CERT_FILE_NAME="" 
        export CLIENT_KEY_FILE_NAME="" 
        export CLIENT_CERT_FILE_NAME=""