Update Humanitec integration docs to contain newly supported resources #2502
Conversation
…or Deployment Deltas, Deployment Sets, Secret Stores, Shared Values, Users, Groups, and Pipelines. Update HumanitecExporter to support syncing these new entities and improve error handling in API calls. Refactor existing code for better clarity and maintainability.
…ties such as pipelines, deployment deltas, deployment sets, secret stores, shared values, value set versions, users, and groups for improved clarity on synchronization capabilities.
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
There was a problem hiding this comment.
Some of the comments apply to other places and should replicated as same like the headings, the click to drops, the numbered list in a numbered list.
also for the sidebar we can have something like
Overview Set up data model Implementation Add GitHub secrets Add python scripts Add GitHub workflow
|
|
||
| # Humanitec Integration | ||
|
|
||
| ## Overview | ||
|
|
||
| In this example, you are going to create a github worklow integration to facilitate the ingestion of Humanitec applications, environments, workloads, resources and resource graphs into your port catalog on schedule | ||
| In this example, you are going to create a github worklow integration to facilitate the ingestion of Humanitec applications, environments, workloads, resources, resource graphs, pipelines, deployment deltas, deployment sets, secret stores, shared values, value set versions, users, groups into your port catalog on schedule | ||
|
|
||
| :::info Prerequisites |
There was a problem hiding this comment.
Let's remove this prerequisite as it's not needed here.
Let's move it to the part we set up the GitHub workflow, it can be under a header as add GitHub secretes.
You can check sample guides that implement a Github workflow for example this one acknowledge incident
| @@ -31,7 +40,7 @@ In this example, you are going to create a github worklow integration to facilit | |||
| - `PORT_CLIENT_SECRET` - Your port `client secret` [How to get the credentials](https://docs.port.io/build-your-software-catalog/sync-data-to-catalog/api/#find-your-port-credentials). | |||
| ::: | |||
|
|
|||
| ## Port blueprints | |||
| ## Set up data model | |||
|
|
|||
| Create the following blueprint definitions in port: | |||
There was a problem hiding this comment.
Let's add the steps in creating blueprints here:
`1. Go to the Builder page of your portal.
-
Click on
+ Blueprint. -
Click on the
{...}button in the top right corner, and chooseEdit JSON. -
Add the JSON schemas:`
| @@ -0,0 +1,59 @@ | |||
| <details> | |||
| <summary>Humanitec Deployment Deltas</summary> | |||
There was a problem hiding this comment.
| <summary>Humanitec Deployment Deltas</summary> | |
| <summary><b>Humanitec deployment deltas (click to expand)</b></summary> |
There was a problem hiding this comment.
Let's do same for the others
| @@ -54,7 +80,7 @@ You may select the blueprints depending on what you want to track in your Humani | |||
| :::tip | |||
| Fork our [humanitec integration repository](https://github.com/port-labs/humanitec-integration-script.git) to get started. | |||
| ::: | |||
| 1. Create the following Python files in a folder name `integration` folder at the root of your GitHub repository: | |||
| 1. Create the following Python files in a folder named `integration` at the base directory of your GitHub repository: | |||
There was a problem hiding this comment.
| 1. Create the following Python files in a folder named `integration` at the base directory of your GitHub repository: | |
| 1. Create the following Python files in a folder named `integration` at the base directory of your GitHub repository: | |
| @@ -54,7 +80,7 @@ You may select the blueprints depending on what you want to track in your Humani | |||
| :::tip | |||
| Fork our [humanitec integration repository](https://github.com/port-labs/humanitec-integration-script.git) to get started. | |||
| ::: | |||
| 1. Create the following Python files in a folder name `integration` folder at the root of your GitHub repository: | |||
| 1. Create the following Python files in a folder named `integration` at the base directory of your GitHub repository: | |||
| 1. `main.py` - Orchestrates the synchronization of data from Humanitec to Port, ensuring that resource entities are accurately mirrored and updated on your port catalog. | |||
There was a problem hiding this comment.
The order here doesn't really matter so we can use unordered list here to make it more visually appealing.
The numbered list in a numbered list makes it hard to read
| 1. `main.py` - Orchestrates the synchronization of data from Humanitec to Port, ensuring that resource entities are accurately mirrored and updated on your port catalog. | |
| - `main.py` - Orchestrates the synchronization of data from Humanitec to Port, ensuring that resource entities are accurately mirrored and updated on your port catalog. | |
| @@ -54,7 +80,7 @@ You may select the blueprints depending on what you want to track in your Humani | |||
| :::tip | |||
| Fork our [humanitec integration repository](https://github.com/port-labs/humanitec-integration-script.git) to get started. | |||
| ::: | |||
| 1. Create the following Python files in a folder name `integration` folder at the root of your GitHub repository: | |||
| 1. Create the following Python files in a folder named `integration` at the base directory of your GitHub repository: | |||
| 1. `main.py` - Orchestrates the synchronization of data from Humanitec to Port, ensuring that resource entities are accurately mirrored and updated on your port catalog. | |||
| 2. `requirements.txt` - This file contains the dependencies or necessary external packages need to run the integration | |||
There was a problem hiding this comment.
| 2. `requirements.txt` - This file contains the dependencies or necessary external packages need to run the integration | |
| - `requirements.txt` - This file contains the dependencies or necessary external packages need to run the integration | |
Description
Enhance Humanitec integration documentation by adding new templates for Deployment Deltas, Deployment Sets, Secret Stores, Shared Values, Users, Groups, and Pipelines. Update HumanitecExporter to support syncing these new entities.
Updated docs pages
Please also include the path for the updated docs
docs/guides/all/humanitec-integration)