Skip to content

Commit b7ca877

Browse files
kodjomileskodjomiles
authored
Merge branch 'main' into task_t27i1v/find_technical_documentation_with_ai_guide
2 parents 14870ad + 25a83cf commit b7ca877

File tree

7 files changed

+157
-23
lines changed

7 files changed

+157
-23
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>

‎docs/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/GitLab-v2.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,17 @@ resources:
118118
119119
</details>
120120
121+
## Access control
121122
123+
The GitLab integration supports configurable access control to determine which resources are visible and accessible to the integration.
124+
125+
You can configure access control using the `visibility` configuration block in the integration mapping.
126+
127+
This allows you to filter resources based on GitLab access levels (Guest, Reporter, Developer, Maintainer, Owner). You can also disable access level filtering entirely to include all accessible resources.
128+
129+
:::tip Access control configuration
130+
For detailed configuration options, access level reference, and practical examples, see the [Advanced configuration](./advanced.md#access-control) section.
131+
:::
122132

123133
## Capabilities
124134

‎docs/build-your-software-catalog/sync-data-to-catalog/git/gitlab-v2/advanced.md‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,67 @@ The `createMissingRelatedEntities` parameter enables automatic creation of place
5959

6060
</TabItem>
6161

62+
<TabItem value="accessControl" label="Access control">
63+
64+
The `visibility` configuration allows you to control which GitLab resources are accessible to the integration based on access levels.
65+
66+
<h3>Access levels</h3>
67+
68+
GitLab uses numeric access levels to define permissions:
69+
70+
| Level | Role | Description |
71+
|-------|------|-------------|
72+
| 10 | Guest | Read-only access to public resources |
73+
| 20 | Reporter | Can view and download code |
74+
| 30 | Developer | Can push code and manage issues |
75+
| 40 | Maintainer | Can manage project settings |
76+
| 50 | Owner | Full administrative access |
77+
78+
<h3>Parameters</h3>
79+
80+
- **`useMinAccessLevel`**: Boolean flag to enable/disable access level filtering
81+
- **Default value**: `true`
82+
- **Use case**: Set to `false` to include all accessible resources without filtering
83+
84+
- **`minAccessLevel`**: Integer specifying the minimal required access level
85+
- **Default value**: `30` (Developer)
86+
- **Use case**: Restrict integration to resources where the token has the specified access level or higher
87+
88+
<h3>Configuration examples</h3>
89+
90+
```yaml showLineNumbers
91+
# Only sync owned projects
92+
visibility:
93+
useMinAccessLevel: true
94+
minAccessLevel: 50
95+
resources:
96+
- kind: project
97+
selector:
98+
query: 'true'
99+
port:
100+
entity:
101+
mappings:
102+
identifier: .path_with_namespace | gsub(" "; "")
103+
title: .name
104+
blueprint: '"service"'
105+
```
106+
107+
```yaml showLineNumbers
108+
# Include all accessible resources
109+
visibility:
110+
useMinAccessLevel: false
111+
resources:
112+
- kind: project
113+
selector:
114+
query: 'true'
115+
port:
116+
entity:
117+
mappings:
118+
identifier: .path_with_namespace | gsub(" "; "")
119+
title: .name
120+
blueprint: '"service"'
121+
```
122+
123+
</TabItem>
124+
62125
</Tabs>

‎docs/guides/all/enforce-ai-coding-security-standards.md‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -355,14 +355,16 @@ We will create a detailed scorecard that evaluates repositories based on their c
355355

356356
6. Click `Save` to create the scorecard.
357357

358-
:::tip Rule customization
359-
You can customize the scoring rules based on your organization's specific requirements:
360-
- Add rules for specific security keywords or patterns
361-
- Include rules for minimum content length
362-
- Create rules for specific AI tool compliance
363-
- Add rules for regular updates to security guidelines
364-
:::
358+
:::info Scorecard rules explained
359+
This scorecard evaluates repositories based on four key AI coding security standards:
360+
361+
1. **Security Instructions**: Checks if repositories have AI-specific security guidelines
362+
2. **GitHub Copilot Documentation Standards**: Verifies presence of documentation instructions for AI tools
363+
3. **GitHub Copilot Coding Standards**: Ensures general coding instructions are defined for AI assistance
364+
4. **Language-Specific Coding Standards**: Validates that language-specific AI coding guidelines exist
365365

366+
You can modify these rules to match your organization's specific requirements by adjusting the property names, adding new conditions, or changing the scoring criteria.
367+
:::
366368

367369

368370
## Create dashboard
@@ -409,6 +411,8 @@ In the new dashboard, create the following widgets:
409411

410412
</details>
411413

414+
<img src='/img/guides/ai-coding-security-standards-entire-dashboard.png' border="1px" width="100%" />
415+
412416
## Related guides
413417

414418
- [Auto-fix services when scorecards degrade](https://docs.port.io/guides/all/self-heal-scorecards-with-ai/)

‎docs/search-and-query/global-search.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,12 @@ You can search for entities by their title, description, or any other [property]
1818

1919
## Search results
2020

21-
The search bar will return two types of results:
21+
The search bar will return four types of results:
2222

2323
- **Entities**: Entities whose properties (including title & identifier) match your search query.
2424
- **Tech Docs**: Entities that have a `markdown` property whose content contains your search query.
25-
26-
:::info Supported results
27-
Note that the search bar does not return results for blueprints and actions, only entities.
28-
:::
25+
- **Actions**: Actions whose title or identifier match your search query.
26+
- **Blueprints**: Blueprints whose title or identifier match your search query.
2927

3028
## Port highlight search - chrome extension
3129

‎static/img/guides/ai-coding-security-standards-entire-dashboard.png‎

223 KB
Loading

0 commit comments

Comments
 (0)