From 99b60b65f5e403dba858845700e0b00f7e3780cf Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Mon, 8 Sep 2025 15:54:18 +0300 Subject: [PATCH 1/3] Added gitlab installation to azure CI installation method --- .../azure/_azure_docker_params.mdx | 22 +++---- .../cloud-providers/azure/installation.md | 59 +++++++++++++++++++ 2 files changed, 70 insertions(+), 11 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/_azure_docker_params.mdx b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/_azure_docker_params.mdx index 43bf24bad5..ca4796e626 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/_azure_docker_params.mdx +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/_azure_docker_params.mdx @@ -1,11 +1,11 @@ -| Parameter | Description | Required | -| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------- | -| `OCEAN__PORT__CLIENT_ID` | Your port client id | ✅ | -| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret | ✅ | -| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US | ✅ | -| `OCEAN__SECRET__AZURE_CLIENT_ID` | Your Azure client ID | ✅ | -| `OCEAN__SECRET__AZURE_CLIENT_SECRET` | Your Azure client secret | ✅ | -| `OCEAN__SECRET__AZURE_TENANT_ID` | Your Azure tenant ID | ✅ | -| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping | ❌ | -| `OCEAN__SEND_RAW_DATA_EXAMPLES` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping. Default is true | ❌ | -| `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one | ❌ | +| Parameter | Description | Required | +| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------- | +| `OCEAN__PORT__CLIENT_ID` | Your port client id. | ✅ | +| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret. | ✅ | +| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US. | ✅ | +| `OCEAN__SECRET__AZURE_CLIENT_ID` | Your Azure client ID. | ✅ | +| `OCEAN__SECRET__AZURE_CLIENT_SECRET` | Your Azure client secret. | ✅ | +| `OCEAN__SECRET__AZURE_TENANT_ID` | Your Azure tenant ID. | ✅ | +| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping. | ❌ | +| `OCEAN__SEND_RAW_DATA_EXAMPLES` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping. Default is true. | ❌ | +| `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one. | ❌ | diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md index c73cfcb1d2..b4e67ee7aa 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md @@ -325,6 +325,65 @@ kubectl apply -f azure-integration.yaml + + +Make sure to [configure the following GitLab variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project): + +| Parameter | Description | Required | +| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------- | +| `OCEAN__PORT__CLIENT_ID` | Your port client id. | ✅ | +| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret. | ✅ | +| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US. | ✅ | +| `OCEAN__SECRET__AZURE_CLIENT_ID` | Your Azure client ID. | ✅ | +| `OCEAN__SECRET__AZURE_CLIENT_SECRET` | Your Azure client secret. | ✅ | +| `OCEAN__SECRET__AZURE_TENANT_ID` | Your Azure tenant ID. | ✅ | +| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping. | ❌ | +| `OCEAN__SEND_RAW_DATA_EXAMPLES` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping. Default is true. | ❌ | +| `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one. | ❌ | + +
+ +Here is an example for `.gitlab-ci.yml` pipeline file: + +```yaml showLineNumbers +default: + image: docker:24.0.5 + services: + - docker:24.0.5-dind + before_script: + - docker info + +variables: + INTEGRATION_TYPE: azure + VERSION: latest + +stages: + - ingest + +ingest_data: + stage: ingest + variables: + IMAGE_NAME: ghcr.io/port-labs/port-ocean-$INTEGRATION_TYPE:$VERSION + script: + - | + docker run -i --rm --platform=linux/amd64 \ + -e OCEAN__PORT__CLIENT_ID=$PORT_CLIENT_ID \ + -e OCEAN__PORT__CLIENT_SECRET=$PORT_CLIENT_SECRET \ + -e OCEAN__PORT__BASE_URL="https://api.port.io" \ + -e OCEAN__INITIALIZE_PORT_RESOURCES=true \ + -e OCEAN__SEND_RAW_DATA_EXAMPLES=true \ + -e OCEAN__EVENT_LISTENER='{"type": "ONCE"}' \ + -e OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_ID="Enter value here" \ + -e OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_SECRET="Enter value here" \ + -e OCEAN__INTEGRATION__CONFIG__AZURE_TENANT_ID="Enter value here" \ + $IMAGE_NAME + + rules: # Run only when changes are made to the main branch + - if: '$CI_COMMIT_BRANCH == "main"' +``` + + + From 73550b94e5305de7159124a874a0bc11bc452b31 Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Mon, 8 Sep 2025 16:14:09 +0300 Subject: [PATCH 2/3] WIP --- .../cloud-providers/azure/installation.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md index b4e67ee7aa..a39860e2ad 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md @@ -340,6 +340,10 @@ Make sure to [configure the following GitLab variables](https://docs.gitlab.com/ | `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping. | ❌ | | `OCEAN__SEND_RAW_DATA_EXAMPLES` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping. Default is true. | ❌ | | `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one. | ❌ | +| `OCEAN__EVENT_LISTENER` | [The event listener object](https://ocean.getport.io/framework/features/event-listener/). | | +| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_ID` | The client ID of the Azure App Registration.| | +| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_SECRET` | The client secret of the Azure App Registration. | | +| `OCEAN__INTEGRATION__CONFIG__AZURE_TENANT_ID` | The tenant ID of the Azure App Registration. | |
From 9f9148f8e90a9cc55c5f94aaf93f8ee65a9ff65d Mon Sep 17 00:00:00 2001 From: Sivan Elkabes Date: Tue, 9 Sep 2025 09:22:33 +0300 Subject: [PATCH 3/3] organized the table and set required to true and false --- .../cloud-providers/azure/installation.md | 26 ++++++++----------- 1 file changed, 11 insertions(+), 15 deletions(-) diff --git a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md index a39860e2ad..824638b645 100644 --- a/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md +++ b/docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md @@ -329,21 +329,17 @@ kubectl apply -f azure-integration.yaml Make sure to [configure the following GitLab variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project): -| Parameter | Description | Required | -| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------- | -| `OCEAN__PORT__CLIENT_ID` | Your port client id. | ✅ | -| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret. | ✅ | -| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US. | ✅ | -| `OCEAN__SECRET__AZURE_CLIENT_ID` | Your Azure client ID. | ✅ | -| `OCEAN__SECRET__AZURE_CLIENT_SECRET` | Your Azure client secret. | ✅ | -| `OCEAN__SECRET__AZURE_TENANT_ID` | Your Azure tenant ID. | ✅ | -| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping. | ❌ | -| `OCEAN__SEND_RAW_DATA_EXAMPLES` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping. Default is true. | ❌ | -| `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one. | ❌ | -| `OCEAN__EVENT_LISTENER` | [The event listener object](https://ocean.getport.io/framework/features/event-listener/). | | -| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_ID` | The client ID of the Azure App Registration.| | -| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_SECRET` | The client secret of the Azure App Registration. | | -| `OCEAN__INTEGRATION__CONFIG__AZURE_TENANT_ID` | The tenant ID of the Azure App Registration. | | +| Parameter | Description | Required | +| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------- | +| `OCEAN__PORT__CLIENT_ID` | Your port client id. | ✅ | +| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret. | ✅ | +| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US. | ✅ | +| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_ID` | The client ID of the Azure App Registration. | ✅ | +| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_SECRET` | The client secret of the Azure App Registration. | ✅ | +| `OCEAN__INTEGRATION__CONFIG__AZURE_TENANT_ID` | The tenant ID of the Azure App Registration. | ✅ | +| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, when set to false the integration will not create default blueprints and the port App config mapping. | ❌ | +| `OCEAN__SEND_RAW_DATA_EXAMPLES` | Enable sending raw data examples from the third party API to port for testing and managing the integration mapping. Default is true. | ❌ | +| `OCEAN__EVENT_LISTENER` | [The event listener object](https://ocean.getport.io/framework/features/event-listener/). | ❌ |