Skip to content

Commit

Permalink
Merge branch 'main' into PORT-12401-scaffold-new-service-modification
Browse files Browse the repository at this point in the history
  • Loading branch information
kodjomiles authored Jan 18, 2025
2 parents 46108e6 + b5be648 commit 7bec9cc
Show file tree
Hide file tree
Showing 271 changed files with 8,503 additions and 2,381 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ body:
label: Description
description: |
The bug, mistake, typo or other issue you noticed in the docs. Please include a thorough explanation and links to pages in the documentation if relevant
placeholder: I found a typo in the docs' [Quickstart](https://docs.getport.io)
placeholder: I found a typo in the docs' [Quickstart](https://docs.port.io)
validations:
required: true
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ If you want to use headers inside tabs, use `<h>` , for example `<h2>Header text
### Links

- All links must use full paths and not relative ones, to ensure safer code.
- Decide if you want your link to open in the same tab or a new one. To make an internal link* open in a new tab, add [`https://docs.getport.io`](https://docs.getport.io) to the beginning of the link.
- Decide if you want your link to open in the same tab or a new one. To make an internal link* open in a new tab, add [`https://docs.port.io`](https://docs.port.io) to the beginning of the link.
*Internal link - a link that leads to another page **within** the docs site.

### Lists
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h1 align="center">
<p align="center">Port Documentation</p>
<a href="https://docs.getport.io"><img src="https://port-graphical-assets.s3.eu-west-1.amazonaws.com/Port+Logo.svg" alt="Port" width="15%"></a>
<a href="https://docs.port.io"><img src="https://port-graphical-assets.s3.eu-west-1.amazonaws.com/Port+Logo.svg" alt="Port" width="15%"></a>
</h1>

<p align="center">
Expand All @@ -15,7 +15,7 @@ Port is a Developer Platform made to make life easier for developers and DevOps

## Port's documentation

This is the repository for Port's documentation website (available at [https://docs.getport.io](https://docs.getport.io))
This is the repository for Port's documentation website (available at [https://docs.port.io](https://docs.port.io))

Port's documentation is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.

Expand Down
2 changes: 1 addition & 1 deletion archive/gitops/github-app-gitops/advanced-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ deleteDependentEntities: false
| ------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| `specPath` | [globPatterns](https://www.malikbrowne.com/blog/a-beginners-guide-glob-patterns)[] | List of file path patterns that the app will search for `port.yml` files in it | `**/port.yml` |
| `deleteDependentEntities` | `Boolean` | Flag to enable deletion of dependent Entities - an Entity that has a required Relation with an Entity you wish to delete | `false` |
| `enableMergeEntity` | `Boolean` | Flag to enable merging new values with the existing Entity values, instead of overriding all existing values. <br/> More info about merging entities can be found in the [Entity Tutorial](https://docs.getport.io/build-your-software-catalog/custom-integration/api/#usage) | `false` |
| `enableMergeEntity` | `Boolean` | Flag to enable merging new values with the existing Entity values, instead of overriding all existing values. <br/> More info about merging entities can be found in the [Entity Tutorial](https://docs.port.io/build-your-software-catalog/custom-integration/api/#usage) | `false` |
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Self-service actions can be executed from the following locations:

- The [self-service page](https://app.getport.io/self-serve) of your portal.
- Certain [dashboard widgets](https://docs.getport.io/customize-pages-dashboards-and-plugins/dashboards/#action-card) that can be added to your homepage or catalog.
- Certain [dashboard widgets](https://docs.port.io/customize-pages-dashboards-and-plugins/dashboards/#action-card) that can be added to your homepage or catalog.
- Actions that are tied to a specific blueprint can be executed directly from any entity page that is based on that blueprint.
For example, the following page of an entity of type `service` displays a list of actions that can be executed on that entity:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ The following trigger events are available for each type:
| Trigger | Description | JSON event type identifier |
| --- | --- | --- |
| Action run creation | Triggered when an action run is **created**. In other words, whenever the specified action is executed. | `RUN_CREATED` |
| Action run update | Triggered when an action run is [patched](https://docs.getport.io/api-reference/patch-an-action-run/) or [approved](https://docs.getport.io/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac/#configure-manual-approval-for-actions).<br/>**Note** that sending logs to the action run will **not** count as a trigger. | `RUN_UPDATED` |
| Action run update | Triggered when an action run is [patched](https://docs.port.io/api-reference/patch-an-action-run/) or [approved](https://docs.port.io/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac/#configure-manual-approval-for-actions).<br/>**Note** that sending logs to the action run will **not** count as a trigger. | `RUN_UPDATED` |
| Any action run change | Triggered when an action run is **created**, **patched**, or **approved**. | `ANY_RUN_CHANGE` |

</TabItem>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ When using the webhook backend, you need to configure several parameters:
- The `Endpoint URL` field should be filled with the webhook URL you create in GitLab (see below).

:::tip Create action/automation via API
If you wish to create a self-service action or automation via [Port's API](https://docs.getport.io/api-reference/create-an-action-automation), choose the `webhook` backend type under the `invocationMethod` object.
If you wish to create a self-service action or automation via [Port's API](https://docs.port.io/api-reference/create-an-action-automation), choose the `webhook` backend type under the `invocationMethod` object.
:::

### Create the webhook URL
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ This page will introduce the agent and guide you through the installation and co

## Prerequisites

- Connection credentials to Kafka are required. To obtain them, contact us via the intercom bubble in the bottom-right corner, or via our [community Slack](https://www.getport.io/community).
- Connection credentials to Kafka are required. To obtain them, contact us using Intercom/Slack/mail to [[email protected]](mailto:support@getport.io).
- [Helm](https://helm.sh) must be installed in order to install the relevant chart.
- In order to trigger a GitLab Pipeline, you need to have a [GitLab trigger token](https://docs.gitlab.com/ee/ci/triggers/).

Expand Down Expand Up @@ -83,7 +83,7 @@ Once the agent is installed, we can finish setting up the backend in Port.
- **Default ref** - the branch/tag name we want the action/automation to use.
:::tip Create action/automation via API
If you wish to create a self-service action or automation via [Port's API](https://docs.getport.io/api-reference/create-an-action-automation), choose the `gitlab` backend type under the `invocationMethod` object.
If you wish to create a self-service action or automation via [Port's API](https://docs.port.io/api-reference/create-an-action-automation), choose the `gitlab` backend type under the `invocationMethod` object.
:::

### Configure the payload
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ Here is an example of the required configuration:
- For more information about Port's outbound calls, check out Port's [actions security](/actions-and-automations/create-self-service-experiences/security/security.md) page.
- In the **HMAC Secret** field, choose a secret containing your `port-client-secret`.

If this secret doesn't already exist, create a `secret text` type secret using [this guide](https://www.jenkins.io/doc/book/using/using-credentials/). The value of the secret should be your `Port Client Secret` which can be found by following the guide [here](https://docs.getport.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials).
If this secret doesn't already exist, create a `secret text` type secret using [this guide](https://www.jenkins.io/doc/book/using/using-credentials/). The value of the secret should be your `Port Client Secret` which can be found by following the guide [here](https://docs.port.io/build-your-software-catalog/custom-integration/api/#find-your-port-credentials).
:::

## Configuration
Expand All @@ -109,7 +109,7 @@ Once you have set up the webhook trigger in Jenkins, use your new webhook URL in
The [Port execution agent](/actions-and-automations/setup-backend/webhook/port-execution-agent/) provides you with a secure and convenient way to act upon webhook invocations of self-Service actions and automations.
The agent pulls the new invocation event from your dedicated Kafka topic, and sends it to the URL you specified.

If you prefer to send a webhook without using the agent, you can [validate the webhook signature](https://docs.getport.io/create-self-service-experiences/setup-backend/webhook/signature-verification) for increased security.
If you prefer to send a webhook without using the agent, you can [validate the webhook signature](https://docs.port.io/create-self-service-experiences/setup-backend/webhook/signature-verification) for increased security.

To use the agent, set the `agent` field to `true` in the `invocationMethod` object, or set the `Use self-hosted agent` toggle to `Yes` if using the UI.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The steps shown in the image above are as follows:
## Further steps

- See the [Triggering example](#Triggering-example) for Circle CI.
- Contact us through Intercom to set up a Kafka topic for your organization.
- Contact us using Intercom/Slack/mail to [[email protected]](mailto:[email protected]) to set up a Kafka topic for your organization.
- [Install the Port execution agent to trigger the Circle CI pipeline](#Installation).

## Triggering example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In this guide, we will show how to deploy a new `AWS Lambda function`, that will
## Prerequisites

:::note
To follow this example, please contact us via Intercom to receive a dedicated Kafka topic.
To follow this example, please contact us using Intercom/Slack/mail to [[email protected]](mailto:[email protected]) to receive a dedicated Kafka topic.
:::

- AWS CLI installed and configured to your desired AWS account;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Setting up the mapping depends on how you install the agent.

<TabItem value="helm">

To provide the mapping configuration to the agent, run the [installation command](https://docs.getport.io/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/helm#installation) again, and add the following parameter:
To provide the mapping configuration to the agent, run the [installation command](https://docs.port.io/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/helm#installation) again, and add the following parameter:

```bash
--set-file controlThePayloadConfig=/PATH/TO/LOCAL/FILE.yml
Expand All @@ -39,7 +39,7 @@ To provide the mapping configuration to the agent, run the [installation command

<TabItem value="argo">

To provide the mapping to the agent, add the mapping to the `values.yaml` file created in the installation [here](https://docs.getport.io/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/argocd#installation). The needs to be added as a top level field.
To provide the mapping to the agent, add the mapping to the `values.yaml` file created in the installation [here](https://docs.port.io/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/argocd#installation). The needs to be added as a top level field.

Below you can find the default mapping to use as a starting point:

Expand All @@ -56,7 +56,7 @@ controlThePayloadConfig: |
</TabItem>
<TabItem value="docker">
To provide the mapping to the agent, mount the mapping file to the container by adding the following parameter to the [installation command](https://docs.getport.io/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/docker#installation):
To provide the mapping to the agent, mount the mapping file to the container by adding the following parameter to the [installation command](https://docs.port.io/actions-and-automations/setup-backend/webhook/port-execution-agent/installation-methods/docker#installation):
```bash
-v /PATH/TO/LOCAL/FILE.json:/app/control_the_payload_config.json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Our Port agent is open source - see it [**here**](https://github.com/port-labs/p
:::

:::note
To use the execution agent, please contact us via Intercom to receive a dedicated Kafka topic.
To use the execution agent, please contact us using Intercom/Slack/mail to [[email protected]](mailto:[email protected]) to receive a dedicated Kafka topic.
:::

The data flow when using the Port execution agent is as follows:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ token** or **team token**.
## Further steps

- See the [Triggering example](#Triggering-example) for Terraform Cloud.
- Contact us through Intercom to set up a Kafka topic for your organization.
- Contact us using Intercom/Slack/mail to [[email protected]](mailto:[email protected]) to set up a Kafka topic for your organization.
- [Install the Port execution agent to trigger the Terraform Cloud Run](#Installation).

## Triggering example
Expand Down
4 changes: 2 additions & 2 deletions docs/actions-and-automations/setup-backend/webhook/webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ https://example.com?token={{ .secrets.secret_token_name }}
The [Port execution agent](/actions-and-automations/setup-backend/webhook/port-execution-agent/) provides you with a secure and convenient way to act upon webhook invocations of self-service actions and automations.
The agent pulls the new invocation event from your dedicated Kafka topic, and sends it to the URL you specified.

If you prefer to send a webhook without using the agent, you can [validate the webhook signature](https://docs.getport.io/create-self-service-experiences/setup-backend/webhook/signature-verification) for increased security.
If you prefer to send a webhook without using the agent, you can [validate the webhook signature](https://docs.port.io/create-self-service-experiences/setup-backend/webhook/signature-verification) for increased security.

To use the agent, set the `agent` field to `true` in the `invocationMethod` object, or set the `Use self-hosted agent` toggle to `Yes` if using the UI.

Expand All @@ -82,7 +82,7 @@ You can change the request to any of the supported types: `POST`, `PUT`, `DELETE

## Trigger Port API

You can use this backend type to trigger [Port's API](https://docs.getport.io/api-reference/port-api), allowing you to execute any route you wish with automatic authentication.
You can use this backend type to trigger [Port's API](https://docs.port.io/api-reference/port-api), allowing you to execute any route you wish with automatic authentication.
Port will automatically use the organization's API key to authenticate the request.

This can be useful when you want to perform an operation in Port, such as creating a new user or executing a self-service action, especially if you want to trigger logic that you have already defined.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Depending on the backend type you choose, the available fields will be different
| `agent` | `boolean` | Defines whether to use [Port Agent](/actions-and-automations/setup-backend/webhook/port-execution-agent/port-execution-agent.md) for execution or not. | `true` or `false` |
| `url` | `string` | Defines the webhook URL to which Port will send the action via an HTTP POST request. | https://example.com |
| `method` | `string` | Defines the HTTP method to be used for the request. | `POST`, `PUT`, `DELETE`, `PATCH` |
| `synchronized` | `boolean` | If true, the action will be executed [synchronously](https://docs.getport.io/create-self-service-experiences/setup-backend/webhook/#sync-vs-async-execution). | `true` or `false` |
| `synchronized` | `boolean` | If true, the action will be executed [synchronously](https://docs.port.io/create-self-service-experiences/setup-backend/webhook/#sync-vs-async-execution). | `true` or `false` |
| `headers` | `object` | An object containing the payload headers to be sent to the webhook in each execution, in `"key":"value"` pairs. |
| `body` | `object` | Defines the **payload** that will be sent to the backend upon execution of the action.<br/>An object containing `"key":"value"` pairs. |

Expand Down
4 changes: 2 additions & 2 deletions docs/api-reference/add-a-log-to-an-action-run.api.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: add-a-log-to-an-action-run
title: "Add a log to an action run"
description: "This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.<br/><br/>To learn more about action runs, check out the [documentation](https://docs.getport.io/create-self-service-experiences/reflect-action-progress/)."
description: "This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.<br/><br/>To learn more about action runs, check out the [documentation](https://docs.port.io/create-self-service-experiences/reflect-action-progress/)."
sidebar_label: "Add a log to an action run"
hide_title: true
hide_table_of_contents: true
Expand Down Expand Up @@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem";



This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.<br/><br/>To learn more about action runs, check out the [documentation](https://docs.getport.io/create-self-service-experiences/reflect-action-progress/).
This route allows you to send a log message back to Port, which will be displayed in the action run's page. You can also use this route to update the run's termination status (SUCCESS/FAILURE) and label describing the status.<br/><br/>To learn more about action runs, check out the [documentation](https://docs.port.io/create-self-service-experiences/reflect-action-progress/).

<Heading
id={"request"}
Expand Down
Loading

0 comments on commit 7bec9cc

Please sign in to comment.