Creating a GitHub repository

Create a
Private
repository in GitHub. Public repositories are not supported.
Make a note of the initial branch name. This is generally
main
.
In the
main
branch, create a folder called
mastercontent
.
Locate any templates that you want to import in the Terraform Registry. Create the templates for the catalogs that you want to add to the Catalog and save them in the
mastercontent
folder in the
main
branch of the repository. Commit your changes in GitHub as needed. You can create subfolders within
mastercontent
to keep your files organized. The templates must be in the Terraform format.

Structuring your repository

Terraform templates:
If you are including more than one file, all of the files must be grouped together in a single directory.
Native templates:
How these are structured depends on how the content server handles the flow. Consult the user documentation for the individual provider.

The master folder includes one

mcmp.yaml

file and a catalog folder that consists of a

main.tf

file.

Master-folder
------mcmp.yaml
------service-offering1
------------main.tf

The master folder consists of a catalog folder that consists of a

mcmp.yaml

file and a

main.tf

file.

Master-folder
------service-offering2
------------main.tf
------------mcmp.yaml

The master folder consists of a

mcmp.yaml

file and a folder that contains all the files for the catalog. This structure is used for Terraform templates.

Master-folder
------service-offering3
------------mcmp.yaml
------------complex_template
------------------main.tf
------------------variables.tf
------------------outputs.tf

The following example illustrates how

mcmp.yaml

precedence works in a complex repository.

Master-folder
----mcmp.yaml (GLOBAL mcmp.yaml configuration, any serviceoffering without a mcmp.yaml will use this)
----service1/ (Master-folder/mcmp.yamlwill be used)
--------main.tf
----service2/ (Master-folder/service2/mcmp.yaml will be used)
--------main.tf
--------mcmp.yaml
----service3/ (Master-folder/service3/mcmp.yaml will be used)
--------mcmp.yaml
--------complex_template/
------------main.tf
------------output.tf

Creating a personal access key

Navigate to GitHub.
Click the
Profile
icon on the right side and click
Settings
.
Click the
Developer settings
tab.
Click the
Personal access tokens
tab.
Click
Generate a new token
.
Provide a name for your token by completing the
Note
field.
Select the
Repo
check box.
Click
Generate token
.

Creating an organization in Kyndryl Modern Operations Applications

Creating a team in Kyndryl Modern Operations Applications

Business requesters (such as delivery teams), who need to request GitHub deployments, should not be added to any team that has
Financial Approver
or
Technical Approver
permissions, or to any team that can modify Enterprise Marketplace approval policies.
Buyer
permissions are sufficient for business requester teams.
Engineering users, who require administrative access as well as the ability to place orders, can be made part of both approver and buyer teams as required for their roles in the organization.
Users who are only required to raise requests for Engineering deployment without administrative access should not be added to teams that have permissions other than the
Buyer
permissions.

Engineering (Engineering Team)

Buyers (Business Requesters, Engineering Deployment Team)

Configuring a provider account

Log in to Kyndryl Modern Operations Applications.
Navigate to the
Provider Account
page. To learn more about navigating to the different services from each tenant, refer to Landing page navigation or Kyndryl Bridge Landing page navigation.
The page displays a list of the accounts created. Click the
Asset Accounts
tab and then click
New Asset Account
.
On the
New Asset Account
page, select
GitOps
.
Enter a
Name
and an optional
Description
for your account.
In the
Endpoint URL
field, enter your GitHub’s repository username URL, such as
https://[your enterprise domain]/api/v3/repos/[username]
.
Keep the
Status
as
Active
.
Click
Create Account
.

Adding credentials

In the provider account, click
Add Credential
.
Enter a
Name
and an optional
Description
for your credential.
In the
Purpose
menu, select
Provisioning
and
Catalog Ingestion
.
In the
Project
field, enter the name of the repository that you created previously. See Creating a GitHub repository.
You have two options when creating credentials for your repositories. The first option is to create separate credentials for each of the repositories. The second option is to create a single credential for both repositories. If this is the case, simply enter both repository names in the
Project
field separated by a comma.
In the
Team
field, enter the ID of a team with System Admin privileges, as created in Creating a team in Kyndryl Modern Operations Applications.
The
Branch name
field should be
main
unless you changed the name of the initial branch.
Keep the
Status
as
Active
.
Select the
Create New or Update Credential in Vault
checkbox to enable the
Token
field.
In the
Token
field, enter the personal access key that you created in Creating a personal access key.
In the
Associate this credential with a business entity
section, select the
Associate
checkbox, select
Organization
from the
Business Entities
menu, and select the organization name that you created earlier from the
Values
menu.
Click
Add
.

Adding a webhook

Log in to Kyndryl Modern Operations Applications.
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
consume
.
In the
Service
field, select
GitOps_API
.
Click
List Webhook Listener
.
Click
Try it out
.
Click
Execute
.
In the output, locate and copy the code for the provider that you are interested in. Copy the URL for the webhook and the mcmpwebhooktoken onto a notepad.
You can also provide the providerCode during execution. To locate the code, navigate to the
Terraform Provider Management
page. Copy the code from the tile for that provider.
Open your GitHub repository.
Click
Settings
.
Click
Hooks
in the left navigation pane.
Click
Add webhook
.
Paste the webhook URL that you got using the API into the
Payload URL
field.
In
Content type
, select
application/json
.
In
Secret
, paste the mcmpwebhooktoken that you got using the API.
Leave
SSL verification
as
Enable SSL verification
.
Leave
Just the push event
selected.
Leave the webhook as
Active
.
Click
Add webhook
.

Running the GitHub mcmp.yaml file

git add mastercontent.<subfolder>/mcmp.yaml
git commit -m "mcmp.yamlfile added"
git push origin main