Internal Use Only
YAML generator
YAML files are crucial in defining and managing software components, services, and catalog items. However, the manual creation of each file, especially given the number of YAML files required to configure the tools and plugins, can be time-consuming and challenging. Automating the creation of YAML files in KDE can significantly reduce developers' time on these repetitive tasks, freeing them to focus on more engaging activities like coding and feature development. This shift in focus leads to a more efficient use of time and resources, making the development process more streamlined and productive.
Administrators can use the YAML generator to generate files from existing data in source code repositories. These YAML files can typically have component metadata, including Service name, Owner/team information, Repository URL, Description, Tags, or labels for categorization. Scaffolding templates can automatically generate YAML files based on predefined configurations. YAML files can also source from API definitions, especially from OpenAPI. In some cases, it should be possible to generate YAML files based on the inputs developers manually provide through the User Interface (UI) or Command Line Interfaces (CLIs). A track includes fields like ownership, lifecycle status and versioning, which are converted into YAML format.
To create a YAML file, access the YAML generator tab from KDE. Select your entity type and add the metadata (name, title and description). Depending on the entity type (System, API or component), add the correspondent information:
- System: Include the owner.
- API: Include the API type (OpenAPI, AsyncAPI, gRPC, or GraphQL), API definition, lifecycle and system.
Component: Include the owner, component type, lifecycle, parent components, provided and consumed APIs, and dependencies.
Once all details are completed, generate the YAML descriptor for it. Copy the YAML text to the clipboard and paste it into a new file in an editor. Save the file as catalog-info.yaml, and place the file at a location from where KDE can discover it.
Roles for Kyndryl Developer Experience
Only developers who are onboarded and mapped to a specific Bridge Account and assigned the Bridge Viewer role, are be able to view the Developer Console option under the Bridge Main Menu. Clicking the Developer Console option from Bridge opens up the Console in the same screen.
The access group set in Bridge IAM only allows you to view the Developer Experience from the Console menu. However, the KDE roles established using the GitHub organization permissions will allow users to perform the different activities required for their job.
The following roles are supported for Kyndryl Developer Experience:
Users related to | KDE role (set internally) | Description |
|---|---|---|
KDE Platform team | Super Admin role | All KDE permissions granted. |
Dev Manager or Architect | Team Admin role | Can perform the following actions within the team or to (selective) teams:
|
Developers | Operator role |
|
Leadership team | Auditor role | Can get a comprehensive view of:
|
Viewers | Viewer role |
Note: The GitHub repository permissions may precede the viewer role allowing users to edit when accessing the service/component from GitHub. |
Adding KDE roles:
- Log in to Kyndryl Bridge
- Access the IAM page
- Click Add New.
- Click Add next to the permission of your choice and see the Summary pane for confirmation.
- Once you are satisfied with your selection, click Add at the bottom of the page to finish. The new custom role is created and displayed under the Roles tab.