Get started with IDP
Hi there! This guide assumes that you are new to the Harness Internal Developer Portal (IDP) module and want to get started with it. The getting started guide is designed to be a Proof of Concept (POC) or Proof of Value (POV) which usually takes a sprint to complete by a platform engineer.
By completing this guide, you will get an understanding of how IDP works and its different features, and you can start to think about how you can adopt an IDP in your organization. Here's the list of steps for getting started with IDP.
| Items | Milestone | Step | Documentation |
|---|---|---|---|
| 1.1 | Setup | Set up IDP with a Git connector needed to carry out the rest of onboarding | Docs |
| 1.2 | (Optional) Import services from Harness CD | Docs | |
| 1.3 | Configure the Developer HomePage | Docs | |
| 2.1 | Explore Software Catalog | Create User Groups for the teams with team members in it. Skip if you already have a Harness User Group representing a team. | Docs |
| 2.2 | Register/Update Services with Owner defined | ||
| 2.3 | Register an API with existing OpenAPI definition | Docs | |
| 2.4 | Create a System entity and update Services and APIs to be a part of the system | Docs | |
| 2.5 | Create a Domain and update the System to be part of the Domain | Docs | |
| 2.6 | Add Service to Service and Service to API dependencies | ||
| 2.7 | Enable Markdown docs for a Service | Docs | |
| 3 | Enable a Plugin | Go to IDP Admin -> Plugins and follow the docs of the chosen plugin to enable and configure it. | |
| 4 | Create a Scorecard to measure service maturity | Use the existing available checks to create a new Service Maturity Scorecard | |
| 5 | Create Self Service Workflow | Create a new service Onboarding pipeline which creates a new repo with cookiecutter hello world code and registers the new component back in the Software Catalog |
Let us start with learning what IDP does, head over to Harness IDP Overview.