Software Entities
Software Entities offers developers a comprehensive and centralized platform to view various services and entities. The organized system allows for minimal context switching, centralized access, and clear visibility of elements and their associated details. You can quickly review the owner, components related to each other, associated APIs for this component, or the associated PRs that impact your workflow.
Software Entities not only provides a clear view of existing components within your team and the necessary details to answer your questions, but it also empowers you to create and register components easily and quickly. This feature puts you in control of your development process, allowing you to shape it according to your needs.
When accessing the Developer Console page, select the Software Entities tab.
The following is a list of all software entities:
- API
- Component
- Domain
- Group
- Location
- Resource
- System
- User
Here, it displays the components you have access. Components include:
- Service
- Library
- Resource
- Website
- Documentation
- Other
The Software Entities is designed with your needs in mind, offering flexibility in how you search for elements. You can use the search bar for a quick lookup, or you can filter the list of components by the owner, entity kind, or processing status for a more targeted search. You can also list your favorite components for a quick search.
The entities table display the following details:
- Name: Name added to the software entity.
- System: Name of the system for the entity.
- Owner: Creator of the entity.
- Type: Type of component such as service, application, library, resource, website, or documentation.
- Lifecycle: Status of the entity such as pilot, production, draft.
- Description: A small description of what is this entity.
- Tags: Any tags added when creating the software entity.
- Team or Reviewers: Users or team designated to review this entity.
- Actions: Enables the capability to open the software entity, edit its details and mark it as favorite for quicker access. Favorited entities appear in the “Starred Entities” section of the Home page.
Once the element has been selected, you can view additional details by accessing the overview tab for each item:
- Insights: A separate link is available to view the Source Code for component.
- Documents: A link to view Tech Docs for each component. If no documentation is linked to this component, a message displays indicating “no tech docs available”.
- Dependencies: A list of dependencies between component that allows a user to understand the impact of a change in an upstream component on a component that is downstream.
- Useful Links: All links where the component is deployed.
- Announcement: Any news concerning component updates that might indirectly affect this component.
- API: Here, you can find the APIs exposed by this component as well as the APIs consumed by this component along with their correspondent link to ensure a direct access to the Developer Console API board.
- Scorecards: The scorecards tab displays the standards (industry standards or Organization specific standard) and allows to compare your work against the standard. Currently, the GitHub scorecards associated to this component show as per the GitHub best practices along with a adherence statistic to the baseline.
A component can be created from the UI by adding the component from the existing templates or importing from GitHub.
Creating a new component: If you have the correspondent permissions, you can create new software components using standard templates for each kind of component. These templates are pre-defined structures that guide you in providing the necessary details for each type of component, ensuring consistency and completeness in your component creation process.
Registering an existing component: Developers can register the component by entering the URL of the source code repository by linking to an existing entity file or linking to a repository.
Creating a component from API: The option to create the component using API should also be available.
Search function
The search option, located on the left-hand side of the Software Entities section, allows users to efficiently narrow down and locate specific entities. You can filter by:
- Type
- Entity Kind
- Tags
Service-level log access in KDE
Kyndryl Developer Experience (KDE) integrates with Environment Management (Container Cluster Management) to offer streamlined access to pod-level service logs and cluster health data. This integration allows developers, with appropriate roles, to quickly access the logs and view necessary insights to take corrective actions, such as addressing memory issues.
Prerequisites:
- Required annotations must be added.
- Cluster details must be onboarded as part of the entity definition.
Accessing logs and cluster health data:
- Select the preferred application.
- Click the DevOps Foundation tab
- Select Environment Management to view the pod logs and cluster health details.
Benefits:
- Access to logs: Developers can view service-level logs easily from KDE.
- Cluster health insights: The integration with CCM enables visibility into the cluster's health, providing critical data for troubleshooting.