Skip to content

Commit bca1502

Browse files
sivanel97sivanel97
authored
Merge pull request #2786 from port-labs/PORTN-3647-add-gitlab-to-azure-installation
Portn 3647 add gitlab to azure installation
2 parents 1670154 + 9f9148f commit bca1502

File tree

2 files changed

+70
-11
lines changed

2 files changed

+70
-11
lines changed

‎docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/_azure_docker_params.mdx‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
| Parameter | Description | Required |
2-
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------ | -------- |
3-
| `OCEAN__PORT__CLIENT_ID` | Your port client id | ✅ |
4-
| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret | ✅ |
5-
| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US | ✅ |
6-
| `OCEAN__SECRET__AZURE_CLIENT_ID` | Your Azure client ID | ✅ |
7-
| `OCEAN__SECRET__AZURE_CLIENT_SECRET` | Your Azure client secret | ✅ |
8-
| `OCEAN__SECRET__AZURE_TENANT_ID` | Your Azure tenant ID | ✅ |
9-
| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping | ❌ |
10-
| `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 | ❌ |
11-
| `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one | ❌ |
1+
| Parameter | Description | Required |
2+
| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------- |
3+
| `OCEAN__PORT__CLIENT_ID` | Your port client id. | ✅ |
4+
| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret. | ✅ |
5+
| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US. | ✅ |
6+
| `OCEAN__SECRET__AZURE_CLIENT_ID` | Your Azure client ID. | ✅ |
7+
| `OCEAN__SECRET__AZURE_CLIENT_SECRET` | Your Azure client secret. | ✅ |
8+
| `OCEAN__SECRET__AZURE_TENANT_ID` | Your Azure tenant ID. | ✅ |
9+
| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, When set to false the integration will not create default blueprints and the port App config Mapping. | ❌ |
10+
| `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. | ❌ |
11+
| `OCEAN__INTEGRATION__IDENTIFIER` | Change the identifier to describe your integration, if not set will use the default one. | ❌ |

‎docs/build-your-software-catalog/sync-data-to-catalog/cloud-providers/azure/installation.md‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,65 @@ kubectl apply -f azure-integration.yaml
325325

326326
</TabItem>
327327

328+
<TabItem value="gitlab" label="GitLab">
329+
330+
Make sure to [configure the following GitLab variables](https://docs.gitlab.com/ee/ci/variables/#for-a-project):
331+
332+
| Parameter | Description | Required |
333+
| --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | -------- |
334+
| `OCEAN__PORT__CLIENT_ID` | Your port client id. | ✅ |
335+
| `OCEAN__PORT__CLIENT_SECRET` | Your port client secret. | ✅ |
336+
| `OCEAN__PORT__BASE_URL` | Your Port API URL - `https://api.getport.io` for EU, `https://api.us.getport.io` for US. | ✅ |
337+
| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_ID` | The client ID of the Azure App Registration. | ✅ |
338+
| `OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_SECRET` | The client secret of the Azure App Registration. | ✅ |
339+
| `OCEAN__INTEGRATION__CONFIG__AZURE_TENANT_ID` | The tenant ID of the Azure App Registration. | ✅ |
340+
| `OCEAN__INITIALIZE_PORT_RESOURCES` | Default true, when set to false the integration will not create default blueprints and the port App config mapping. | ❌ |
341+
| `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. | ❌ |
342+
| `OCEAN__EVENT_LISTENER` | [The event listener object](https://ocean.getport.io/framework/features/event-listener/). | ❌ |
343+
344+
<br/>
345+
346+
Here is an example for `.gitlab-ci.yml` pipeline file:
347+
348+
```yaml showLineNumbers
349+
default:
350+
image: docker:24.0.5
351+
services:
352+
- docker:24.0.5-dind
353+
before_script:
354+
- docker info
355+
356+
variables:
357+
INTEGRATION_TYPE: azure
358+
VERSION: latest
359+
360+
stages:
361+
- ingest
362+
363+
ingest_data:
364+
stage: ingest
365+
variables:
366+
IMAGE_NAME: ghcr.io/port-labs/port-ocean-$INTEGRATION_TYPE:$VERSION
367+
script:
368+
- |
369+
docker run -i --rm --platform=linux/amd64 \
370+
-e OCEAN__PORT__CLIENT_ID=$PORT_CLIENT_ID \
371+
-e OCEAN__PORT__CLIENT_SECRET=$PORT_CLIENT_SECRET \
372+
-e OCEAN__PORT__BASE_URL="https://api.port.io" \
373+
-e OCEAN__INITIALIZE_PORT_RESOURCES=true \
374+
-e OCEAN__SEND_RAW_DATA_EXAMPLES=true \
375+
-e OCEAN__EVENT_LISTENER='{"type": "ONCE"}' \
376+
-e OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_ID="Enter value here" \
377+
-e OCEAN__INTEGRATION__CONFIG__AZURE_CLIENT_SECRET="Enter value here" \
378+
-e OCEAN__INTEGRATION__CONFIG__AZURE_TENANT_ID="Enter value here" \
379+
$IMAGE_NAME
380+
381+
rules: # Run only when changes are made to the main branch
382+
- if: '$CI_COMMIT_BRANCH == "main"'
383+
```
384+
385+
</TabItem>
386+
328387
</Tabs>
329388

330389
</TabItem>

0 commit comments

Comments
 (0)