From e003c673fe73a14f47245f13703f57ef567f7637 Mon Sep 17 00:00:00 2001 From: Hadar Date: Sun, 9 Jun 2024 12:18:11 +0300 Subject: [PATCH] backend update --- .../create-self-service-experiences.md | 2 +- .../setup-the-backend/_category_.json | 4 +++ .../setup-the-backend/setup-the-backend.md | 36 +++++++++++++++++++ .../{automations.md => define-automations.md} | 0 .../reflect-action-progress.md | 2 +- .../setup-backend/setup-backend.md | 27 ++++---------- 6 files changed, 48 insertions(+), 23 deletions(-) create mode 100644 docs/actions-and-automations/create-self-service-experiences/setup-the-backend/_category_.json create mode 100644 docs/actions-and-automations/create-self-service-experiences/setup-the-backend/setup-the-backend.md rename docs/actions-and-automations/define-automations/{automations.md => define-automations.md} (100%) diff --git a/docs/actions-and-automations/create-self-service-experiences/create-self-service-experiences.md b/docs/actions-and-automations/create-self-service-experiences/create-self-service-experiences.md index efeed6747..b854a6273 100644 --- a/docs/actions-and-automations/create-self-service-experiences/create-self-service-experiences.md +++ b/docs/actions-and-automations/create-self-service-experiences/create-self-service-experiences.md @@ -75,7 +75,7 @@ The backend logic is yours, so it can do whatever you need it to do. Port suppor As part of your backend and its logic implementation, you can keep your software catalog up to date by sending API requests or ingesting new data that is tied to the performed action (for example, adding a new service entity in Port once the scaffold process has finished). -See [Setup backend](/actions-and-automations/setup-backend/) for instructions and examples. +See [Setup backend](/actions-and-automations/create-self-service-experiences/setup-the-backend/) for instructions and examples.
diff --git a/docs/actions-and-automations/create-self-service-experiences/setup-the-backend/_category_.json b/docs/actions-and-automations/create-self-service-experiences/setup-the-backend/_category_.json new file mode 100644 index 000000000..7b4aced01 --- /dev/null +++ b/docs/actions-and-automations/create-self-service-experiences/setup-the-backend/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Setup backend", + "position": 2 +} diff --git a/docs/actions-and-automations/create-self-service-experiences/setup-the-backend/setup-the-backend.md b/docs/actions-and-automations/create-self-service-experiences/setup-the-backend/setup-the-backend.md new file mode 100644 index 000000000..a1a536e33 --- /dev/null +++ b/docs/actions-and-automations/create-self-service-experiences/setup-the-backend/setup-the-backend.md @@ -0,0 +1,36 @@ +--- +title: Setup backend +--- + +import DocCardList from '@theme/DocCardList'; +import Tabs from "@theme/Tabs" +import TabItem from "@theme/TabItem" + +# Setup backend + +
+ + + +
+
+ +Port's self-service actions support a variety of backends that can be used when triggered. + +Here is the basic backend model: + + +

+ +## Define the backend + +Port's uses the same backend types and configurations for both self-service actions and [automations](/actions-and-automations/define-automations/). + +All available backends and their configurations can be found [here](/actions-and-automations/setup-backend/). + +___ + +## Next step + +Once the backend is set up, the action is ready to be used. +Optionally, you can [configure permissions and/or manual approval](/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac/) for your actions to control who is allowed to execute them. \ No newline at end of file diff --git a/docs/actions-and-automations/define-automations/automations.md b/docs/actions-and-automations/define-automations/define-automations.md similarity index 100% rename from docs/actions-and-automations/define-automations/automations.md rename to docs/actions-and-automations/define-automations/define-automations.md diff --git a/docs/actions-and-automations/reflect-action-progress/reflect-action-progress.md b/docs/actions-and-automations/reflect-action-progress/reflect-action-progress.md index 080517f4e..a007bbf90 100644 --- a/docs/actions-and-automations/reflect-action-progress/reflect-action-progress.md +++ b/docs/actions-and-automations/reflect-action-progress/reflect-action-progress.md @@ -3,7 +3,7 @@ import Tabs from "@theme/Tabs" import TabItem from "@theme/TabItem" -Once you execute a self-service action, an `actionRun` object will be created in Port. +Once a self-service action or automation has been executed, an `actionRun` object will be created in Port. This page will teach you how to use Port's API to obtain existing action runs and update them with additional metadata and information about the run. You can use this interaction to mark actions as completed or failed, and keep a consistent history of executed actions and their status. diff --git a/docs/actions-and-automations/setup-backend/setup-backend.md b/docs/actions-and-automations/setup-backend/setup-backend.md index fe71ee307..96379e708 100644 --- a/docs/actions-and-automations/setup-backend/setup-backend.md +++ b/docs/actions-and-automations/setup-backend/setup-backend.md @@ -8,23 +8,9 @@ import TabItem from "@theme/TabItem" # Setup backend -
- - - -
-
- Port's self-service actions and automations support a variety of backends that can be used when triggered. -Here is the basic backend model: - - -

- -When creating an action, you can define the payload that will be sent every time it is executed. The payload can include any data about the action that you want your backend to have access to. - -Executing a self-service action involves the following steps: +The process contains the following steps: 1. **The action is triggered in Port** - the trigger can either be a user executing a self-service action via the UI, or an automation triggering an action. 2. **The payload is sent to your backend** - the payload, as defined by the action's creator, is sent to your backend. The backend can be a URL, a dedicated Kafka topic or one of your CI/CD workflows/pipelines. @@ -34,6 +20,11 @@ Executing a self-service action involves the following steps: ## Define the backend +:::tip UI support +Currently, only self-service actions can be created via a wizard in the UI. +Automations can be created using a JSON definition, which can be found [here](/actions-and-automations/setup-backend/#json-structure). +::: + The action's backend is defined under the `Backend` tab of the action creation form in Port's UI. Let's break the definition down to two parts: @@ -253,9 +244,3 @@ Depending on the backend type you choose, the available fields will be different -___ - -## Next step - -Once the backend is set up, the action is ready to be used. -Optionally, you can [configure permissions and/or manual approval](/actions-and-automations/create-self-service-experiences/set-self-service-actions-rbac/) for your actions to control who is allowed to execute them. \ No newline at end of file