From 76d050f00f6ab6d110656c6723b889068c7459b0 Mon Sep 17 00:00:00 2001 From: lada7878 Date: Wed, 5 Aug 2026 10:03:28 +0500 Subject: [PATCH 1/5] fix index Signed-off-by: lada7878 --- .../admin/actions/codescoring/_index.ru.md | 2 ++ .../documentation/admin/actions/debug/_index.ru.md | 2 ++ .../admin/actions/defectdojo/_index.ru.md | 2 ++ .../documentation/admin/actions/gitlab/_index.ru.md | 2 ++ .../documentation/admin/actions/kafka/_index.ru.md | 2 ++ .../admin/actions/keycloak/_index.ru.md | 2 ++ .../admin/actions/kubernetes/_index.ru.md | 2 ++ .../documentation/admin/actions/nexus/_index.ru.md | 2 ++ content/documentation/admin/actions/overview.ru.md | 12 ++++++------ .../admin/actions/sonarqube/_index.ru.md | 2 ++ .../documentation/admin/actions/vault/_index.ru.md | 2 ++ .../documentation/admin/actions/wait/_index.ru.md | 2 ++ 12 files changed, 28 insertions(+), 6 deletions(-) diff --git a/content/documentation/admin/actions/codescoring/_index.ru.md b/content/documentation/admin/actions/codescoring/_index.ru.md index e3bbeaa9..d744abf9 100644 --- a/content/documentation/admin/actions/codescoring/_index.ru.md +++ b/content/documentation/admin/actions/codescoring/_index.ru.md @@ -4,3 +4,5 @@ weight: 100 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/debug/_index.ru.md b/content/documentation/admin/actions/debug/_index.ru.md index ab53bd3a..68964eae 100644 --- a/content/documentation/admin/actions/debug/_index.ru.md +++ b/content/documentation/admin/actions/debug/_index.ru.md @@ -4,3 +4,5 @@ weight: 110 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/defectdojo/_index.ru.md b/content/documentation/admin/actions/defectdojo/_index.ru.md index 1b371328..25ee30e1 100644 --- a/content/documentation/admin/actions/defectdojo/_index.ru.md +++ b/content/documentation/admin/actions/defectdojo/_index.ru.md @@ -4,3 +4,5 @@ weight: 90 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/gitlab/_index.ru.md b/content/documentation/admin/actions/gitlab/_index.ru.md index 3754448f..380ce42b 100644 --- a/content/documentation/admin/actions/gitlab/_index.ru.md +++ b/content/documentation/admin/actions/gitlab/_index.ru.md @@ -4,3 +4,5 @@ weight: 20 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/kafka/_index.ru.md b/content/documentation/admin/actions/kafka/_index.ru.md index 58066175..0ab793a6 100644 --- a/content/documentation/admin/actions/kafka/_index.ru.md +++ b/content/documentation/admin/actions/kafka/_index.ru.md @@ -4,3 +4,5 @@ weight: 40 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/keycloak/_index.ru.md b/content/documentation/admin/actions/keycloak/_index.ru.md index 80432168..dec6f9f0 100644 --- a/content/documentation/admin/actions/keycloak/_index.ru.md +++ b/content/documentation/admin/actions/keycloak/_index.ru.md @@ -4,3 +4,5 @@ weight: 70 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/kubernetes/_index.ru.md b/content/documentation/admin/actions/kubernetes/_index.ru.md index 27a04a1f..7621ba11 100644 --- a/content/documentation/admin/actions/kubernetes/_index.ru.md +++ b/content/documentation/admin/actions/kubernetes/_index.ru.md @@ -4,3 +4,5 @@ weight: 60 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/nexus/_index.ru.md b/content/documentation/admin/actions/nexus/_index.ru.md index b40d845b..6ef33102 100644 --- a/content/documentation/admin/actions/nexus/_index.ru.md +++ b/content/documentation/admin/actions/nexus/_index.ru.md @@ -4,3 +4,5 @@ weight: 80 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/overview.ru.md b/content/documentation/admin/actions/overview.ru.md index f5f7a81f..c85eae05 100644 --- a/content/documentation/admin/actions/overview.ru.md +++ b/content/documentation/admin/actions/overview.ru.md @@ -6,12 +6,12 @@ weight: 10 Действия — это механизм платформы для запуска операций во внешних инфраструктурных системах и сервисах. С их помощью можно, например, создавать: -- создавать проекты, переменные, ветки, теги, релизы и merge request'ы в [GitLab](../gitlab/); -- создавать ресурсы в [Kubernetes](../kubernetes/) и получать их; -- создавать секреты в [Deckhouse Stronghold и HashiCorp Vault](../vault/), а также клиентов в [Keycloak](../keycloak/); -- создавать проекты в [SonarQube](../sonarqube/), продукты и engagements в [DefectDojo](../defectdojo/), проекты в [CodeScoring](../codescoring/) и репозитории, роли, пользователей и привилегии в [Nexus Repository](../nexus/); -- создавать топики и ACL в [Apache Kafka](../kafka/); -- выполнять вспомогательные действия для отладки и управления выполнением процессов (например, [Debug](../debug/) и [Wait](../wait/)). +- создавать проекты, переменные, ветки, теги, релизы и merge request'ы в [GitLab](../gitlab/createrepositoryfromtemplate/); +- создавать ресурсы в [Kubernetes](../kubernetes/createkubernetesresource/) и получать их; +- создавать секреты в [Deckhouse Stronghold и HashiCorp Vault](../vault/createvaultsecret/), а также клиентов в [Keycloak](../keycloak/createkeycloakclient/); +- создавать проекты в [SonarQube](../sonarqube/createsonarqubeproject/), продукты и engagements в [DefectDojo](../defectdojo/createdefectdojoproduct/), проекты в [CodeScoring](../codescoring/createcodescoringproject/) и репозитории, роли, пользователей и привилегии в [Nexus Repository](../nexus/createnexusrepository/); +- создавать топики и ACL в [Apache Kafka](../kafka/createkafkatopics/); +- выполнять вспомогательные действия для отладки и управления выполнением процессов (например, [Debug](../debug/debug/) и [Wait](../wait/wait/)). Действие можно привязать к одному или нескольким ресурсам. После этого его можно запускать для любой сущности этих ресурсов. diff --git a/content/documentation/admin/actions/sonarqube/_index.ru.md b/content/documentation/admin/actions/sonarqube/_index.ru.md index 048e6dcf..a907c909 100644 --- a/content/documentation/admin/actions/sonarqube/_index.ru.md +++ b/content/documentation/admin/actions/sonarqube/_index.ru.md @@ -4,3 +4,5 @@ weight: 30 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/vault/_index.ru.md b/content/documentation/admin/actions/vault/_index.ru.md index 0fc52147..79c44608 100644 --- a/content/documentation/admin/actions/vault/_index.ru.md +++ b/content/documentation/admin/actions/vault/_index.ru.md @@ -4,3 +4,5 @@ weight: 50 params: no_list: true --- + + diff --git a/content/documentation/admin/actions/wait/_index.ru.md b/content/documentation/admin/actions/wait/_index.ru.md index 9f59beda..6c333068 100644 --- a/content/documentation/admin/actions/wait/_index.ru.md +++ b/content/documentation/admin/actions/wait/_index.ru.md @@ -4,3 +4,5 @@ weight: 120 params: no_list: true --- + + From 0231f66dafab7869f1b1bfa58c49260eb3ce57c3 Mon Sep 17 00:00:00 2001 From: lada7878 Date: Wed, 5 Aug 2026 10:34:45 +0500 Subject: [PATCH 2/5] fix index Signed-off-by: lada7878 --- .../admin/actions/codescoring/_index.ru.md | 4 ---- .../documentation/admin/actions/debug/_index.ru.md | 4 ---- .../admin/actions/defectdojo/_index.ru.md | 4 ---- .../documentation/admin/actions/gitlab/_index.ru.md | 4 ---- .../documentation/admin/actions/kafka/_index.ru.md | 4 ---- .../admin/actions/keycloak/_index.ru.md | 4 ---- .../admin/actions/kubernetes/_index.ru.md | 4 ---- .../documentation/admin/actions/nexus/_index.ru.md | 4 ---- content/documentation/admin/actions/overview.ru.md | 12 ++++++------ .../admin/actions/sonarqube/_index.ru.md | 4 ---- .../documentation/admin/actions/vault/_index.ru.md | 4 ---- .../documentation/admin/actions/wait/_index.ru.md | 4 ---- 12 files changed, 6 insertions(+), 50 deletions(-) diff --git a/content/documentation/admin/actions/codescoring/_index.ru.md b/content/documentation/admin/actions/codescoring/_index.ru.md index d744abf9..49ae93f6 100644 --- a/content/documentation/admin/actions/codescoring/_index.ru.md +++ b/content/documentation/admin/actions/codescoring/_index.ru.md @@ -1,8 +1,4 @@ --- title: CodeScoring weight: 100 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/debug/_index.ru.md b/content/documentation/admin/actions/debug/_index.ru.md index 68964eae..f8401784 100644 --- a/content/documentation/admin/actions/debug/_index.ru.md +++ b/content/documentation/admin/actions/debug/_index.ru.md @@ -1,8 +1,4 @@ --- title: Debug weight: 110 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/defectdojo/_index.ru.md b/content/documentation/admin/actions/defectdojo/_index.ru.md index 25ee30e1..9c812963 100644 --- a/content/documentation/admin/actions/defectdojo/_index.ru.md +++ b/content/documentation/admin/actions/defectdojo/_index.ru.md @@ -1,8 +1,4 @@ --- title: DefectDojo weight: 90 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/gitlab/_index.ru.md b/content/documentation/admin/actions/gitlab/_index.ru.md index 380ce42b..46d8b304 100644 --- a/content/documentation/admin/actions/gitlab/_index.ru.md +++ b/content/documentation/admin/actions/gitlab/_index.ru.md @@ -1,8 +1,4 @@ --- title: Gitlab weight: 20 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/kafka/_index.ru.md b/content/documentation/admin/actions/kafka/_index.ru.md index 0ab793a6..e7176dd1 100644 --- a/content/documentation/admin/actions/kafka/_index.ru.md +++ b/content/documentation/admin/actions/kafka/_index.ru.md @@ -1,8 +1,4 @@ --- title: Apache Kafka weight: 40 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/keycloak/_index.ru.md b/content/documentation/admin/actions/keycloak/_index.ru.md index dec6f9f0..c5c27fb0 100644 --- a/content/documentation/admin/actions/keycloak/_index.ru.md +++ b/content/documentation/admin/actions/keycloak/_index.ru.md @@ -1,8 +1,4 @@ --- title: Keycloak weight: 70 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/kubernetes/_index.ru.md b/content/documentation/admin/actions/kubernetes/_index.ru.md index 7621ba11..8c99576d 100644 --- a/content/documentation/admin/actions/kubernetes/_index.ru.md +++ b/content/documentation/admin/actions/kubernetes/_index.ru.md @@ -1,8 +1,4 @@ --- title: Kubernetes weight: 60 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/nexus/_index.ru.md b/content/documentation/admin/actions/nexus/_index.ru.md index 6ef33102..7b359971 100644 --- a/content/documentation/admin/actions/nexus/_index.ru.md +++ b/content/documentation/admin/actions/nexus/_index.ru.md @@ -1,8 +1,4 @@ --- title: Nexus Repository weight: 80 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/overview.ru.md b/content/documentation/admin/actions/overview.ru.md index c85eae05..f5f7a81f 100644 --- a/content/documentation/admin/actions/overview.ru.md +++ b/content/documentation/admin/actions/overview.ru.md @@ -6,12 +6,12 @@ weight: 10 Действия — это механизм платформы для запуска операций во внешних инфраструктурных системах и сервисах. С их помощью можно, например, создавать: -- создавать проекты, переменные, ветки, теги, релизы и merge request'ы в [GitLab](../gitlab/createrepositoryfromtemplate/); -- создавать ресурсы в [Kubernetes](../kubernetes/createkubernetesresource/) и получать их; -- создавать секреты в [Deckhouse Stronghold и HashiCorp Vault](../vault/createvaultsecret/), а также клиентов в [Keycloak](../keycloak/createkeycloakclient/); -- создавать проекты в [SonarQube](../sonarqube/createsonarqubeproject/), продукты и engagements в [DefectDojo](../defectdojo/createdefectdojoproduct/), проекты в [CodeScoring](../codescoring/createcodescoringproject/) и репозитории, роли, пользователей и привилегии в [Nexus Repository](../nexus/createnexusrepository/); -- создавать топики и ACL в [Apache Kafka](../kafka/createkafkatopics/); -- выполнять вспомогательные действия для отладки и управления выполнением процессов (например, [Debug](../debug/debug/) и [Wait](../wait/wait/)). +- создавать проекты, переменные, ветки, теги, релизы и merge request'ы в [GitLab](../gitlab/); +- создавать ресурсы в [Kubernetes](../kubernetes/) и получать их; +- создавать секреты в [Deckhouse Stronghold и HashiCorp Vault](../vault/), а также клиентов в [Keycloak](../keycloak/); +- создавать проекты в [SonarQube](../sonarqube/), продукты и engagements в [DefectDojo](../defectdojo/), проекты в [CodeScoring](../codescoring/) и репозитории, роли, пользователей и привилегии в [Nexus Repository](../nexus/); +- создавать топики и ACL в [Apache Kafka](../kafka/); +- выполнять вспомогательные действия для отладки и управления выполнением процессов (например, [Debug](../debug/) и [Wait](../wait/)). Действие можно привязать к одному или нескольким ресурсам. После этого его можно запускать для любой сущности этих ресурсов. diff --git a/content/documentation/admin/actions/sonarqube/_index.ru.md b/content/documentation/admin/actions/sonarqube/_index.ru.md index a907c909..094ef7df 100644 --- a/content/documentation/admin/actions/sonarqube/_index.ru.md +++ b/content/documentation/admin/actions/sonarqube/_index.ru.md @@ -1,8 +1,4 @@ --- title: SonarQube weight: 30 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/vault/_index.ru.md b/content/documentation/admin/actions/vault/_index.ru.md index 79c44608..ba34a237 100644 --- a/content/documentation/admin/actions/vault/_index.ru.md +++ b/content/documentation/admin/actions/vault/_index.ru.md @@ -1,8 +1,4 @@ --- title: HashiCorp Vault weight: 50 -params: - no_list: true --- - - diff --git a/content/documentation/admin/actions/wait/_index.ru.md b/content/documentation/admin/actions/wait/_index.ru.md index 6c333068..cc1ba228 100644 --- a/content/documentation/admin/actions/wait/_index.ru.md +++ b/content/documentation/admin/actions/wait/_index.ru.md @@ -1,8 +1,4 @@ --- title: Wait weight: 120 -params: - no_list: true --- - - From 4ad967c64b0e9489e9c244c9656a1020a835567d Mon Sep 17 00:00:00 2001 From: lada7878 Date: Wed, 5 Aug 2026 11:42:23 +0500 Subject: [PATCH 3/5] english version Signed-off-by: lada7878 --- content/documentation/admin/actions/_index.md | 4 + .../admin/actions/codescoring/_index.md | 4 + .../codescoring/createcodescoringproject.md | 33 ++ .../codescoring/deletecodescoringproject.md | 18 + .../admin/actions/debug/_index.md | 4 + .../admin/actions/debug/debug.md | 23 + .../documentation/admin/actions/debug/fail.md | 18 + .../admin/actions/defectdojo/_index.md | 4 + .../defectdojo/createdefectdojoengagement.md | 25 ++ .../defectdojo/createdefectdojoproduct.md | 23 + .../defectdojo/deletedefectdojoproduct.md | 23 + .../admin/actions/gitlab/_index.md | 4 + .../actions/gitlab/creategitlabbranches.md | 32 ++ .../gitlab/creategitlabgroupvariables.md | 32 ++ .../gitlab/creategitlabmergerequest.md | 62 +++ .../actions/gitlab/creategitlabproject.md | 36 ++ .../gitlab/creategitlabprojectvariables.md | 32 ++ .../gitlab/creategitlabprojectwebhook.md | 36 ++ .../actions/gitlab/creategitlabrelease.md | 35 ++ .../admin/actions/gitlab/creategitlabtag.md | 32 ++ .../gitlab/createrepositoryfromtemplate.md | 396 ++++++++++++++++++ .../actions/gitlab/deletegitlabproject.md | 26 ++ .../actions/gitlab/startgitlabpipeline.md | 34 ++ .../admin/actions/kafka/_index.md | 4 + .../admin/actions/kafka/createkafkaacls.md | 109 +++++ .../admin/actions/kafka/createkafkatopics.md | 37 ++ .../admin/actions/kafka/createkafkausers.md | 41 ++ .../admin/actions/kafka/deletekafkaacls.md | 127 ++++++ .../admin/actions/kafka/deletekafkatopics.md | 31 ++ .../admin/actions/kafka/deletekafkausers.md | 35 ++ .../admin/actions/keycloak/_index.md | 4 + .../actions/keycloak/createkeycloakclient.md | 40 ++ .../admin/actions/kubernetes/_index.md | 4 + .../kubernetes/createkubernetesresource.md | 31 ++ .../kubernetes/deletekubernetesresource.md | 30 ++ .../kubernetes/getkubernetesresource.md | 84 ++++ .../admin/actions/nexus/_index.md | 4 + .../actions/nexus/assignnexusprivilege.md | 37 ++ .../admin/actions/nexus/assignnexusrole.md | 37 ++ .../actions/nexus/createnexusprivilege.md | 67 +++ .../actions/nexus/createnexusrepository.md | 81 ++++ .../admin/actions/nexus/createnexusrole.md | 33 ++ .../admin/actions/nexus/createnexususer.md | 36 ++ .../actions/nexus/deletenexusprivilege.md | 23 + .../actions/nexus/deletenexusrepository.md | 29 ++ .../admin/actions/nexus/deletenexusrole.md | 23 + .../admin/actions/nexus/deletenexususer.md | 23 + .../documentation/admin/actions/overview.md | 364 ++++++++++++++++ .../admin/actions/sonarqube/_index.md | 4 + .../sonarqube/createsonarqubeproject.md | 33 ++ .../sonarqube/deletesonarqubeproject.md | 22 + .../sonarqube/deletesonarqubeprojects.md | 30 ++ .../admin/actions/vault/_index.md | 4 + .../vault/createvaultkubernetesauthrole.md | 55 +++ .../admin/actions/vault/createvaultsecret.md | 41 ++ .../admin/actions/vault/deletevaultsecret.md | 23 + .../admin/actions/wait/_index.md | 4 + .../documentation/admin/actions/wait/wait.md | 22 + 58 files changed, 2508 insertions(+) create mode 100644 content/documentation/admin/actions/_index.md create mode 100644 content/documentation/admin/actions/codescoring/_index.md create mode 100644 content/documentation/admin/actions/codescoring/createcodescoringproject.md create mode 100644 content/documentation/admin/actions/codescoring/deletecodescoringproject.md create mode 100644 content/documentation/admin/actions/debug/_index.md create mode 100644 content/documentation/admin/actions/debug/debug.md create mode 100644 content/documentation/admin/actions/debug/fail.md create mode 100644 content/documentation/admin/actions/defectdojo/_index.md create mode 100644 content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md create mode 100644 content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md create mode 100644 content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md create mode 100644 content/documentation/admin/actions/gitlab/_index.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabbranches.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabmergerequest.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabproject.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabrelease.md create mode 100644 content/documentation/admin/actions/gitlab/creategitlabtag.md create mode 100644 content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md create mode 100644 content/documentation/admin/actions/gitlab/deletegitlabproject.md create mode 100644 content/documentation/admin/actions/gitlab/startgitlabpipeline.md create mode 100644 content/documentation/admin/actions/kafka/_index.md create mode 100644 content/documentation/admin/actions/kafka/createkafkaacls.md create mode 100644 content/documentation/admin/actions/kafka/createkafkatopics.md create mode 100644 content/documentation/admin/actions/kafka/createkafkausers.md create mode 100644 content/documentation/admin/actions/kafka/deletekafkaacls.md create mode 100644 content/documentation/admin/actions/kafka/deletekafkatopics.md create mode 100644 content/documentation/admin/actions/kafka/deletekafkausers.md create mode 100644 content/documentation/admin/actions/keycloak/_index.md create mode 100644 content/documentation/admin/actions/keycloak/createkeycloakclient.md create mode 100644 content/documentation/admin/actions/kubernetes/_index.md create mode 100644 content/documentation/admin/actions/kubernetes/createkubernetesresource.md create mode 100644 content/documentation/admin/actions/kubernetes/deletekubernetesresource.md create mode 100644 content/documentation/admin/actions/kubernetes/getkubernetesresource.md create mode 100644 content/documentation/admin/actions/nexus/_index.md create mode 100644 content/documentation/admin/actions/nexus/assignnexusprivilege.md create mode 100644 content/documentation/admin/actions/nexus/assignnexusrole.md create mode 100644 content/documentation/admin/actions/nexus/createnexusprivilege.md create mode 100644 content/documentation/admin/actions/nexus/createnexusrepository.md create mode 100644 content/documentation/admin/actions/nexus/createnexusrole.md create mode 100644 content/documentation/admin/actions/nexus/createnexususer.md create mode 100644 content/documentation/admin/actions/nexus/deletenexusprivilege.md create mode 100644 content/documentation/admin/actions/nexus/deletenexusrepository.md create mode 100644 content/documentation/admin/actions/nexus/deletenexusrole.md create mode 100644 content/documentation/admin/actions/nexus/deletenexususer.md create mode 100644 content/documentation/admin/actions/overview.md create mode 100644 content/documentation/admin/actions/sonarqube/_index.md create mode 100644 content/documentation/admin/actions/sonarqube/createsonarqubeproject.md create mode 100644 content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md create mode 100644 content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md create mode 100644 content/documentation/admin/actions/vault/_index.md create mode 100644 content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md create mode 100644 content/documentation/admin/actions/vault/createvaultsecret.md create mode 100644 content/documentation/admin/actions/vault/deletevaultsecret.md create mode 100644 content/documentation/admin/actions/wait/_index.md create mode 100644 content/documentation/admin/actions/wait/wait.md diff --git a/content/documentation/admin/actions/_index.md b/content/documentation/admin/actions/_index.md new file mode 100644 index 00000000..d052b755 --- /dev/null +++ b/content/documentation/admin/actions/_index.md @@ -0,0 +1,4 @@ +--- +title: Actions +weight: 30 +--- diff --git a/content/documentation/admin/actions/codescoring/_index.md b/content/documentation/admin/actions/codescoring/_index.md new file mode 100644 index 00000000..49ae93f6 --- /dev/null +++ b/content/documentation/admin/actions/codescoring/_index.md @@ -0,0 +1,4 @@ +--- +title: CodeScoring +weight: 100 +--- diff --git a/content/documentation/admin/actions/codescoring/createcodescoringproject.md b/content/documentation/admin/actions/codescoring/createcodescoringproject.md new file mode 100644 index 00000000..1a2cd98e --- /dev/null +++ b/content/documentation/admin/actions/codescoring/createcodescoringproject.md @@ -0,0 +1,33 @@ +--- +title: CreateCodeScoringProject +weight: 10 +--- + +CreateCodeScoringProject — creates a new project in CodeScoring. +The action uses the CodeScoring API to register a project with the specified parameters: +- project name, +- repository URL, +- VCS system ID, +- an option to automatically run SCA analysis after cloning the repository. + +### Request example + +```yaml +name: example-project +repository: https://gitlab.example.com/group/project.git +vcs_id: 2 +run_sca_after_clone: true +``` + +### Request specification + +| Name | Required | Description | +| -------------------- | -------- | ---------------------------------------------------------------------------- | +| name | Yes | Project name in CodeScoring | +| repository | Yes | Repository URL (e.g., ) | +| vcs_id | Yes | VCS system ID in CodeScoring (must be greater than 0) | +| run_sca_after_clone | No | Automatically run SCA analysis after cloning the repository | + +### Response + +The response returns the created project object with the following information: project identifier (pk), name, project type, description, repository information, project status, access permissions, license, number of dependencies and vulnerabilities, project languages, scan schedule status, and the dates of the first and last SCA scan. diff --git a/content/documentation/admin/actions/codescoring/deletecodescoringproject.md b/content/documentation/admin/actions/codescoring/deletecodescoringproject.md new file mode 100644 index 00000000..bfc44dcf --- /dev/null +++ b/content/documentation/admin/actions/codescoring/deletecodescoringproject.md @@ -0,0 +1,18 @@ +--- +title: DeleteCodeScoringProject +weight: 20 +--- + +DeleteCodeScoringProject — deletes a project in CodeScoring by its ID. + +### Request example + +```yaml +id: 1 +``` + +### Request specification + +| Name | Required | Description | +| ---------- | -------- | --------------------------- | +| id | Yes | Project ID in CodeScoring | diff --git a/content/documentation/admin/actions/debug/_index.md b/content/documentation/admin/actions/debug/_index.md new file mode 100644 index 00000000..f8401784 --- /dev/null +++ b/content/documentation/admin/actions/debug/_index.md @@ -0,0 +1,4 @@ +--- +title: Debug +weight: 110 +--- diff --git a/content/documentation/admin/actions/debug/debug.md b/content/documentation/admin/actions/debug/debug.md new file mode 100644 index 00000000..28b2f666 --- /dev/null +++ b/content/documentation/admin/actions/debug/debug.md @@ -0,0 +1,23 @@ +--- +title: Debug +weight: 10 +--- + +Debug runs a debug action. It lets you perform a specified number of wait cycles, as well as write arbitrary data to the log and return it in the action's response. + +### Request example + +```yaml +sleep_time: 1 +sleep_count: 3 +extra: + example_key: example_value +``` + +### Request specification + +| Name | Required | Description | Default value | +| --------------- | -------- | ---------------------------------------------------------------------------------------------------- | ----------------------- | +| sleep_time | No | Duration of one wait cycle, in seconds | `1` | +| sleep_count | No | Number of wait cycles | `1` | +| extra | No | An arbitrary set of key-value pairs that is written to the log and returned in the action's response | - | diff --git a/content/documentation/admin/actions/debug/fail.md b/content/documentation/admin/actions/debug/fail.md new file mode 100644 index 00000000..bbc12a16 --- /dev/null +++ b/content/documentation/admin/actions/debug/fail.md @@ -0,0 +1,18 @@ +--- +title: Fail +weight: 20 +--- + +Fail emulates an action execution error. Intended for use in processes as a debugging element. + +### Request example + +```yaml +fail: true +``` + +### Request specification + +| Name | Required | Description | Default value | +| ---------- | -------- | -------------------------------------------------------------------------------------- | ----------------------- | +| fail | No | If `true`, the action completes with an error; if `false`, the action completes successfully | `true` | diff --git a/content/documentation/admin/actions/defectdojo/_index.md b/content/documentation/admin/actions/defectdojo/_index.md new file mode 100644 index 00000000..9c812963 --- /dev/null +++ b/content/documentation/admin/actions/defectdojo/_index.md @@ -0,0 +1,4 @@ +--- +title: DefectDojo +weight: 90 +--- diff --git a/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md b/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md new file mode 100644 index 00000000..ce1c78ef --- /dev/null +++ b/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md @@ -0,0 +1,25 @@ +--- +title: CreateDefectdojoEngagement +weight: 30 +--- + + +{{< alert level="info" >}} +Running this action requires a token — an API v2 Key for the user on whose behalf the action will be run. +{{< /alert >}} + +CreateDefectdojoEngagement — creates a new engagement in DefectDojo. The action uses the DefectDojo API v2. + +### Request example + +```yaml +name: example engagement +product: '1' +target_start: '2024-06-01' +target_end: '2024-06-30' +lead: '1' +``` + +### Request specification + +The list of fields corresponds to the official DefectDojo API, `/api/v2/engagements`, for more information see [the DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). diff --git a/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md b/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md new file mode 100644 index 00000000..cafdad49 --- /dev/null +++ b/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md @@ -0,0 +1,23 @@ +--- +title: CreateDefectdojoProduct +weight: 10 +--- + + +{{< alert level="info" >}} +Running this action requires a token — an API v2 Key for the user on whose behalf the action will be run. +{{< /alert >}} + +CreateDefectdojoProduct — creates a new product in DefectDojo. The action uses the DefectDojo API v2. + +### Request example + +```yaml +name: example +description: example description +prod_type: 1 +``` + +### Request specification + +The list of fields corresponds to the official DefectDojo API, `/api/v2/products`, for more information see [the DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). diff --git a/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md b/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md new file mode 100644 index 00000000..3db5fee1 --- /dev/null +++ b/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md @@ -0,0 +1,23 @@ +--- +title: DeleteDefectdojoProduct +weight: 20 +--- + + +{{< alert level="info" >}} +Running this action requires a token — an API v2 Key for the user on whose behalf the action will be run. +{{< /alert >}} + +DeleteDefectdojoProduct — deletes a product from DefectDojo. The action uses the DefectDojo API v2. + +### Request example + +```yaml +id: 1 +``` + +### Request specification + +| Name | Required | Description | Default value | +| ------------- | -------- | ------------------------------------------------ | ------------------------ | +| id | Yes | Identifier of the product to delete | - | diff --git a/content/documentation/admin/actions/gitlab/_index.md b/content/documentation/admin/actions/gitlab/_index.md new file mode 100644 index 00000000..46d8b304 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/_index.md @@ -0,0 +1,4 @@ +--- +title: Gitlab +weight: 20 +--- diff --git a/content/documentation/admin/actions/gitlab/creategitlabbranches.md b/content/documentation/admin/actions/gitlab/creategitlabbranches.md new file mode 100644 index 00000000..603770c9 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabbranches.md @@ -0,0 +1,32 @@ +--- +title: CreateGitlabBranches +weight: 40 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabBranches — creates new branches in the target repository. + +### Request example + +```yaml +project_id: '0' +branches: + - branch: new-branch + ref: main +``` + +### Request specification + +| Name | Required | Description | +| ----------------- | -------- | -------------------------------------------------------------------------------- | +| project_id | Yes | Identifier of the project in which to create the branches | +| branches | Yes | List of branches to create | +| branches.branch | Yes | Name of the new branch | +| branches.ref | Yes | Name of an existing branch or a commit SHA hash | + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/repository/branches`. Upon successful creation, GitLab returns information about the created branches. diff --git a/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md b/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md new file mode 100644 index 00000000..9856cf29 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md @@ -0,0 +1,32 @@ +--- +title: CreateGitlabGroupVariables +weight: 80 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabGroupVariables — creates group-level variables in GitLab. + +### Request example + +```yaml +group_id: '0' +variables: + - key: EXAMPLE_VARIABLE + value: value +``` + +### Request specification + +| Name | Required | Description | +| ----------------- | -------- | ---------------------------------------------------------------------------------- | +| group_id | Yes | Identifier of the group in which to create the variables | +| variables | Yes | List of variables to create | + +The field list for variables corresponds to the official GitLab Group-level Variables API, `/groups/:id/variables`, for more information see [the GitLab documentation](https://docs.gitlab.com/api/group_level_variables/#create-variable). + +### Note + +The action performs a POST request to the URL: `/api/v4/groups/:id/variables`. diff --git a/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md b/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md new file mode 100644 index 00000000..34b2f9f1 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md @@ -0,0 +1,62 @@ +--- +title: CreateGitlabMergeRequest +weight: 70 +--- + +{{< alert level="info" >}} +Running this action requires credentials: + +- `password` — the password (token) of the user on whose behalf the action will be run. +- `username` — the username on whose behalf the action will be run. +{{< /alert >}} + +CreateGitlabMergeRequest — creates a new Merge Request (MR) in the target repository. Files stored in the source repository are added to the Merge Request. Files may contain variables whose values will be substituted at the time the MR is created. + +### Request example + +```yaml +source_project_id: '0' +source_project_branch: example +source_project_tag: v1.0.0 +target_project_id: '0' +merge_request_spec: + source_branch: example + target_branch: '1' + title: example +additionalIgnoreFiles: + - .ignore + - .example +values: + key1: value1 + nested: + enabled: true + subkey: 123 +``` + +### Request specification + +| Name | Required | Description | Default value | +| ------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | +| source_project_id | Yes | Identifier of the project that serves as the source for the Merge Request | - | +| target_project_id | Yes | Identifier of the target project in which the Merge Request will be created | - | +| merge_request_spec | Yes | Specification matching the [GitLab Merge Requests API](https://docs.gitlab.com/ee/api/merge_requests.html#create-mr) | - | +| source_project_tag | No | Tag in the source project from which the Merge Request will be created. If not specified, the source project's branch is used | - | +| source_project_branch | No | Branch in the source project from which the Merge Request will be created | main | +| additionalIgnoreFiles | No | List of files containing paths to exclude from the MR. Populated similarly to [.templateignore](createrepositoryfromtemplate/#templateignore) | - | +| values | No | Variables used during templating, in `key: value` format | - | + +### How it works + +The platform: + +1. Clones the template repository used to generate the MR, based on its identifier (`source_project_id`). For more information, see [Implementation details](createrepositoryfromtemplate/#implementation-details). +1. Reads the `values.yaml` file stored at the root of the repository and determines the default templating variables. +1. Reads the variables passed when the action is launched and merges them with the variables from `values.yaml`. Variables passed at launch take priority. +1. Reads the `.templateignore` file and determines the directories and files excluded from templating. +1. Renders the files from the templates, taking into account `values.yaml` and the variables passed to the action. +1. Changes the remote of the repository to the target one, according to its ID (`target_project_id`), and performs a git push to the branch in the source project (`source_project_branch`), or to the `main` branch. +1. Creates an MR according to the specified settings by sending a POST request to the GitLab API. + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/merge_requests`. diff --git a/content/documentation/admin/actions/gitlab/creategitlabproject.md b/content/documentation/admin/actions/gitlab/creategitlabproject.md new file mode 100644 index 00000000..7c7e571d --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabproject.md @@ -0,0 +1,36 @@ +--- +title: CreateGitlabProjecte +weight: 20 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabProject — creates a new project in GitLab. The action calls the GitLab API to create a project with the specified parameters, such as name, project path, description, and other settings. A GitLab token, which must be provided in the credentials, is used for authentication. + +### Request example + +```yaml +name: example +path: example +description: example +default_branch: main +initialize_with_readme: false +namespace_id: '0' +``` + +### Request specification + +| Name | Required | Description | Default value | +| ------------------------ | -------- | ---------------------------------------------------------------------------------------- | ----------------------- | +| name | Yes | Name of the project to be created in GitLab | - | +| path | Yes | URL-friendly project path. Usually matches the name, but may differ | - | +| default_branch | Yes | Name of the branch to be used by default, e.g. "main" | - | +| namespace_id | Yes | Identifier of the GitLab namespace in which the project will be created | - | +| initialize_with_readme | No | Flag indicating whether the project should be initialized with a README file | false | +| description | No | Project description visible to users | - | + +### Note + +The action performs a POST request to the URL: `/api/v4/projects`, sending the request parameters in JSON format. Upon successful creation, GitLab returns data about the newly created project. diff --git a/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md b/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md new file mode 100644 index 00000000..16608389 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md @@ -0,0 +1,32 @@ +--- +title: CreateGitlabGroupVariables +weight: 90 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabProjectVariables — creates project-level variables in GitLab. + +### Request example + +```yaml +project_id: '0' +variables: + - key: EXAMPLE_VARIABLE + value: value +``` + +### Request specification + +| Name | Required | Description | +| ----------------- | -------- | ---------------------------------------------------------------------------------- | +| project_id | Yes | Identifier of the project in which to create the variables | +| variables | Yes | List of variables to create | + +The field list for variables corresponds to the official GitLab Project-level CI/CD variables API, `/projects/:id/variables`, for more information see [the GitLab documentation](https://docs.gitlab.com/api/project_level_variables/#create-a-variable). + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/variables`. diff --git a/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md b/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md new file mode 100644 index 00000000..07bd9a01 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md @@ -0,0 +1,36 @@ +--- +title: CreateGitlabProjectWebhook +weight: 30 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabProjectWebhook — creates a webhook in a GitLab project. + +### Request example + +```yaml +project_id: '0' +url: https://example.com +push_events: true +issues_events: true +merge_requests_events: true +pipeline_events: true +``` + +### Request specification + +| Name | Required | Description | +| ----------------------- | ------------------ | ----------------------------------------------------------------- | +| project_id | Yes | Identifier of the project in which to create the webhook | +| url | Yes | Webhook URL | +| push_events | Yes | Trigger the webhook on push to the repository | +| issues_events | Yes | Trigger the webhook when an Issue is created | +| merge_requests_events | Yes | Trigger the webhook when a Merge Request is created | +| pipeline_events | Yes | Trigger the webhook when a Pipeline is run | + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/hooks`. diff --git a/content/documentation/admin/actions/gitlab/creategitlabrelease.md b/content/documentation/admin/actions/gitlab/creategitlabrelease.md new file mode 100644 index 00000000..06aa435f --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabrelease.md @@ -0,0 +1,35 @@ +--- +title: CreateGitlabRelease +weight: 60 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabRelease — creates a GitLab release based on an existing tag. + +### Request example + +```yaml +project_id: '0' +tag_name: v1.0.0 +name: Release v1.0.0 +description: | + ## Changes: + - New feature. + - Bug fixes. +``` + +### Request specification + +| Name | Required | Description | +| -------------- | -------- | ------------------------------------------------------------------------------------------------ | +| project_id | Yes | Identifier of the project in which to create the release | +| tag_name | Yes | Name of the existing tag on which the release will be based | +| name | Yes | Name of the release as displayed in GitLab | +| description | No | Release description in Markdown format | + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/releases`. diff --git a/content/documentation/admin/actions/gitlab/creategitlabtag.md b/content/documentation/admin/actions/gitlab/creategitlabtag.md new file mode 100644 index 00000000..8484bd8a --- /dev/null +++ b/content/documentation/admin/actions/gitlab/creategitlabtag.md @@ -0,0 +1,32 @@ +--- +title: CreateGitlabTag +weight: 50 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +CreateGitlabTag — creates a new tag in a GitLab project. + +### Request example + +```yaml +project_id: '0' +tag_name: v1.0.0 +ref: main +message: Tag description +``` + +### Request specification + +| Name | Required | Description | +| ---------------------- | -------- | ------------------------------------------------------------------------------------ | +| project_id | Yes | Identifier of the project in which to create the tag | +| tag_name | Yes | Name of the tag | +| ref | Yes | Name of the branch, a tag, or a commit SHA hash the new tag will point to | +| message | Yes | Tag description | + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/repository/tags`. diff --git a/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md b/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md new file mode 100644 index 00000000..c964dc21 --- /dev/null +++ b/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md @@ -0,0 +1,396 @@ +--- +title: CreateRepositoryFromTemplate +weight: 10 +--- + +{{< alert level="info" >}} +Running this action requires credentials: + +- `password` — the password (token) of the user on whose behalf the action will be run. +- `username` — the username on whose behalf the action will be run. +{{< /alert >}} + +CreateRepositoryFromTemplate — creates a new repository from a template in GitLab. The rendering mechanism is based on [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax) and supports all built-in methods, as well as extensions added by the platform. + +### Request example + +```yaml +sourceBranch: main +sourceTag: v1.0.0 +templateRepositoryUrl: https://gitlab.example.com/example-1.git +targetRepositoryUrl: https://gitlab.example.com/example-2.git +targetBranch: master +additionalIgnoreFiles: + - .ignore + - .example +values: + key1: value1 + nested: + enabled: true + subkey: 123 +``` + +### Request specification + +| Name | Required | Description | Default value | +| -------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- | +| templateRepositoryUrl | Yes | URL of the template repository | - | +| targetRepositoryUrl | Yes | URL of the repository to be created as a result of running the action | - | +| values | Yes | Variables used during templating, in `key: value` format | - | +| additionalIgnoreFiles | No | List of files containing paths to exclude from the target repository. Populated similarly to [.templateignore](#templateignore) | - | +| sourceTag | No | Tag of the template repository to use during templating. If not specified, the template repository's branch is used | - | +| sourceBranch | No | Branch of the template repository to use during templating | main | +| targetBranch | No | Branch of the target repository to be created as a result of running the action | main | + +### How it works + +The platform: + +1. Clones the template repository from the specified URL (`templateRepositoryUrl`), using `sourceTag`, `sourceBranch`, or the `main` branch as the ref, in that order of preference. +1. Reads the `values.yaml` file stored at the root of the repository and determines the default templating variables. +1. Reads the variables passed when the action is launched and merges them with the variables from `values.yaml`. Variables passed at launch take priority during the merge. +1. Reads the `.templateignore` file and determines the directories and files excluded from templating. +1. Renders the files from the templates, taking into account `values.yaml` and the variables passed to the action. +1. Changes the remote of the repository to the target one (`targetRepositoryUrl`) and pushes to the target branch (`targetBranch`) or to the `main` branch. + +### Implementation details + +The action supports templating of directory and file names. To do this, add an expression in [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax) format to their name. +For example, the directory `src/{{ .module }}/utils`, given a `module` value of `example`, will be rendered as the directory `src/example/utils` in the target repository. + +If, after rendering from the template, a file's content is empty, the file is not created. For example, a file with the following content: + +```go +{{- if .createContent }} +- This is content that will be displayed if the createContent variable == true +{{- end }} +``` + +will not be created if the `createContent` variable is `false`. Similarly, files that are originally empty will not be created either. + +If templating variables are missing from both the `values.yaml` file and the variables passed when the action is launched, rendering fails with an error and the target repository is not created. + +### Template repository variables + +To add default variables used during templating, create a `values.yaml` file with the appropriate content at the root of the repository. + +Example `values.yaml` file: + +```yaml +module: example +createContent: false +``` + +The `values.yaml` file is optional. + + + +### Excluding files + +Some files may contain variables in [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax) format that need to be preserved when rendering the repository from a template, for example Helm charts in the `helm` directory. The `.git` directory is always ignored. + +To exclude such files from the rendering mechanism, add a `.templateignore` file with the appropriate content to the root of the repository. + +Each line of `.templateignore` defines a single rule — a path or a mask. If the line contains `{{`, the entire line is executed as a single Go template with the same variables and functions used when substituting into file and directory names (for more information, see [How a rule line is processed](#templateignore-templates)). If the line does not contain `{{`, no substitution of variables from `values.yaml` or from the action's request is performed: the line is read as-is and compared with the relative path on disk; literals and the mask characters `*` and `**` are allowed. + +Example of a `.templateignore` file containing only path masks, without substitution templates, to ignore the contents of the `helm` and `docs` directories: + +```sh +helm/** +docs/** +``` + +#### Adding paths to ignore + +1. At the root of the template repository, create or edit the `.templateignore` file (one rule per line). +1. Each line is a single rule: a path from the repository root. Regular path characters and masks are allowed: an asterisk `*` within a segment name, and the sequence `**` for arbitrary directory nesting. The platform matches the relative path against the mask according to built-in rules (similar to common conventions used for masks in ignore files in version control systems). +1. To substitute a path fragment from `values.yaml` or from the `values` field of the action's request, use Go template constructs (`{{ ... }}`) in the line. If the line contains `{{`, the platform processes the entire line from start to finish as a single Go template: you cannot leave part of the line as "plain text" and template only the middle of the path. See examples in [Go template examples in .templateignore](#templateignore-go-examples). +1. Empty lines and lines starting with `#` are skipped when parsing the file — you can use them for comments. + +#### Examples without substitution (path masks only) + +Individual files at the root: + +```sh +package-lock.json +yarn.lock +LICENSE +.env.local +``` + +Entire directories and typical build artifacts: + +```sh +vendor/** +node_modules/** +dist/** +build/tmp/** +``` + +Nesting with a mask: + +```sh +docs/**/*.pdf +charts/*/values.schema.json +.github/workflows/** +``` + +Secrets by extension across the entire tree: + +```sh +**/*.pem +**/*.key +``` + + + +#### How a rule line is processed + +The variables available for expanding rules are the same ones merged from `values.yaml` at the root of the template repository and from the `values` field in the action's request (the `values` field in the request takes priority). + +For each non-empty line from `.templateignore` or from a file listed in `additionalIgnoreFiles`, the platform does the following. + +1. The line is always added to the rule list exactly as it appears in the file, unchanged. This is the line that is compared with the file path first — this is needed for cases where the on-disk names still contain fragments like `{{ .module }}` before renaming. +1. If the line contains `{{`, the platform runs the entire line once through the [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax) engine, with the same capabilities used when substituting into file and directory names (built-in platform functions and the Sprig set). If the line does not contain `{{`, this step is skipped. +1. If the substitution step was performed and the resulting text differs from the line in the file (including the case where the result is empty), a second entry is added to the rule list — with this resulting text. As a result, a single line in the file can produce two entries in the list. When checking a file path, both are checked: a match with either one is enough for the file to be covered by the rule. + +Then, while traversing the tree, for each file path, the path relative to the root of the cloned copy is calculated (with forward slashes). The path is compared against each rule: first using mask-matching rules (including `*` and `**`), and, if necessary, by an exact match between the rule string and the relative path. + +This way, a single line in the file can define two rules: for example, the original `charts/{{ .name }}/**` (so as not to affect the path before directories are renamed), and the expanded `charts/billing/**` (to match the path after variable substitution into on-disk names). This is why the rules work both "before" and "after" the directory-renaming step of the template. + +If the template in a line has a syntax error or references a missing field, rule expansion fails with an error, and repository rendering does not continue. + +The `additionalIgnoreFiles` field in the action specifies the names of additional files at the root of the repository; each of them contains rule lines just like `.templateignore`, with the same template expansion. However, the meaning is different: matched paths are removed from the working copy (the directory or file is deleted), and this is done twice — at the beginning and at the end of the processing chain — so that these objects do not participate in further steps and do not end up in the resulting repository. + +The `.templateignore` file, on the other hand, means "do not template": for matched paths, the platform does not substitute variables into file contents and does not apply template-based renaming to the corresponding directory paths. The files and directories themselves are not deleted just because of an entry in `.templateignore` — they remain in the copy, but are processed as plain text and plain names, without the templating step. + + + +#### Go template examples in .templateignore + +Each example below shows fragments of `values.yaml` (or the equivalent fields in the request's `values`) and lines from `.templateignore`. Several independent rules are defined by several lines in the file: the result of one template line is one masked line; line breaks within the template's result do not split the rule into several. + +The directory name in the rule comes from `values.yaml` or from the action's `values`: + +`values.yaml`: + +```yaml +project: payment-gateway +``` + +`.templateignore`: + +```go +{{ .project }}/legacy/** +``` + +The rule set will include the lines `{{ .project }}/legacy/**` and `payment-gateway/legacy/**`. + +A path segment from a variable and a fixed part that is preserved after the variable's value is substituted: + +`values.yaml`: + +```yaml +lang: ru +``` + +`.templateignore`: + +```go +apps/{{ .lang }}/messages.yaml +``` + +A conditional rule on a single line works as follows: when `skipGenerated: false`, the substitution produces an empty string, which is still added as a second rule. The original line with `{{` is used as a path mask and usually does not match any real paths. When `skipGenerated: true`, the second rule becomes `generated/**`: + +`values.yaml`: + +```yaml +skipGenerated: false +``` + +`.templateignore`: + +```go +{{- if .skipGenerated }}generated/**{{- end }} +``` + +A variant for "ignore only non-production": + +`values.yaml`: + +```yaml +tier: staging +``` + +`.templateignore`: + +```go +{{- if ne .tier "prod" }}mock/**{{- end }} +``` + +Using `printf` to build a mask string (convenient when the chart name is a variable): + +`values.yaml`: + +```yaml +chartName: wordpress +``` + +`.templateignore`: + +```go +{{ printf "charts/%s/**" .chartName }} +``` + +A default value for an "empty" value — the `default` function from the Sprig set. The field must exist in the data (otherwise expansion will fail with `missingkey=error`); for "not set in YAML", add a key with an empty string, or use the `if` / `index` construct: + +`values.yaml`: + +```yaml +envName: "" +``` + +`.templateignore`: + +```go +{{ default "dev" .envName }}/secrets/** +``` + +With an empty `envName`, the rule set will include both `{{ default "dev" .envName }}/secrets/**` and `dev/secrets/**`. + +An optional path segment ([`with`](https://pkg.go.dev/text/template#hdr-Actions)): + +`values.yaml`: + +```yaml +analyticsModule: tracking +``` + +`.templateignore`: + +```go +{{ with .analyticsModule }}{{ . }}/vendor/**{{ end }} +``` + +If `analyticsModule` is empty, the template produces an empty string (the expansion rules are described above). + +Accessing a nested structure's field by a string key ([`index`](https://pkg.go.dev/text/template#hdr-Functions)): + +`values.yaml`: + +```yaml +regions: + primary: eu-west +``` + +`.templateignore`: + +```go +configs/{{ index .regions "primary" }}/bootstrap.yaml +``` + +Trimming whitespace from a name segment — the `trim` function from the Sprig set: + +`values.yaml`: + +```yaml +serviceName: " billing-api " +``` + +`.templateignore`: + +```go +{{ trim .serviceName " " }}/logs/** +``` + +Several fragments in a single mask: + +`values.yaml`: + +```yaml +base: services +variant: canary +``` + +`.templateignore`: + +```go +{{ .base }}/{{ .variant }}/**/*.tmp +``` + +#### Examples for additionalIgnoreFiles + +The action's specification lists the names of files at the root of the repository (for example, `.ship-ignore`, `.ci-remove`). The line format inside such files is the same: `#` comments, empty lines, path masks, and, if needed, Go templates in lines. + +The `.ship-ignore` file in the template: + +```sh +# excluded from the target repository +local/fixtures/** +scratchpad.md +``` + +Fragment of the action's request: + +```yaml +additionalIgnoreFiles: + - .ship-ignore +``` + +A template in a file used with `additionalIgnoreFiles` (removing a directory, with the name coming from variables): + +The `.env-drop` file at the root of the template: + +```go +{{ .obsoleteDir }}/** +``` + +With `obsoleteDir: legacy-ui` from `values`, after expansion, the deletion list will contain both `{{ .obsoleteDir }}/**` and `legacy-ui/**` — matching paths will be removed from the copy before the final steps. + +{{< alert level="info" >}} +Note the difference: +- `.templateignore` leaves files on disk but disables path renaming and content rendering for them; +- lists from `additionalIgnoreFiles` remove matched paths from the working copy. +{{< /alert >}} + +### Example directory structure of a template repository + +```sh +├── example-folder-01 +│ ├── example-file-01 +│ └── {{ .example }}-file-02 +├── {{ .example }}-folder-02 +│ └── ... +├── values.yaml +└── .templateignore +``` + +If the `example` variable is set to `new` when the repository is rendered, the resulting structure after rendering will look as follows: + +```sh +├── example-folder-01 +│ ├── example-file-01 +│ └── new-file-02 +├── new-folder-02 +│ └── ... +├── values.yaml +└── .templateignore +``` + + + +### Local debugging + +The `ddp-render-dir` utility is available for local debugging of templates. + +The utility: + +1. Creates a copy of the source directory. +1. Renders the files in this directory using the same rules as the action that creates repositories from templates. + +Command-line flags for running it: + +* `--source-dir` — the source directory to render. +* `--target-dir` — the directory where the rendering result will be placed. +* `--values` (optional) — path to a `values.yaml` file with variables to use during rendering. +* `--ignore-files` (optional) — a list of files containing paths to exclude from the target repository. diff --git a/content/documentation/admin/actions/gitlab/deletegitlabproject.md b/content/documentation/admin/actions/gitlab/deletegitlabproject.md new file mode 100644 index 00000000..472fa23c --- /dev/null +++ b/content/documentation/admin/actions/gitlab/deletegitlabproject.md @@ -0,0 +1,26 @@ +--- +title: StartGitlabPipeline +weight: 110 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +DeleteGitlabProject — deletes an existing project in GitLab. The action calls the GitLab API to delete the project. A GitLab token, which must be provided in the credentials, is used for authentication. + +### Request example + +```yaml +project_id: 0 +``` + +### Request specification + +| Name | Required | Description | +| --------------------------- | -------- | -------------------------------------------------------- | +| project_id | Yes | Identifier of the project to delete | + +### Note + +The action performs a DELETE request to the URL: `/api/v4/projects/:id`. diff --git a/content/documentation/admin/actions/gitlab/startgitlabpipeline.md b/content/documentation/admin/actions/gitlab/startgitlabpipeline.md new file mode 100644 index 00000000..0836c14e --- /dev/null +++ b/content/documentation/admin/actions/gitlab/startgitlabpipeline.md @@ -0,0 +1,34 @@ +--- +title: StartGitlabPipeline +weight: 100 +--- + +{{< alert level="info" >}} +Running this action requires the token of the user on whose behalf it will be run. +{{< /alert >}} + +StartGitlabPipeline — starts a pipeline run in GitLab. + +### Request example + +```yaml +project_id: 0 +ref: main +variables: + - key: example-key + value: example-value +``` + +### Request specification + +| Name | Required | Description | +| --------------------------- | -------- | ---------------------------------------------------------------------------------- | +| project_id | Yes | Identifier of the project in which to run the pipeline | +| ref | Yes | Name of the branch, a tag, or a commit SHA hash on which the pipeline will run | +| variables | No | List of variables to pass to the pipeline being run | +| variables.key | Yes | Variable name | +| variables.value | Yes | Variable value | + +### Note + +The action performs a POST request to the URL: `/api/v4/projects/:id/pipeline`. diff --git a/content/documentation/admin/actions/kafka/_index.md b/content/documentation/admin/actions/kafka/_index.md new file mode 100644 index 00000000..e7176dd1 --- /dev/null +++ b/content/documentation/admin/actions/kafka/_index.md @@ -0,0 +1,4 @@ +--- +title: Apache Kafka +weight: 40 +--- diff --git a/content/documentation/admin/actions/kafka/createkafkaacls.md b/content/documentation/admin/actions/kafka/createkafkaacls.md new file mode 100644 index 00000000..8a16cf0e --- /dev/null +++ b/content/documentation/admin/actions/kafka/createkafkaacls.md @@ -0,0 +1,109 @@ +--- +title: CreateKafkaACLs +weight: 50 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `user` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +CreateKafkaACLs — creates a set of ACLs in Kafka. + +### Request example + +```yaml +securityProtocol: SASL_PLAINTEXT +saslMechanism: PLAIN +acls: + - topics: + - example_1 + allow: + - User:principal_2 + - Group:principal_3 + deny: + - User:principal_4 + - Group:principal_5 + ops: + - CREATE + - READ + - WRITE + - DELETE + - DESCRIBE + - DESCRIBE_CONFIGS + - ALTER + pattern: LITERAL + - topics: + - example_6 + allow: + - User:principal_7 + allow_hosts: + - 127.0.0.1 + deny: + - User:principal_8 + deny_hosts: + - 127.0.0.1 + ops: + - CREATE + pattern: LITERAL +``` + +### Request specification + +| Name | Required | Description | Possible values | Default value | +| ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------ | +| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | +| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | +| acls | Yes | Set of ACLs to create | - | - | +| acls.ops | Yes | List of operations for which the rule will be created | [List of possible operations](#list-of-possible-operations) | - | +| acls.pattern | Yes | Pattern type | [List of possible patterns](#list-of-possible-patterns) | - | +| acls.topics | No | List of topic names to which the rule applies | - | - | +| acls.groups | No | List of group names to which the rule applies | - | - | +| acls.transactional_ids | No | List of transaction IDs to which the rule applies | - | - | +| acls.tokens | No | List of tokens to which the rule applies | - | - | +| acls.allow | No | List of principals (user, group) for which the rule is allowed | - | - | +| acls.deny | No | List of principals (user, group) for which the rule is denied | - | - | +| acls.hosts | No | List of hosts for which the operation is allowed | - | - | +| acls.deny_hosts | No | List of hosts for which the operation is denied | - | - | + +### List of possible patterns + +* ANY. +* MATCH. +* LITERAL. +* PREFIXED. + +### List of possible operations + +For more information, see [the Kafka documentation](https://kafka.apache.org). + +Topics: + +* ALL. +* ALTER. +* ALTER_CONFIGS. +* CREATE. +* DELETE. +* DESCRIBE. +* DESCRIBE_CONFIGS. +* READ. +* WRITE. + +Group: + +* ALL. +* DELETE. +* DESCRIBE. +* READ. + +TransactionalID: + +* ALL. +* DESCRIBE. +* WRITE. + +Tokens: + +* DESCRIBE. diff --git a/content/documentation/admin/actions/kafka/createkafkatopics.md b/content/documentation/admin/actions/kafka/createkafkatopics.md new file mode 100644 index 00000000..a14cc114 --- /dev/null +++ b/content/documentation/admin/actions/kafka/createkafkatopics.md @@ -0,0 +1,37 @@ +--- +title: CreateKafkaTopics +weight: 10 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `user` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +CreateKafkaTopics — creates new topics in Kafka. + +### Request example + +```yaml +securityProtocol: SASL_PLAINTEXT +saslMechanism: PLAIN +partitions: 1 +replication_factor: 1 +configs: {} +topics: + - example_1 + - example_2 +``` + +### Request specification + +| Name | Required | Description | Possible values | +| -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | +| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| partitions | Yes | Number of partitions the topic will be split into | - | +| replication_factor | Yes | Number of copies (replicas) of each topic partition to place on different brokers | - | +| configs | Yes | Key-value configuration for the topics being created | Values are listed [in the Kafka documentation](https://kafka.apache.org/documentation/#topicconfigs) | +| topics | Yes | List of topic names to create | - | diff --git a/content/documentation/admin/actions/kafka/createkafkausers.md b/content/documentation/admin/actions/kafka/createkafkausers.md new file mode 100644 index 00000000..151c0ab4 --- /dev/null +++ b/content/documentation/admin/actions/kafka/createkafkausers.md @@ -0,0 +1,41 @@ +--- +title: CreateKafkaUsers +weight: 30 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `user` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +CreateKafkaUsers — creates new SASL/SCRAM users in Kafka. + +### Request example + +```yaml +securityProtocol: SASL_PLAINTEXT +saslMechanism: PLAIN +users: + - user: example_user_1 + password: example_password_user_1 + mechanism: SCRAM-SHA-256 + iterations: 4096 + - user: example_user_2 + password: example_password_user_2 + mechanism: SCRAM-SHA-256 + iterations: 4096 +``` + +### Request specification + +| Name | Required | Description | Possible values | +| ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| users | Yes | Set of users to create | - | +| users.user | Yes | Name of the user to create | - | +| users.password | Yes | Password of the user to create | - | +| users.mechanism | Yes | Authentication mechanism of the user to create | SCRAM-SHA-256, SCRAM-SHA-512 | +| users.iterations | Yes | Number of iterations used for password hashing | From 4096 to 16384 | diff --git a/content/documentation/admin/actions/kafka/deletekafkaacls.md b/content/documentation/admin/actions/kafka/deletekafkaacls.md new file mode 100644 index 00000000..1c1ed916 --- /dev/null +++ b/content/documentation/admin/actions/kafka/deletekafkaacls.md @@ -0,0 +1,127 @@ +--- +title: DeleteKafkaACLs +weight: 60 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `user` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +DeleteKafkaACLs — deletes a set of ACLs in Kafka. + +### Request example + +```yaml +securityProtocol: SASL_PLAINTEXT +saslMechanism: PLAIN +acls: + - topics: + - example_1 + allow: + - User:principal_2 + - Group:principal_3 + allow_hosts: + - 127.0.0.1 + deny: + - User:principal_4 + - Group:principal_5 + deny_hosts: + - 127.0.0.1 + ops: + - CREATE + - READ + - WRITE + - DELETE + - DESCRIBE + - DESCRIBE_CONFIGS + - ALTER + pattern: LITERAL + - any_topic: true + any_group: true + any_transactional_id: true + any_allow: true + any_allow_hosts: true + any_deny: true + any_deny_hosts: true + ops: + - ANY + pattern: ANY + - any_resource: true + any_allow: true + any_allow_hosts: true + any_deny: true + any_deny_hosts: true + ops: + - ANY + pattern: ANY +``` + +### Request specification + +| Name | Required | Description | Possible values | Default value | +| --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------ | +| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | +| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | +| acls | Yes | Set of ACLs to delete | - | - | +| acls.ops | Yes | List of operations for which the rule will be deleted | [List of possible operations](#list-of-possible-operations) | - | +| acls.pattern | Yes | Pattern type | [List of possible patterns](#list-of-possible-patterns) | - | +| acls.any_resource | No | All resources | - | false | +| acls.topics | No | List of topic names to which the rule applies | - | - | +| acls.any_topic | No | All topics | - | false | +| acls.groups | No | List of group names to which the rule applies | - | - | +| acls.any_group | No | All groups | - | false | +| acls.transactional_ids | No | List of transaction IDs to which the rule applies | - | - | +| acls.any_transactional_id | No | Any transaction | - | false | +| acls.tokens | No | List of tokens to which the rule applies | - | - | +| acls.any_token | No | All tokens | - | false | +| acls.allow | No | List of principals (user, group) for which the rule is allowed | - | - | +| acls.any_allow | No | Any principal (user, group) | - | false | +| acls.allow_hosts | No | List of hosts for which the operation is allowed | - | - | +| acls.any_allow_hosts | No | Any host from which the operation is allowed | - | false | +| acls.deny | No | List of principals (user, group) for which the rule will be denied | - | - | +| acls.any_deny | No | Any principal (user, group) | - | false | +| acls.deny_hosts | No | List of hosts for which the operation will be denied | - | - | +| acls.any_deny_hosts | No | Any host from which the operation is denied | - | false | + +### List of possible patterns + +* ANY. +* MATCH. +* LITERAL. +* PREFIXED. + +### List of possible operations + +For a detailed description, see [the Kafka documentation](https://kafka.apache.org/39/documentation/#operations_resources_and_protocols). + +Topics: + +* ALL. +* ALTER. +* ALTER_CONFIGS. +* CREATE. +* DELETE. +* DESCRIBE. +* DESCRIBE_CONFIGS. +* READ. +* WRITE. + +Group: + +* ALL. +* DELETE. +* DESCRIBE. +* READ. + +TransactionalID: + +* ALL. +* DESCRIBE. +* WRITE. + +Token: + +* DESCRIBE. diff --git a/content/documentation/admin/actions/kafka/deletekafkatopics.md b/content/documentation/admin/actions/kafka/deletekafkatopics.md new file mode 100644 index 00000000..99de53c7 --- /dev/null +++ b/content/documentation/admin/actions/kafka/deletekafkatopics.md @@ -0,0 +1,31 @@ +--- +title: DeleteKafkaTopics +weight: 20 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `user` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +DeleteKafkaTopics — deletes existing topics in Kafka. + +### Request example + +```yaml +securityProtocol: SASL_PLAINTEXT +saslMechanism: PLAIN +topics: + - example_1 + - example_2 +``` + +### Request specification + +| Name | Required | Description | Possible values | +| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| topics | Yes | List of topic names to delete | - | diff --git a/content/documentation/admin/actions/kafka/deletekafkausers.md b/content/documentation/admin/actions/kafka/deletekafkausers.md new file mode 100644 index 00000000..3d946ea8 --- /dev/null +++ b/content/documentation/admin/actions/kafka/deletekafkausers.md @@ -0,0 +1,35 @@ +--- +title: DeleteKafkaUsers +weight: 40 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `user` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +DeleteKafkaUsers — deletes existing SASL/SCRAM users in Kafka. + +### Request example + +```yaml +securityProtocol: SASL_PLAINTEXT +saslMechanism: PLAIN +users: + - user: example_user_1 + mechanism: SCRAM-SHA-256 + - user: example_user_2 + mechanism: SCRAM-SHA-256 +``` + +### Request specification + +| Name | Required | Description | Possible values | +| ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | +| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| users | Yes | Set of users to delete | - | +| users.user | Yes | Name of the user to delete | - | +| users.mechanism | Yes | Authentication mechanism of the user to delete | SCRAM-SHA-256, SCRAM-SHA-512 | diff --git a/content/documentation/admin/actions/keycloak/_index.md b/content/documentation/admin/actions/keycloak/_index.md new file mode 100644 index 00000000..c5c27fb0 --- /dev/null +++ b/content/documentation/admin/actions/keycloak/_index.md @@ -0,0 +1,4 @@ +--- +title: Keycloak +weight: 70 +--- diff --git a/content/documentation/admin/actions/keycloak/createkeycloakclient.md b/content/documentation/admin/actions/keycloak/createkeycloakclient.md new file mode 100644 index 00000000..35016ac0 --- /dev/null +++ b/content/documentation/admin/actions/keycloak/createkeycloakclient.md @@ -0,0 +1,40 @@ +--- +title: CreateKeycloakClient +weight: 10 +--- + + +{{< alert level="info" >}} +Running this action requires credentials: +* `username` — the username on whose behalf the action will be run. +* `password` — the password of the user on whose behalf the action will be run. +{{< /alert >}} + +CreateKeycloakClient — creates a new client in Keycloak. + +### Request example + +```yaml +realm: master +config: + clientId: example + name: example + enabled: true + clientAuthenticatorType: client-secret + secret: secret + defaultClientScopes: + - roles + - profile + - email + optionalClientScopes: + - address + - phone + - offline_access +``` + +### Request specification + +| Name | Required | Description | Possible values | +| ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| realm | Yes | Realm in Keycloak in which to create the client | - | +| config | Yes | Parameters of the client to create, according to the [Keycloak ClientRepresentation specification](https://www.keycloak.org/docs-api/latest/rest-api/index.html#ClientRepresentation) | - | diff --git a/content/documentation/admin/actions/kubernetes/_index.md b/content/documentation/admin/actions/kubernetes/_index.md new file mode 100644 index 00000000..8c99576d --- /dev/null +++ b/content/documentation/admin/actions/kubernetes/_index.md @@ -0,0 +1,4 @@ +--- +title: Kubernetes +weight: 60 +--- diff --git a/content/documentation/admin/actions/kubernetes/createkubernetesresource.md b/content/documentation/admin/actions/kubernetes/createkubernetesresource.md new file mode 100644 index 00000000..8823e1cb --- /dev/null +++ b/content/documentation/admin/actions/kubernetes/createkubernetesresource.md @@ -0,0 +1,31 @@ +--- +title: CreateKubernetesResource +weight: 10 +--- + + +{{< alert level="info" >}} +Running this action requires a Kubernetes service account token. +{{< /alert >}} + +CreateKubernetesResource — creates one or more new resources in a Kubernetes cluster, or updates existing ones. + +### Request example + +```yaml +manifests: + - apiVersion: v1 + kind: Namespace + metadata: + name: example1 + - apiVersion: v1 + kind: Namespace + metadata: + name: example2 +``` + +### Request specification + +| Name | Required | Description | +| ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------- | +| manifests | Yes | Kubernetes manifests to be applied | diff --git a/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md b/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md new file mode 100644 index 00000000..b56bcfc8 --- /dev/null +++ b/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md @@ -0,0 +1,30 @@ +--- +title: DeleteKubernetesResource +weight: 30 +--- + +{{< alert level="info" >}} +Running this action requires a Kubernetes service account token. +{{< /alert >}} + +DeleteKubernetesResource — deletes an existing resource in a Kubernetes cluster. + +### Request example + +```yaml +group: apps +version: v1 +resource_type: deployments +resource_name: nginx-deployment +namespace: example +``` + +### Request specification + +| Name | Required | Description | Possible values | +| --------------------------- | ----------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| group | Yes | API group of the resource. Specifies which API group the object being deleted belongs to | [Determining the required Group and Version](getkubernetesresource/#determining-the-required-group-and-version) | +| version | Yes | API version of the resource | [Determining the required Group and Version](getkubernetesresource/#determining-the-required-group-and-version) | +| resource_type | Yes | Type of the resource to delete | pods, services, deployments, statefulsets, daemonsets, replicasets, jobs, cronjobs, nodes, namespaces, configmaps, secrets, persistentvolumes, persistentvolumeclaims, limitranges, resourcequotas, horizontalpodautoscalers, ingresses, networkpolicies, serviceaccounts, roles, clusterroles, rolebindings, clusterrolebindings, podsecuritypolicies, storageclasses, volumeattachments, events, endpoints, customresourcedefinitions | +| resource_name | Yes | Name of the specific resource to delete | - | +| namespace | Yes | Namespace in which the resource is located | - | diff --git a/content/documentation/admin/actions/kubernetes/getkubernetesresource.md b/content/documentation/admin/actions/kubernetes/getkubernetesresource.md new file mode 100644 index 00000000..c72b6bdb --- /dev/null +++ b/content/documentation/admin/actions/kubernetes/getkubernetesresource.md @@ -0,0 +1,84 @@ +--- +title: GetKubernetesResource +weight: 20 +--- + + +{{< alert level="info" >}} +Running this action requires a Kubernetes service account token. +{{< /alert >}} + +GetKubernetesResource — retrieves a resource from a Kubernetes cluster. + +### Request example + +```yaml +group: managed-services.deckhouse.io +version: v1alpha1 +resource_type: postgres +resource_name: example-postgres +namespace: default +``` + +### Request specification + +| Name | Required | Description | Possible values | +| --------------------------- | -------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | +| group | Yes | API group of the resource. Specifies which API group the requested object belongs to | [Determining the required Group and Version](#determining-the-required-group-and-version) | +| version | Yes | API version of the resource | [Determining the required Group and Version](#determining-the-required-group-and-version) | +| resource_type | Yes | Type of the resource to retrieve | - | +| resource_name | Yes | Name of the specific resource to retrieve | - | +| namespace | Yes | Namespace in which the resource is located | - | + +### Response + +On success, the action returns the resource object in the `resource` field. If the resource is not found, the action fails with an error. + +| Name | Description | +| ------------ | --------------------------------------------------- | +| `resource` | Resource object in Kubernetes format | + +### Determining the required Group and Version + +Each resource type corresponds to its own API group (Group) and version (Version). +The full list of API resources with their groups and versions is provided [in the Kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/). + +If you don't know which API groups and versions are required, you can use current values. +There are several ways to determine them: + +#### Using the `d8 k` utility + +The `d8 k explain` command shows the `apiVersion` for a resource. + +Example: + +```bash +d8 k explain deployment +``` + +Example output: + +```yaml +GROUP: apps +KIND: Deployment +VERSION: v1 + +DESCRIPTION: + Deployment enables declarative updates for Pods and ReplicaSets. + +FIELDS: +... +``` + +#### Using the documentation + +1. Find the resource you need (for example, Deployment). +1. The API Group and version are specified in the header. Example for Deployment: + + ```yaml + apiVersion: apps/v1 + ``` + + Here: + * "API Group" is apps; + * "Version" is v1. diff --git a/content/documentation/admin/actions/nexus/_index.md b/content/documentation/admin/actions/nexus/_index.md new file mode 100644 index 00000000..7b359971 --- /dev/null +++ b/content/documentation/admin/actions/nexus/_index.md @@ -0,0 +1,4 @@ +--- +title: Nexus Repository +weight: 80 +--- diff --git a/content/documentation/admin/actions/nexus/assignnexusprivilege.md b/content/documentation/admin/actions/nexus/assignnexusprivilege.md new file mode 100644 index 00000000..5211a0bc --- /dev/null +++ b/content/documentation/admin/actions/nexus/assignnexusprivilege.md @@ -0,0 +1,37 @@ +--- +title: AssignNexusPrivilege +weight: 40 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +AssignNexusPrivilege — assigns privileges to an existing role in Nexus Repository Manager 3. The action retrieves the role's current configuration and merges its existing privileges with the new ones. + +### Request example + +```yaml +roleId: example-role +privileges: + - example-privilege + - another-privilege +``` + +### Request specification + +| Field | Required | Description | +| ------------ | ----------------- | ------------------------------------------------------------------------------ | +| roleId | Yes | Identifier of the role to which privileges are assigned | +| privileges | Yes | List of privilege names to assign to the role | + +### How it works + +1. Retrieves the role's current configuration from Nexus. +1. Merges the role's existing privileges with the new privileges from the request. +1. Updates the role with the merged list of privileges. + +### Note + +The role must exist in Nexus before privileges can be assigned. If the role is not found, the action fails with an error. All specified privileges must also exist in Nexus. diff --git a/content/documentation/admin/actions/nexus/assignnexusrole.md b/content/documentation/admin/actions/nexus/assignnexusrole.md new file mode 100644 index 00000000..0863e9bb --- /dev/null +++ b/content/documentation/admin/actions/nexus/assignnexusrole.md @@ -0,0 +1,37 @@ +--- +title: AssignNexusRole +weight: 70 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +AssignNexusRole — assigns roles to an existing user in Nexus Repository Manager 3. The action retrieves the user's current configuration and merges its existing roles with the new ones. + +### Request example + +```yaml +userId: example-user +roles: + - example-role + - another-role +``` + +### Request specification + +| Field | Required | Description | +| -------- | ----------------- | ----------------------------------------------------------------------- | +| userId | Yes | Identifier of the user to which roles are assigned | +| roles | Yes | List of role identifiers to assign to the user | + +### How it works + +1. Retrieves the user's current configuration from Nexus. +1. Merges the user's existing roles with the new roles from the request. +1. Updates the user with the merged list of roles. + +### Note + +The user must exist in Nexus before roles can be assigned. If the user is not found, the action fails with an error. All specified roles must also exist in Nexus. diff --git a/content/documentation/admin/actions/nexus/createnexusprivilege.md b/content/documentation/admin/actions/nexus/createnexusprivilege.md new file mode 100644 index 00000000..43240528 --- /dev/null +++ b/content/documentation/admin/actions/nexus/createnexusprivilege.md @@ -0,0 +1,67 @@ +--- +title: CreateNexusPrivilege +weight: 30 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +CreateNexusPrivilege — creates a new privilege in Nexus Repository Manager 3. Privileges define access rights to repositories and other Nexus resources. + +### Request example (repository-view) + +```yaml +name: example-privilege +description: Example privilege description +type: repository-view +actions: + - READ + - BROWSE +format: maven2 +repository: maven-releases +``` + +### Request example (repository-content-selector) + +```yaml +name: content-selector-privilege +description: Privilege with content selector +type: repository-content-selector +actions: + - READ +format: maven2 +repository: maven-releases +contentSelector: my-content-selector +``` + +### Request example (wildcard) + +```yaml +name: wildcard-privilege +description: Wildcard privilege +type: wildcard +pattern: nx-* +actions: + - READ +``` + +### Request specification + +| Field | Required | Description | +| ----------------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| name | Yes | Name of the privilege to create. Must be unique within Nexus | +| description | No | Privilege description | +| type | Yes | Privilege type: `repository-view`, `repository-content-selector`, `repository-admin`, `application`, `wildcard` | +| actions | No | List of actions allowed by the privilege (e.g., `READ`, `BROWSE`, `CREATE`, `UPDATE`, `DELETE`) | +| format | No | Repository format (e.g., `maven2`, `docker`, `npm`). Used for the `repository-view`, `repository-content-selector`, `repository-admin` types | +| repository | No | Repository name. Used for the `repository-view`, `repository-content-selector`, `repository-admin` types | +| contentSelector | No | Content selector name. Required for the `repository-content-selector` type. If not specified or invalid, the type is automatically converted to `repository-view` | +| pattern | No | Pattern for the `wildcard` type | +| domain | No | Domain for the `application` type | +| attributes | No | Additional key-value parameters | + +### Note + +For the `repository-content-selector` type, the content selector must exist in Nexus before the privilege is created. If the content selector is not specified or is invalid, the action automatically converts the privilege type to `repository-view`. diff --git a/content/documentation/admin/actions/nexus/createnexusrepository.md b/content/documentation/admin/actions/nexus/createnexusrepository.md new file mode 100644 index 00000000..72545a19 --- /dev/null +++ b/content/documentation/admin/actions/nexus/createnexusrepository.md @@ -0,0 +1,81 @@ +--- +title: CreateNexusRepository +weight: 10 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +`CreateNexusRepository` — creates a new repository of any supported type (maven, docker, npm, etc.) in Nexus Repository Manager 3 using the REST API. +Format, type, and other key settings are fully configurable and match the Nexus API. + +### Request example (Maven hosted) + +```yaml +description: | + Maven hosted repo for internal Java build artifacts. +name: my-maven-repo +format: maven +type: hosted +online: true +storage: + blobStoreName: default + strictContentTypeValidation: true + writePolicy: ALLOW +cleanup: + policyNames: + - maven-cleanup +maven: + versionPolicy: RELEASE + layoutPolicy: PERMISSIVE +``` + +### Request example (Docker group) + +```yaml +description: | + Docker group repo aggregating hosted+proxy. +name: my-docker-group +format: docker +type: group +online: true +storage: + blobStoreName: default + strictContentTypeValidation: true +group: + memberNames: + - docker-hosted + - docker-proxy +docker: + v1Enabled: false + forceBasicAuth: true + httpPort: 5001 +``` + +### Request specification + +| Field | Required | Description | Example | +| ------------- | ------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------ | +| description | No | Documentation on the purpose of this action/repository. Not used by Nexus itself, only for the UI | - | +| name | Yes | Name of the repository to create. Must be unique within Nexus | my-maven-repo | +| format | Yes | Format (`maven`, `docker`, `npm`, `raw`, etc.) | maven | +| type | Yes | Type: `hosted`, `proxy`, or `group` | hosted | +| online | Yes | Whether the repository is available (`true`/`false`) | true | +| storage | Yes | Storage object: `blobStoreName`, `strictContentTypeValidation`, `writePolicy` | [Example](#request-example-maven-hosted) | +| cleanup | No | Linked cleanup policies (`policyNames`) | policyNames: [maven-cleanup] | +| maven | For maven | Maven-only: `versionPolicy`, `layoutPolicy` | [Example](#request-example-maven-hosted) | +| proxy | For proxy | Proxy repository: `remoteUrl`, `contentMaxAge`, `metadataMaxAge` | - | +| group | For group | List of `memberNames` values | [Example](#request-example-docker-group) | +| docker | For docker | Docker-specific parameters: `httpPort`, `v1Enabled`, `forceBasicAuth` | [Example](#request-example-docker-group) | +| component | Very rare | Only for certain non-standard scenarios | - | +| attributes | No | Any custom fields | - | + +### Requirements + +- Only use the blocks (`maven`, `group`, `proxy`, `docker`, etc.) that are supported for your type/format. +- For maven hosted, `maven: {versionPolicy, layoutPolicy}` is required. +- For group, `group.memberNames` is required. +- For proxy, `proxy.remoteUrl` is required. +- For docker, specify the docker-specific fields in `docker`. diff --git a/content/documentation/admin/actions/nexus/createnexusrole.md b/content/documentation/admin/actions/nexus/createnexusrole.md new file mode 100644 index 00000000..06db96f4 --- /dev/null +++ b/content/documentation/admin/actions/nexus/createnexusrole.md @@ -0,0 +1,33 @@ +--- +title: CreateNexusRole +weight: 60 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +CreateNexusRole — creates a new role in Nexus Repository Manager 3. Roles combine privileges and can include other roles. + +### Request example + +```yaml +id: example-role +name: Example Role +description: Example role description +privileges: + - nx-repository-view-*-*-read + - nx-repository-view-maven2-*-browse +roles: [] +``` + +### Request specification + +| Field | Required | Description | +| ------------- | ----------------- | ------------------------------------------------------------------------------ | +| id | Yes | Unique role identifier | +| name | Yes | Role name | +| description | No | Role description | +| privileges | No | List of privilege names assigned to the role | +| roles | No | List of other role identifiers included in this role | diff --git a/content/documentation/admin/actions/nexus/createnexususer.md b/content/documentation/admin/actions/nexus/createnexususer.md new file mode 100644 index 00000000..49d4f6c0 --- /dev/null +++ b/content/documentation/admin/actions/nexus/createnexususer.md @@ -0,0 +1,36 @@ +--- +title: CreateNexusUser +weight: 90 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +CreateNexusUser — creates a new user in Nexus Repository Manager 3. + +### Request example + +```yaml +userId: example-user +firstName: First +lastName: Last +emailAddress: user@example.com +password: password +status: active +roles: + - nx-admin +``` + +### Request specification + +| Field | Required | Description | +| ------------- | ----------------- | ------------------------------------------------------------------------------ | +| userId | Yes | Unique user identifier | +| firstName | Yes | User's first name | +| lastName | Yes | User's last name | +| emailAddress | Yes | User's email address | +| password | Yes | User's password | +| status | Yes | User status: `active` or `disabled` | +| roles | No | List of role identifiers assigned to the user at creation | diff --git a/content/documentation/admin/actions/nexus/deletenexusprivilege.md b/content/documentation/admin/actions/nexus/deletenexusprivilege.md new file mode 100644 index 00000000..7ae2236d --- /dev/null +++ b/content/documentation/admin/actions/nexus/deletenexusprivilege.md @@ -0,0 +1,23 @@ +--- +title: DeleteNexusPrivilege +weight: 50 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +DeleteNexusPrivilege — deletes a privilege from Nexus Repository Manager 3. + +### Request example + +```yaml +name: example-privilege +``` + +### Request specification + +| Field | Required | Description | +| ------ | ----------------- | ---------------------------------------------- | +| name | Yes | Name of the privilege to delete | diff --git a/content/documentation/admin/actions/nexus/deletenexusrepository.md b/content/documentation/admin/actions/nexus/deletenexusrepository.md new file mode 100644 index 00000000..11f45aad --- /dev/null +++ b/content/documentation/admin/actions/nexus/deletenexusrepository.md @@ -0,0 +1,29 @@ +--- +title: DeleteNexusRepository +weight: 20 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +`DeleteNexusRepository` — deletes an existing repository from Nexus Repository Manager 3. + +### Request example + +```yaml +name: my-repo-to-delete +``` + +### Request specification + +| Field | Required | Description | +| ------ | ----------------- | ------------------------------------------------ | +| `name` | Yes | Name of the repository to delete | + +### Algorithm + +- Performs a `DELETE` request to `/service/rest/v1/repositories/{name}`, where `{name}` is the value of the `name` field. +- If the repository is found and deleted, a 204 is returned. +- If it is not found, a 404 error is returned. diff --git a/content/documentation/admin/actions/nexus/deletenexusrole.md b/content/documentation/admin/actions/nexus/deletenexusrole.md new file mode 100644 index 00000000..8317e8e5 --- /dev/null +++ b/content/documentation/admin/actions/nexus/deletenexusrole.md @@ -0,0 +1,23 @@ +--- +title: DeleteNexusRole +weight: 80 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +DeleteNexusRole — deletes a role from Nexus Repository Manager 3. + +### Request example + +```yaml +id: example-role +``` + +### Request specification + +| Field | Required | Description | +| ------ | ----------------- | --------------------------------------------- | +| id | Yes | Identifier of the role to delete | diff --git a/content/documentation/admin/actions/nexus/deletenexususer.md b/content/documentation/admin/actions/nexus/deletenexususer.md new file mode 100644 index 00000000..1d0b0df5 --- /dev/null +++ b/content/documentation/admin/actions/nexus/deletenexususer.md @@ -0,0 +1,23 @@ +--- +title: DeleteNexusUser +weight: 100 +--- + + +{{< alert level="info" >}} +Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +{{< /alert >}} + +DeleteNexusUser — deletes a user from Nexus Repository Manager 3. + +### Request example + +```yaml +userId: example-user +``` + +### Request specification + +| Field | Required | Description | +| -------- | ----------------- | ------------------------------------------------------ | +| userId | Yes | Identifier of the user to delete | diff --git a/content/documentation/admin/actions/overview.md b/content/documentation/admin/actions/overview.md new file mode 100644 index 00000000..5c55c92a --- /dev/null +++ b/content/documentation/admin/actions/overview.md @@ -0,0 +1,364 @@ +--- +title: Overview +description: Action configuration in Deckhouse Development Platform (DDP) — requests, form, entity updates, security, and authorization. +weight: 10 +--- + +Actions are a platform mechanism for running operations in external infrastructure systems and services. With actions, for example, you can: + +- create projects, variables, branches, tags, releases, and merge requests in [GitLab](../gitlab/); +- create resources in [Kubernetes](../kubernetes/) and retrieve them; +- create secrets in [Deckhouse Stronghold and HashiCorp Vault](../vault/), as well as clients in [Keycloak](../keycloak/); +- create projects in [SonarQube](../sonarqube/), products and engagements in [DefectDojo](../defectdojo/), projects in [CodeScoring](../codescoring/), and repositories, roles, users, and privileges in [Nexus Repository](../nexus/); +- create topics and ACLs in [Apache Kafka](../kafka/); +- perform helper actions for debugging and controlling process execution (for example, [Debug](../debug/) and [Wait](../wait/)). + +An action can be linked to one or more resources. Once linked, it can be run for any entity of those resources. + +## Action configuration + +### Basic information + +When creating or editing an action, specify the basic information: + +| Field | Required | Description | +| ----------------- | -------- | -------------------------------------------------------------------------------------------- | +| Name | Yes | Arbitrary name of the action | +| Identifier | Yes | Action identifier. Generated automatically from the name | +| Resource | No | One or more resources for which the action will be available to run | +| Icon | No | Icon displayed on the action card | +| Owner | No | User account responsible for the action's configuration and operation | +| Owner team | No | Team responsible for the action's configuration and operation | +| Tags | No | Tags used to classify and search for actions | +| Description | No | Description in Markdown. Displayed when running the action or a process that contains it | + +### Request configuration + +#### Action type + +An action can be of the following types: + +- "Built-in" — the action's execution logic is described inside the platform. For built-in actions, you must select one of the preconfigured backends. +- "Webhook" — the action's execution logic is fully configured by the user. + +#### Retry parameters + +If an action fails, the platform can automatically retry it. + +##### Number of retries + +How many times to retry execution after a failure. 0 means a single attempt with no retries. + +##### Base delay (sec.) + +The delay in seconds before the first retry; the pause doubles before each subsequent attempt (exponential backoff). + +#### Request body format + +For webhook actions, you can choose the format used to send the request body: + +- JSON (default) — the request body is sent in JSON format with the `Content-Type: application/json` header. +- "Form URL Encoded" — the request body is sent in `application/x-www-form-urlencoded` format. + +{{< alert level="info" >}} +When "Form URL Encoded" is selected, the request body must contain only flat key-value pairs. Nested structures and arrays are not supported in this format. +{{< /alert >}} + +Example: + +```yaml +token: {{ .credentials.token }} +``` + +#### Extended logging + +For webhook actions, you can enable an extended logging option that provides detailed logging of all HTTP request and response details: + +- request URL; +- HTTP method; +- HTTP headers (including tokens); +- request body; +- response status code; +- response HTTP headers; +- response body. + +When this option is enabled, all this data is written to the action run log. When it is disabled, logging works in standard mode. + +{{< alert level="warning" >}} +Enabling extended logging may result in sensitive information (tokens, passwords, etc.) being written to the logs. Use this option with caution and only when needed for debugging. +{{< /alert >}} + +#### Request body + +Each action sends an HTTP request to a built-in backend or to a webhook backend URL. The request usually includes a request body (`body`) that describes what exactly will be sent. The request body is defined in YAML. + +Parameter values from the user form can be substituted into the request body using [Go template](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) templates. + +Example: + +```yaml +project_id: {{ .property.project_id }} +``` + +With this request body, the expression `{{ .property.project_id }}` is replaced with the value of the `project_id` parameter that the user entered in the action's launch form. + +For built-in action types, the "Request body" parameter is part of the action's configuration, and a sample of this configuration is available. + +### User form + +#### Parameters + +The "User form" section specifies the parameters that the user can fill in when launching the action. Parameter types are described in the [Parameters](../../user/properties/) section. + +The following options are available for each parameter: + +- "Editable" — allows the parameter value to be changed when launching the action. If this option is disabled, the value cannot be changed. +- "Required" — requires a value to be specified when launching the action. +- "Hidden" — the parameter is not displayed in the user form when launching the action. + +Each parameter can have a default value that is pre-filled in the form when the action is launched. + +{{< alert level="info" >}} +For non-editable or hidden parameters, it is recommended to set a default value, since the user will not be able to change them when launching the action. +{{< /alert >}} + +The parameter description is shown when launching the action by clicking the "info" icon button. It is recommended to fill it in to make it easier to understand the purpose of the parameters and reduce the risk of errors when launching the action. + +Parameter values can use [Go template](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) template functions. For example, the expression `{{ .entity.name }}` in a parameter value means that when the action is launched, the name of the entity it is running for will be substituted. + +#### Parameter conditions + +Parameters can be automatically hidden or shown in the user form depending on the value of a `Boolean`-type parameter. This is configured in the "Parameter conditions" section, where you define rules for showing or hiding selected parameters. + +### Update + +#### Templating contexts + +All updates are performed only after the action completes successfully. The following templating contexts are available in Go templates: + +| Context | Description | Example | +| ----------- | --------------------------------------------------------------------------- | ------------------------------------- | +| `.property` | Values from the user form | `{{ .property.repo }}` | +| `.response` | Parsed action response (JSON) | `{{ .response.id }}` | +| `.entity` | Parameters of the catalog entity for which the action is run | `{{ .entity.slug }}` | +| `.workflow` | Workflow parameters | `{{ .workflow.branch }}` | +| `.process` | Process parameters | `{{ .process.releaseId }}` | +| `.global` | Global variables (variable set identifier, then key) | `{{ .global.myGroup.apiUrl }}` | +| `.team` | Variables of the team selected at launch | `{{ .team.token }}` | +| `.store` | Variables from the process store | `{{ .store.myKey }}` | + +#### Entity parameter update + +If the "Update entity parameters" option is enabled, the platform applies the update rules and writes the values to the entity's parameters. + +| Field | Description | +| ------------------- | ------------------------------------------------------------------------- | +| Source | Go template for the value | +| Entity parameter | Identifier of the entity parameter in the catalog | + +For example, when the "Create GitLab project" action is run, the response (`response`) will contain the specification of the created project: + +```json +{ + "id": "1", + "...": "..." +} +``` + +If you need to immediately populate the entity's `repository_id` parameter after creating a project in GitLab, specify the following update rule: + +1. Source: `{{ .response.id }}`. +1. Entity parameter: `repository_id`. + +#### Entity creation + +If the "Create entities" option is enabled, the platform automatically creates new entities in the selected resources according to the specified rules. Rules are defined separately for each resource. + +| Field | Description | +| ------------------------------------- | ---------------------------------------------------------------------------------------------- | +| Owner of created entities | Assigned as the owner of all entities the action creates in the catalog | +| Owner team of created entities | Assigned as the owner team of all entities the action creates in the catalog | +| Resource | Catalog resource in which the entity will be created | +| Source (identifier) | Go template for the identifier of the entity being created | +| Source (name) | Go template for the name of the entity being created | +| Additional rules | Mapping of a Go template value to an entity parameter | + +The identifier and name are required for each rule group. If a resource already has an entity with the same identifier, creation is skipped. + +For example, when the "Create GitLab project" action is run, the response may contain: + +```json +{ + "id": "42", + "name": "my-project", + "...": "..." +} +``` + +To create an entity in the "GitLab projects" resource after the action completes successfully, specify the following rules: + +1. Resource: "GitLab projects". +1. Source (identifier): `{{ .response.id }}`. +1. Source (name): `{{ .response.name }}`. + +If needed, add additional rules to populate entity parameters, for example map `{{ .response.path }}` to the `path` parameter. + +#### Entity relation creation + +If the "Create entity relations" option is enabled, the platform automatically creates new relations for the selected entity according to the specified rules. The set of rules is defined separately for each resource. + +| Field | Description | +| ------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Resource | Either of the two resources involved in the required resource relation: the list of relations in which the selected resource is specified as the parent or the child is loaded based on the selected resource. You can choose the resource of the entity for which the action is running, or the resource on the other side of the relation — the list will contain the same relation if both resources are part of it | +| Relation | The catalog resource relation: it defines the parent and child resources and entity roles when creating the relation. The selected relation determines which side the launch entity is on and which of the fields below specifies the identifier of the second entity from the action's response | +| Parent entity identifier | Go template for the identifier of the parent entity in the catalog | +| Child entity identifier | Go template for the identifier of the child entity in the catalog | + +#### User credentials update + +If the user credentials update option is enabled, the action automatically updates the user's credentials according to the update rules. + +| Field | Description | +| ------------------- | --------------------------------------- | +| Source | Go template for the value | +| Credentials type | Type of credentials to be updated | + +For example, when running an action that returns a new API key in its response: + +```json +{ + "apiKey": "new-api-key-12345", + "...": "..." +} +``` + +to update the credentials, specify the following update rules: + +1. Source: `{{ .response.apiKey }}`. +1. Credentials type: select the type of credentials to be updated. + +##### Selecting a user for credentials update + +By default, credentials are updated for the user who launched the action (the initiator). + +To update the credentials of a different user, enable the "Update credentials of a specific user" option and select the desired user. + +#### Process store update + +Rules from the "Process store update" section only apply when the action is run as part of a process: after the action completes successfully, values are written to the run's store according to the specified rules, in list order. + +| Field | Description | +| ----------- | -------------------------------------------------------------------------------------------------------------------- | +| Condition | An optional Go template; if empty, the rule always applies. Rendering result: `true`, `false`, `1`, or `0` | +| Operation | Write string, Write JSON, Append string, Append JSON, Merge JSON (shallow), Delete | +| Target | Dot-path in the store without a leading dot, e.g. `deploy.job_id` or `notification.items` | +| Source | Go template for the value | + +Other actions and process elements read this data via `{{ .store. }}`. Inside a loop, the `{{ .store._loop.* }}` context is available in templates. + +If there are no rules (the list is empty), nothing is written to the store when the action runs as part of a process. + +For a detailed description of operations, rule examples, iterating over a collection, and viewing the store, see [Process store](../processes/store/). + +### Security + +#### Execution conditions + +The action will only run if the entity's status matches one of the selected values in the status field. If no restrictions are set, this condition does not apply. + +#### Masking action fields + +For each action, you can enable masking of fields that may contain sensitive information. + +If this option is enabled, the following will be hidden in the action's run records: + +- values of all filled-in parameters; +- request body (`body`); +- response (`response`) generated as a result of execution. + +#### Temporary response + +For each action, you can enable the "Temporary response" option. It restricts access to the action's execution result and hides it from other users. + +If this option is enabled, after the action completes successfully, the response: + +- is stored as temporary and displayed only to the user who launched the action; +- is removed from the regular response field so that it is not accessible to other users. + +Other users will see only an encrypted placeholder instead of the response content. + +The action's initiator can delete the temporary response manually. + +{{< alert level="info" >}} +The temporary response is available only to the action's initiator. Other users cannot view its contents and cannot delete it. +{{< /alert >}} + +#### Approval + +You can enable mandatory approval for an action and specify the number of approvers required. In this case, the action will not run until the specified number of approvals has been received from the designated users. + +The current number of approvals and the list of users whose approval is expected are displayed in the action run table for the corresponding entity. + +If approval is required from a specific user, they will receive a notification in the web interface. + +#### Approval notifications + +When approval is enabled, you can enable notifications and specify how they are sent. If sending to a URL is selected, specify the webhook address, optionally disable the server's TLS certificate verification, and add additional HTTP request headers. + +### Authorization + +#### Use external service + +Selection of the external services for which the action can be run. If multiple external services are added, a specific one can be selected directly when launching the action. + +#### URL and HTTP headers + +The address to which the request will be sent, and the HTTP headers. + +Headers support Go templates in the form `{{ .credentials. }}` for substituting user credentials. + +#### Select an account to run as + +By default, external infrastructure services are accessed using the credentials of the user who launched the action. If needed, you can explicitly specify that the action should run on behalf of a specific account. + +For actions launched as automation events, specifying the account to run as is mandatory. + +#### Credentials + +For built-in actions, the platform predefines the set of required credentials. Their identifiers are loaded when the built-in backend is selected. For each identifier, you must select the type of credentials to be used. + +For webhook actions, credentials can be accessed in the request body using the `{{ .credentials. }}` construct. + +#### HTTP method + +For webhook actions, the HTTP method of the outgoing request is specified. + +## Action runs + +### Action run records + +Each time an action is run, a record is created containing the initiator, execution status, and a detailed log. Run records for each entity are available on the entity's card, on the "Action runs" tab. If the action requires approval, it is handled on the same tab. + +A run record can be deleted, or the action can be re-run. Re-running creates a new record. + +### Run logging + +For each action run, a record containing the full execution log is created in the database. + +The `actions.logging.enabled` parameter in the DDP configuration file controls whether run logs are output to `stdout`: when set to `true`, logs are output; when set to `false`, they are not. + +{{< alert level="info" >}} +Records with the full run log are created in the database regardless of the value of `actions.logging.enabled`. +{{< /alert >}} + +### Action run statuses + +For each action run, a record with a status is created. Possible statuses: + +- `Created` — the record has been created, but the action has not been run yet. +- `Unapproved` — the action is awaiting approval. +- `Running` — the action is running. +- `Failed` — the action finished with an error. +- `Update failed` — the action completed, but updating the entity's parameters failed. +- `Success` — the action completed successfully. +- `Retrying` — the action finished with an error and is being retried. diff --git a/content/documentation/admin/actions/sonarqube/_index.md b/content/documentation/admin/actions/sonarqube/_index.md new file mode 100644 index 00000000..094ef7df --- /dev/null +++ b/content/documentation/admin/actions/sonarqube/_index.md @@ -0,0 +1,4 @@ +--- +title: SonarQube +weight: 30 +--- diff --git a/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md b/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md new file mode 100644 index 00000000..ff81af02 --- /dev/null +++ b/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md @@ -0,0 +1,33 @@ +--- +title: CreateSonarqubeProject +weight: 10 +--- + +{{< alert level="info" >}} +Running this action requires a SonarQube token of the User Token type, generated by the user on whose behalf the action will be run. +{{< /alert >}} + +CreateSonarqubeProject — creates a new project in SonarQube. +The action uses the SonarQube Web API to create a project with the specified parameters, such as the project key, project name, main branch, new code definition parameters, and project visibility. Authentication is performed using a SonarQube token, which must be provided in the credentials. + +### Request example + +```yaml +project: example-project +name: example-project +mainBranch: develop +newCodeDefinitionType: NUMBER_OF_DAYS +newCodeDefinitionValue: '30' +visibility: public +``` + +### Request specification + +| Name | Required | Description | Possible values | Default value | +| ------------------------- | -------- | ----------------------------------------------------------------------------------------------- | ---------------------------------------------------- | ------------------------- | +| project | Yes | Unique project identifier (Project Key) in SonarQube | - | - | +| name | Yes | Project name displayed in the SonarQube interface | - | - | +| mainBranch | No | Name of the project's main branch | - | master | +| newCodeDefinitionType | No | Method for defining "new code" | PREVIOUS_VERSION, NUMBER_OF_DAYS, REFERENCE_BRANCH | - | +| newCodeDefinitionValue | No | Value for the "new code" definition (e.g., number of days, if the type is NUMBER_OF_DAYS) | - | - | +| visibility | No | Project visibility | private, public | private | diff --git a/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md b/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md new file mode 100644 index 00000000..82eb38bd --- /dev/null +++ b/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md @@ -0,0 +1,22 @@ +--- +title: DeleteSonarqubeProject +weight: 20 +--- + +{{< alert level="info" >}} +Running this action requires a SonarQube token of the User Token type, generated by the user on whose behalf the action will be run. +{{< /alert >}} + +DeleteSonarqubeProject — deletes a project from SonarQube. + +### Request example + +```yaml +project: example-project +``` + +### Request specification + +| Name | Required | Description | Default value | +| ------------------ | -------- | -------------------------------------------------------------------------------- | ------------------------ | +| project | Yes | Unique identifier (Project Key) of the project to delete | - | diff --git a/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md b/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md new file mode 100644 index 00000000..6a67ebf5 --- /dev/null +++ b/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md @@ -0,0 +1,30 @@ +--- +title: DeleteSonarqubeProjects +weight: 30 +--- + +{{< alert level="info" >}} +Running this action requires a SonarQube token of the User Token type, generated by the user on whose behalf the action will be run. +{{< /alert >}} + +DeleteSonarqubeProjects — deletes one or more projects from SonarQube. + +### Request example + +```yaml +analyzedBefore: 2017-10-19T13:00:00+0200 +onProvisionedOnly: 'false' +projects: example_project,another_project +q: example +qualifiers: TRK +``` + +### Request specification + +| Name | Required | Description | Possible values | Example values | +| -------------------- | -------- | ------------------------------------------------------------------------------------- | -------------------------------- | --------------------------------------- | +| analyzedBefore | No | Delete all projects whose last analysis is older than a specific date | - | 2017-10-19, 2017-10-19T13:00:00+0200 | +| onProvisionedOnly | No | Filter projects by the `onProvisionedOnly` value | true, false, yes, no | - | +| projects | No | List of project keys to delete | - | my_project, another_project | +| q | No | Delete all projects whose name or key contains the specified substring | - | example | +| qualifiers | No | Filter projects by the specified qualifiers | TRK, VW, APP | | diff --git a/content/documentation/admin/actions/vault/_index.md b/content/documentation/admin/actions/vault/_index.md new file mode 100644 index 00000000..ba34a237 --- /dev/null +++ b/content/documentation/admin/actions/vault/_index.md @@ -0,0 +1,4 @@ +--- +title: HashiCorp Vault +weight: 50 +--- diff --git a/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md b/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md new file mode 100644 index 00000000..67205a2c --- /dev/null +++ b/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md @@ -0,0 +1,55 @@ +--- +title: CreateVaultKubernetesAuthRole +weight: 30 +--- + +{{< alert level="info" >}} +Running this action requires a Vault token with permissions to create/update Kubernetes auth backend roles. +{{< /alert >}} + +CreateVaultKubernetesAuthRole — creates or updates a Kubernetes authentication role in HashiCorp Vault. + +### Request example + +```yaml +mountPath: kubernetes +role: example +bound_service_account_names: + - default +bound_service_account_namespaces: + - default +optional: + token_ttl: 1h + token_max_ttl: 12h + audience: vault + token_policies: + - default +``` + +### Request specification + +| Name | Required | Description | +| -------------------------------------- | -------- | ------------------------------------------------------------------------------------- | +| mountPath | Yes | Mount path of the Kubernetes auth backend in Vault (e.g., kubernetes) | +| role | Yes | Name of the role to create in Vault | +| bound_service_account_names | Yes | List of service account names allowed to access via this role | +| bound_service_account_namespaces | Yes | List of namespaces allowed to access via this role | +| optional | No | Additional role parameters (listed in the table below) | + +Supported values in optional: + +| Field | Type | Description | +| ------------------------- | --------------- | ----------------------------------------------------------------------- | +| token_ttl | string | Time-to-live (TTL) of the token issued at login | +| token_max_ttl | string | Maximum TTL of the token | +| token_policies | []string | Additional policies assigned at login | +| audience | string | Value of the JWT audience (aud) that Vault expects from the token | +| token_period | string | Token renewal period | +| token_explicit_max_ttl | string | Explicit upper bound on the token's TTL | +| token_num_uses | int | Limit on the number of times the token can be used | +| token_type | string | Type of token issued (e.g., service, batch) | +| alias_name_source | string | Source of the alias name for identity | +| token_no_default_policy | bool | Exclude the default policy from the token | +| token_bound_cidrs | []string | Restriction on the CIDR ranges from which the issued token can be used | + +The full list of supported parameters is provided in the official [HashiCorp Vault documentation](https://developer.hashicorp.com/vault/docs/auth/kubernetes#parameters). diff --git a/content/documentation/admin/actions/vault/createvaultsecret.md b/content/documentation/admin/actions/vault/createvaultsecret.md new file mode 100644 index 00000000..e0d8fee0 --- /dev/null +++ b/content/documentation/admin/actions/vault/createvaultsecret.md @@ -0,0 +1,41 @@ +--- +title: CreateVaultSecret +weight: 10 +--- + + +{{< alert level="info" >}} +Running this action requires a Vault token with the permissions needed to create secrets. +{{< /alert >}} + +CreateVaultSecret — creates a secret with one or more values in HashiCorp Vault. + +### Request example + +```yaml +path: example/data/path +secrets: + - key: key1 + value: value1 + - key: key2 + value: value2 +``` + +### Request specification + +| Name | Required | Description | Possible values | Default value | +| --------------------------- | -------- | ------------------------------------------------------------------- | ------------------------------------- | ----------------------- | +| path | Yes | Path at which the secret will be stored in Vault | | - | +| allow_update | No | Determines the action's behavior when creating or updating a secret | true, false, merge, merge_or_create | false | +| secrets | Yes | Set of secrets to create in Vault | | - | +| secrets.key | Yes | Name (identifier) of the secret | | - | +| secrets.value | Yes | Value of the secret | | - | + +### Note + +`allow_update` determines the action's behavior when creating or updating a secret: + +- `false` (default) — the action fails with an error if the secret already exists; +- `true` — a new version of the secret is created with the values passed to the action; +- `merge` — only the secret keys specified in the action are updated or created. Existing keys not mentioned in the action are preserved unchanged. If the secret does not yet exist at the path, the action fails with an error; +- `merge_or_create` — behaves like `merge` if the secret already exists; if the secret does not exist at the path, it is created (a full write of the values from the action). diff --git a/content/documentation/admin/actions/vault/deletevaultsecret.md b/content/documentation/admin/actions/vault/deletevaultsecret.md new file mode 100644 index 00000000..55da80fe --- /dev/null +++ b/content/documentation/admin/actions/vault/deletevaultsecret.md @@ -0,0 +1,23 @@ +--- +title: DeleteVaultSecret +weight: 20 +--- + + +{{< alert level="info" >}} +Running this action requires a Vault token with the permissions needed to create secrets. +{{< /alert >}} + +DeleteVaultSecret — deletes a secret from HashiCorp Vault. + +### Request example + +```yaml +path: example/data/path +``` + +### Request specification + +| Name | Required | Description | +| --------------------------- | -------- | ---------------------------------------------------------------------------------------------------- | +| path | Yes | Path at which the secret to be deleted is located in Vault | diff --git a/content/documentation/admin/actions/wait/_index.md b/content/documentation/admin/actions/wait/_index.md new file mode 100644 index 00000000..cc1ba228 --- /dev/null +++ b/content/documentation/admin/actions/wait/_index.md @@ -0,0 +1,4 @@ +--- +title: Wait +weight: 120 +--- diff --git a/content/documentation/admin/actions/wait/wait.md b/content/documentation/admin/actions/wait/wait.md new file mode 100644 index 00000000..96149b71 --- /dev/null +++ b/content/documentation/admin/actions/wait/wait.md @@ -0,0 +1,22 @@ +--- +title: Wait +weight: 10 +--- + +Wait waits for a specified number of seconds; a random addition to the duration (jitter) can optionally be applied. Intended for use in processes as a delay element, including for waiting until the results of a previous action have been applied. + +### Request example + +```yaml +duration_seconds: 10 +max_jitter_seconds: 0 +description: "Waiting for release" +``` + +### Request specification + +| Name | Required | Description | Default value | +| --------------------- | -------- | ------------------------------------------------------------------------------------- | ---------------------- | +| duration_seconds | Yes | Base wait duration in seconds (0–86400, i.e. up to 24 hours) | - | +| max_jitter_seconds | No | Maximum random addition to the wait time in seconds (0–N). 0 disables jitter | `0` | +| description | No | Description shown in the logs and the action's response | - | From 5f9ab63fb02a3f3b70e3ec0118aef60c192197a1 Mon Sep 17 00:00:00 2001 From: lada7878 Date: Wed, 5 Aug 2026 11:56:03 +0500 Subject: [PATCH 4/5] english version Signed-off-by: lada7878 --- .../documentation/admin/processes/_index.md | 4 + .../documentation/admin/processes/overview.md | 301 +++++++++ .../documentation/admin/processes/store.md | 227 +++++++ content/documentation/user/properties.md | 83 +++ content/documentation/user/templating.md | 623 ++++++++++++++++++ 5 files changed, 1238 insertions(+) create mode 100644 content/documentation/admin/processes/_index.md create mode 100644 content/documentation/admin/processes/overview.md create mode 100644 content/documentation/admin/processes/store.md create mode 100644 content/documentation/user/properties.md create mode 100644 content/documentation/user/templating.md diff --git a/content/documentation/admin/processes/_index.md b/content/documentation/admin/processes/_index.md new file mode 100644 index 00000000..d766fbbc --- /dev/null +++ b/content/documentation/admin/processes/_index.md @@ -0,0 +1,4 @@ +--- +title: Processes +weight: 35 +--- diff --git a/content/documentation/admin/processes/overview.md b/content/documentation/admin/processes/overview.md new file mode 100644 index 00000000..9c48ce56 --- /dev/null +++ b/content/documentation/admin/processes/overview.md @@ -0,0 +1,301 @@ +--- +title: Overview +weight: 10 +description: Creating and running processes — diagram elements, parameters, store, and execution management. +--- + +Processes are an automation mechanism for complex business scenarios that lets you build visual execution diagrams for actions, with support for conditional logic, parallel execution, and error handling. + +## Key concepts + +### Process elements + +A process consists of various types of elements: + +* "Start" — the process entry point. +* "Task" — runs a specific action. +* "Exclusive gateway" — conditional branching. +* "Parallel gateway" — merges several process branches into one. +* "Loop" — repeats part of the process a fixed number of times, or iterates over a JSON array from the store. +* "Template" — evaluates a Go template and writes the result to the process store. +* "Timer" — pauses until a specified point in time. +* "Note" — a text block. +* "Error" — immediately stops the process with the `Failed` status. +* "End" — completes the process. + +## Creating a process + +### Basic information + +To create a process, go to "Self-service" → "Processes" and click "Create". + +Fill in the following fields: + +* "Name" — the process name. +* "Description" — a detailed description of the process's purpose. +* "Resource" — one or more resources for which the process can be run. +* "Owner" — the user responsible for the process. +* "Owner team" — the team responsible for the process. +* "Tags" — tags used to categorize the process. +* "Icon" — the icon displayed in the interface. + +### Process configuration + +The process is configured in the visual editor, on the "Configuration" tab. + +{{< alert level="info" >}} +To configure a process, you must first fill in the basic fields and create it. After that, the "Configuration" and "Parameters" tabs become available. +{{< /alert >}} + +#### Adding elements + +To add elements to the diagram: + +1. Add an element by selecting its type in the editor panel. +1. Configure the element's parameters in the side panel (action, conditions, etc.). +1. Connect the elements to each other. + +#### Element types + +##### Task + +Each task runs a specific action previously created in "Self-service" → "Actions". + +##### Exclusive gateway + +An exclusive gateway lets you configure process branching based on conditions. By default, the status of the previous task is checked, and depending on it, execution follows the "success" or "failure" branch. + +As conditions for an exclusive gateway, you can set either a check of the previous task's status, or a comparison of values from templates: + +- To check the status of the previous task, use the construct `{{ .prev_task.status }}`. +- To check a value from the store, use `{{ .store. }}`, including nested keys: `{{ .store.notification.status }}`. +- Inside a loop — fields of the current item: `{{ .store._loop.item.scan_type }}`, and the flags `{{ .store._loop.first }}` and `{{ .store._loop.last }}`. + +You can check multiple conditions and combine their results using the `AND` or `OR` operator. + +If the condition check passes, the process follows the "True" branch (green); if not, it follows the "False" branch (red). The "True" and "False" ports can be placed on any side of the gateway; a connection can be moved to a different port. + +##### Parallel gateway + +Used to merge several branches into one, based on specified conditions. + +In the parallel gateway's configuration, you can set the following waiting parameters: + +- Wait for all incoming elements to complete before continuing execution. +- Wait for at least one incoming element to complete before continuing execution. + +You can also configure what exactly counts as "completion": + +- Only successful completion of the tasks feeding into the gateway. +- Any final status of the incoming tasks (`Failed`, `Skipped`, etc.). + +A parallel gateway can also be used to split branches, if connected after "Exclusive gateway" or "Loop" elements, or as a helper element to improve the readability of the process diagram. + +##### Loop + +The "Loop" element repeats a branch of the process either a fixed number of times, or once for each element of a JSON array from the store. Once all iterations are complete, the element connected to the loop's exit is activated. + +###### Loop mode + +Two modes are available: + +- "Fixed number" — the "Number of iterations" field, from 1 to 10000. On each iteration, `{{ .store._loop.item }}` holds the iteration number (1, 2, 3…). +- "By collection" — the "Collection template" field: a Go template that, when entering the loop, must produce a JSON array. Typically, this is a path to an array written by a previous task: `{{ .store.notification.engagements }}`. Each array element is one iteration; the current element is available as `{{ .store._loop.item }}`. + +If the array is empty or the key is missing, the loop body is not executed, and the process immediately follows the "Loop exit" connection. + +For more information, see [Process store](store/#looping-over-a-collection-from-the-store). + +###### Outgoing connections + +Exactly two connections to different elements must originate from the "Loop" element: + +1. "Loop body" — the branch built from this port is executed on each iteration. +1. "Loop exit" — execution continues along this branch after the last iteration. + +The "Loop body" and "Loop exit" ports can be placed on any side of the element; a connection can be moved to a different port. + +###### Usage + +Typical scenarios: + +- repeatedly checking the status of an external system with a fixed number of attempts; +- iterating over a list of objects from an API response: a task writes the array to the store, and a loop in "By collection" mode processes each element; +- nested loops — the parent context is available via `{{ .store._loop.parent }}`. + +##### Template + +The "Template" element evaluates a Go template without calling an additional action, and writes the result to the store as a string. + +Configure: + +- "Template body" — text with placeholders `{{ .store.* }}`, `{{ .process.* }}`, and, inside a loop, `{{ .store._loop.* }}`; +- "Store key" — the destination dot-path, e.g. `rendered_message`; +- "Format hint" — how to display the value when viewing the run (`text`, `markdown`, `html`, `json`); does not affect the store's content. + +For examples and limitations, see [Process store](store/#the-template-element). + +##### Timer + +The "Timer" element pauses process execution until a specified point in time, after which the next element is activated. + +While the process is only waiting for the timer to fire (no other active tasks), the run is placed in the "Wait" status. The run visualization panel shows a banner with the estimated resumption time. + +###### Outgoing connections + +Exactly one connection to the next element must originate from the "Timer" element. Connection is only possible through the left (input) and right (output) ports. + +If the timer is passed through again within the same run (for example, via a loop), the trigger time is recalculated. + +###### Schedule modes + +In the timer's configuration, select a "Schedule": + +- "Delay after entering the element" — a fixed pause from the moment the process reaches the timer. Set the "Delay (seconds)" from 1 to 1,209,600 (14 days). +- "Custom schedule" — triggers at a specified calendar time in the selected time zone (IANA, e.g. `Europe/Moscow`). + +For "Custom schedule" mode, specify a "Pattern": + +- "Specific day of the week" — "Day of the week", "Time of day" (hour and minute), "Time zone". +- "Specific day of each month" — "Day of month" (1–31), "Time of day", "Time zone". If the month does not have that day, the last day of the month is used. +- "Every N days" — "Every N days" (1–365), "Time of day", "Time zone". The first trigger is no earlier than N calendar days from the day the process reached the timer; upon re-entering the element, the calculation is redone. + +"Time of day" is set in the selected time zone (the "Time zone" field), if it differs from the browser's time zone. + +###### Usage + +Typical scenarios: a pause before re-checking the status of an external system, a delayed start of the next step, waiting for a maintenance window, or a regular calendar slot. + +##### Note + +The "Note" element is intended for text annotations on the process diagram: it is not executed at runtime and is not connected to other elements. + +In the note's configuration, you can set: + +- "Text" — content with Markdown support. +- "Background color" — the fill color. +- "Text color" — the text color. + +A note is always positioned behind other elements and can be used to visually highlight parts of the process. It is also the only element whose size can be changed. + +##### Error + +The "Error" element forcibly transitions a running process to the `Failed` status: when this element is reached, execution of all process actions is interrupted. + +No connections to subsequent elements should originate from this element. + +### Process parameters + +The "Parameters" tab is used to configure process parameters that can be used in all actions within the process. + +The configuration and use of process parameters are described in [Templating](../../user/templating/#process-parameters). + +### Process store + +The process store is a JSON object used to pass data between steps of a single run: identifiers, arrays, intermediate results, and text produced by the "Template" element. + +For a full description of write rules, operations, loop context, and example scenarios, see [Process store](store/). + +In brief: + +- **One store per run** — each process instance has its own store; it can be viewed on the "Store" tab when visualizing a run. +- **Nested paths** — keys are specified with dots: `notification.module_name`, `ctx.job.id`; array indices are supported: `items[0].status`. +- **Rule-based writes** — data is written to the store after an action completes successfully (see [Process store update](../../actions/overview/#process-store-update)), or when the "Template" element runs. Available operations include writing strings and JSON, appending, merging, and deleting, plus a condition for each rule. +- **Reading** — Go templates `{{ .store. }}` in action configuration and gateway conditions (see [Process store](../../user/templating/#process-store)). + +If a key is not present in the store, the template `{{ .store. }}` will cause the step to fail with an error. + +## Running a process + +### Manual run + +To run a process manually: + +1. Go to the entity for which the process needs to be run. +1. In the entity's menu, select "Run process". +1. Choose the desired process from the list. +1. Fill in the process parameters. +1. Click "Run". + +### Launch parameters + +The following are available when launching a process: + +* "Common process parameters" — parameters defined in the process configuration. +* "Action parameters" — parameters for each action in the process. +* "Environment variables" — additional variables for execution. + +## Execution management + +### Process statuses + +A process can be in one of the following statuses: + +* "Created" — the process has been created but not run. +* "Running" — the process is currently running. +* "Paused" — process execution has been paused. +* "Completed" — the process completed successfully. +* "Failed" — the process finished with an error. +* "Cancelled" — process execution was cancelled. + +### Management operations + +The following operations are available for active processes: + +* "Pause" — temporarily stop execution. +* "Resume" — continue execution after pausing. +* "Stop" — completely stop execution. +* "Force restart" — restart the process from the beginning. + +### State tracking + +In the "Process runs" section, you can view: + +* A list of all process runs for the entity. +* Detailed information about each run. +* Action execution logs. +* The status of each process element. +* The process execution timeline. +* The contents of the [process store](store/#viewing-the-store-during-execution) on the "Store" tab. + +#### Timeline + +The run visualization panel has a "Timeline" tab that shows the process execution history: for each element that participated in the current run, the start and end times, duration, and status are shown. + +#### Process log + +A detailed execution log is available for each process run: a panel on the run diagram, a separate window, or a dock at the bottom of the screen. The log and the store's JSON can be downloaded from the process run dialog panel. + +## Usage examples + +### Creating a configured project + +Typical process diagram: + +1. "Start" — starts the process. +1. "Task" — creates a project in GitLab. +1. "Exclusive gateway" — checks whether creation succeeded. +1. "Task" (on success) — configures the project's variables. +1. "Task" (on failure) — sends an error notification. +1. "End" — completes the process. + +### Deploying an application + +Typical process diagram: + +1. "Start" — starts the deployment process. +1. "Parallel gateway" — splits into branches. +1. "Task" (branch 1) — creates a namespace in Kubernetes. +1. "Task" (branch 2) — creates secrets in Vault. +1. "Parallel gateway" — waits for both branches to complete. +1. "Task" — deploys the application. +1. "End" — completes the process. + +## Limitations + +The following limitations apply to processes: + +* Processes cannot contain more than 100 elements. +* The maximum process execution time is 24 hours. +* The number of concurrent process runs is limited by system settings. +* Some actions may not be available for use in processes. diff --git a/content/documentation/admin/processes/store.md b/content/documentation/admin/processes/store.md new file mode 100644 index 00000000..98025f48 --- /dev/null +++ b/content/documentation/admin/processes/store.md @@ -0,0 +1,227 @@ +--- +title: Process store +description: Update rules, nested paths, write operations, loop context, and viewing the store during a process run. +weight: 20 +--- + +The process store is a JSON object shared by a single process run. Tasks use it to pass data to each other: identifiers, arrays for loop iteration, intermediate results, and generated text. + +Writing is done **only via rules** in the configuration of actions and "Template" elements. Reading is done via Go templates `{{ .store. }}` in the request body, gateway conditions, and other fields that support templating. + +## Data model + +- **One store per run** — each process instance has its own store; it is preserved between steps and available when viewing the run. +- **Nested paths** — keys are specified as dot-paths without a leading dot: `notification.module_name`, `ctx.job.id`. Intermediate objects are created automatically. +- **Array indices** — a path can reference an array element: `items[0].status`, `branches[2].name`. +- **Value types** — depending on the operation, strings, numbers, objects, and JSON arrays can end up in the store. The "Write string" and "Append string" operations always work with strings; operations with the JSON suffix store the parsed structure. + +{{< alert level="info" >}} +The service key `_loop` is populated by the process engine while a loop is running. Do not write to `_loop` manually using action rules — use it for reading in templates only. +{{< /alert >}} + +## Store update rules + +Rules are configured in the action: "Configuration" → "Update" → "Process store update". They run **after the action completes successfully**, **in list order**. Each subsequent rule sees the changes made by the previous rules of the same action. + +In the process task configuration, rules are shown in read-only mode; to change them, open the action from the task's side panel. + +### Rule fields + +| Field | Required | Description | +| ---- | -------------- | -------- | +| Condition | No | A Go template. An empty value means the rule always runs. After rendering, the result must be `true`, `false`, `1`, or `0`; otherwise the rule is skipped | +| Operation | Yes | The way the value at the "Target" path is changed | +| Target | Yes | Dot-path in the store, without a leading dot | +| Source | Yes* | Go template for the value. Not used for the "Delete" operation | + +### Operations + +| Operation | Result | +| -------- | --------- | +| Write string | Replaces the value at the path with the text string from the source; JSON is not parsed | +| Write JSON | Replaces the value with the parsed JSON (object, array, number, boolean) from the source template | +| Append string | Appends text to the existing string at the path; if the key doesn't exist, a string is created. Not applicable to numbers and arrays | +| Append JSON | Adds a single JSON item to the array at the path; if the array doesn't exist, an empty array is created | +| Merge JSON (shallow) | Merges the JSON object from the source with the object at the path: top-level keys are overwritten, nested objects are replaced entirely | +| Delete | Deletes the key at the path | + +For the **Write JSON**, **Append JSON**, and **Merge JSON** operations, it is convenient to use the `toJSON` function together with a direct reference to a response field, e.g. `{{ .response.items }}` — the platform will substitute the value without extra serialization. + +### Rule examples + +**Save an identifier from the action's response:** + +| Condition | Operation | Target | Source | +| ------- | -------- | ---- | -------- | +| | Write string | `deploy.job_id` | `{{ .response.id }}` | + +**Write an array for a subsequent loop:** + +| Condition | Operation | Target | Source | +| ------- | -------- | ---- | -------- | +| | Write JSON | `notification.engagements` | `{{ toJSON .response.engagements }}` | + +**Append a string to a log:** + +| Condition | Operation | Target | Source | +| ------- | -------- | ---- | -------- | +| | Append string | `run.log` | `step {{ .store._loop.index }}: ok\n` | + +**Update only part of an object:** + +| Condition | Operation | Target | Source | +| ------- | -------- | ---- | -------- | +| | Merge JSON (shallow) | `meta` | `{{ toJSON (dict "status" "ready" "updated_by" .entity.slug) }}` | + +**Run a rule only on the first loop iteration:** + +| Condition | Operation | Target | Source | +| ------- | -------- | ---- | -------- | +| `{{ .store._loop.first }}` | Write string | `run.started_at` | `{{ now }}` | + +**Delete a temporary key after use:** + +| Condition | Operation | Target | Source | +| ------- | -------- | ---- | -------- | +| | Delete | `temp.payload` | | + +### "Store paths" panel + +The action's rule editor has a **Store paths** panel: it shows the loop context keys (`_loop.item`, `_loop.index`, etc.). + +## Reading from the store + +In process templates, use: + +```go +{{ .store. }} +``` + +For nested fields, the path matches the "Target" in the write rules: + +```go +{{ .store.notification.module_name }} +{{ .store.items[0].id }} +``` + +Process launch parameters are available in a separate context: + +```go +{{ .process. }} +``` + +For more information on templating contexts, see [Templating](../../../user/templating/). + +{{< alert level="warning" >}} +If a key is not present in the store (the action has not yet run, the rule didn't fire, or the condition was false), the template `{{ .store. }}` will cause the step to fail with an error. Make sure preceding tasks have written the required data. +{{< /alert >}} + +## Loop context `_loop` + +While the loop body is running, the `_loop` object is available in the store: + +| Key | Description | +| ---- | -------- | +| `_loop.item` | The current collection item ("By collection" mode) or the iteration number, starting from 1 ("Fixed number" mode) | +| `_loop.index` | The iteration index, starting from 0 | +| `_loop.total` | The total number of iterations | +| `_loop.first` | `true` on the first iteration | +| `_loop.last` | `true` on the last iteration | +| `_loop.parent` | The parent loop's context, for nested loops | +| `_loop.loop_element_uuid` | The UUID of the "Loop" element | + +Examples in templates: + +```go +{{ .store._loop.item.name }} +{{ .store._loop.item.scan_type }} +{{ .store._loop.index }} +``` + +In exclusive gateway conditions inside a loop: + +```go +{{ eq .store._loop.item.branch .store.current_branch_tag }} +``` + +## Looping over a collection from the store + +The "Loop" element supports two modes (the "Loop mode" field): + +1. **Fixed number** — the body runs a specified number of times (1–10000). `_loop.item` holds the iteration number (1, 2, 3…). +1. **By collection** — when entering the loop, the "Collection template" Go template is evaluated; each element of the resulting **JSON array** is one iteration. + +### Collection template + +The recommended approach is a path to an array already written to the store by a previous task: + +```go +{{ .store.notification.engagements }} +``` + +An alternative is to build the array in the template: + +```go +{{ toJSON .store.modules }} +``` + +**Edge cases:** + +- An empty array or a missing key — 0 iterations, execution follows the "Loop exit" connection; a warning appears in the process log. +- A value at the path that is not a JSON array — a validation or loop execution error. + +### Scenario: iterating over a list from an API + +1. **Task** "Get engagements" — a **Write JSON** rule, target `notification.engagements`, source `{{ toJSON .response.engagements }}`. +1. **Loop**, **By collection** mode, collection template `{{ .store.notification.engagements }}`. +1. **Task** in the loop body — use `{{ .store._loop.item.id }}`, `{{ .store._loop.item.name }}` in the request body. +1. **Exclusive gateway** in the body — a condition based on an item field, e.g. left value `{{ .store._loop.item.status }}`, right value `active`. +1. **Loop exit** connection — continuation after iterating over all elements. + +## The Template element + +The "Template" element evaluates a Go template as the process runs and writes a **string** to the store. JSON in the result is not parsed — the text is stored in the store as-is. + +| Field | Description | +| ---- | -------- | +| Template body | A Go template; `{{ .store.* }}`, `{{ .process.* }}` are available, and, inside a loop, `{{ .store._loop.* }}` | +| Store key | The destination dot-path, e.g. `rendered_message` or `notification.summary` | +| Format hint | A hint used when viewing the run (`text`, `markdown`, `html`, `json`); does not affect the write | + +Example body: + +```go +## Report for {{ .store._loop.item.name }} + +Status: {{ .store._loop.item.status }} +Owner: {{ .store._loop.item.owner }} +``` + +Subsequent tasks read the result via `{{ .store.rendered_message }}` or the corresponding path. + +## Viewing the store during execution + +On the process run visualization screen, open the **Store** tab: + +- **Tree** — navigate nested keys; the type and value of the selected node are shown on the right. +- **JSON** — the full contents of the store in JSON format. + +You can copy a value, refresh the data, and download the run's JSON (button on the run dialog panel). + +The task's side panel on the run diagram shows the selected action's **Process store update rules** — useful for comparing the store's actual contents against the configuration. + +## Process log and debugging + +The visualization panel provides: + +- an **Execution log** tab (including in a separate window or below the diagram); +- **Download log** — the run's text log; +- messages about an empty loop collection and skipped store rules. + +If a template error occurs, or invalid JSON is used in a rule with a JSON operation, that rule may be skipped (with a warning in the log), while the other rules of the same action continue to run. + +## Related sections + +- [Overview](overview/) — diagram elements, running, and management. +- [Updating the store from actions](../../actions/overview/#process-store-update) — where the rules are enabled. +- [Templating](../../../user/templating/#process-store) — Go template syntax and contexts. diff --git a/content/documentation/user/properties.md b/content/documentation/user/properties.md new file mode 100644 index 00000000..2f2ebc0c --- /dev/null +++ b/content/documentation/user/properties.md @@ -0,0 +1,83 @@ +--- +title: Parameters +--- + +For each resource, action, or workflow, the platform administrator can add an unlimited number of parameters of one of the following types: + +* "Array" — a list of values; +* "Boolean" — a boolean value; +* "Date" — a date; +* JSON — text in JSON format; +* "Entities" — an entity, one of whose parameters can be selected as the value; +* "Enum" — an enumeration of values with a key and a displayed value; +* "List" — a list of values with the ability to select one of them; +* Markdown — text in Markdown format; +* "Number" — a number; +* "Object" — an arbitrary object in JSON format; +* "Percentage" — a percentage; +* "String" — a string; +* YAML — text in YAML format; +* "Teams" — teams; +* `URL` — a string in URL format; +* "Users" — users. + +## Resources + +Once a parameter has been added for a resource, it is displayed for all entities of that resource, both in their cards and in the catalog table. A default value can be set for each parameter. The value of each parameter can be changed individually for each entity. + +Whether parameters are filled in is checked for each entity, and the check result is shown in the header of the entity's card. + +### Synchronizing resource parameters + +For various reasons, entities may end up with parameters that the resource no longer has. To remove such parameters, use the "Synchronize parameters" button in the resource menu. + +When synchronizing parameters: + +* the identifier of each resource parameter is retrieved; +* the list of parameters is retrieved for each entity of the resource; +* entity parameters whose name does not match any of the resource's parameter identifiers are removed from the entity's specification. + +## Actions and workflows + +Each action and workflow has a user form consisting of parameters that the user must fill in when launching it. + +## Restrictions + +The identifier of each parameter must: + +* contain only the characters `a-z`, `A-Z`, digits, or underscores; +* not start with a digit. + +## Configuration + +* "Editable parameter" — for each parameter, you can allow or disallow the user from editing it. If editing is disallowed, the user will not be able to change the parameter's value when launching actions or workflows, meaning the default value will always be used. +* "Required parameter" — each parameter can be either required or optional. The value of a required parameter cannot be empty when launching actions or workflows. The value of an optional parameter, however, can remain empty without affecting the action's operation. +* "Hidden parameter" — a hidden parameter is not displayed in entity tables and cards, or when launching actions or workflows. + +## Parameter types + +### Date + +A parameter of type "Date" can hold a date value with a user-defined format. In the specification, the value is always stored in ISO 8601 format (`YYYY-MM-DDTHH:mm:ss.sssZ`). + +#### Parameter configuration + +* "Format" — configures how the date is displayed. If no format is explicitly set, the default format is used: `YYYY-MM-DDTHH:mm:ss.sssZ`. A description of the format configuration is available in the [Day.js documentation](https://day.js.org/docs/en/display/format). The format setting affects: + * how the date is displayed in entity tables and cards; + * the parameter's value when launching actions or workflows. +* "Current date by default" — substitutes the current date as the default value when editing entities, as well as when launching actions or workflows. +* "Default value" — a predefined default value. Not applied if the "Current date by default" toggle is enabled. + +{{< alert level="info" >}} +When launching actions or workflows with the current date used as the default, the parameter must not be hidden in the user form. Otherwise, the current date will not be substituted. +{{< /alert >}} + +When launching actions or workflows, values cannot be substituted into a "Date"-type parameter using [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax). + +### List + +A parameter of type "List" allows selecting a single value from a predefined list. + +### Enum + +A parameter of type "Enum" allows selecting a single item from a predefined list. Unlike the "List" type, the "Enum" parameter uses a key-value pair, where the key is stored in the specification and the value is displayed to the user. This allows the displayed text to be changed without changing the keys. diff --git a/content/documentation/user/templating.md b/content/documentation/user/templating.md new file mode 100644 index 00000000..3d336761 --- /dev/null +++ b/content/documentation/user/templating.md @@ -0,0 +1,623 @@ +--- +title: Templating +description: Go templates in DDP, built-in and sprig functions, global and team variables, action, entity, process, and workflow contexts, process store. +--- + +Deckhouse Development Platform supports templating based on [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax): expressions in curly braces are substituted into configuration fields where this is supported (actions, widgets, data sources, etc.). Below are the built-in functions and context variables (`{{ .property.* }}`, `{{ .entity.* }}`, and others). + +In addition to the standard functions, the following are available: + +* Built-in platform functions. +* Functions from the [sprig](https://masterminds.github.io/sprig/) library. + +{{< alert level="info" >}} +Functions from the [sprig](https://masterminds.github.io/sprig/) library are not supported in data sources. +{{< /alert >}} + +## Built-in functions + +### extractPart + +`extractPart` splits the input string `s` by the specified delimiter `delimiter` and returns the part at the specified index `index`. If the index is out of bounds, an error is returned. + +Parameters: + +* `s` — the input string to split. +* `delimiter` — the delimiter used to split the input string. +* `index` — the index of the part to return after splitting. + +Returns: + +* A string representing the part at the specified index after splitting the input string. +* If the index is out of bounds, an error is returned. + +Example in a template: + +```go +{{ extractPart "ddp/demo-service" "/" 1 }} // Output: "demo-service" +``` + +### extractLastPart + +`extractLastPart` splits the input string `s` by the specified delimiter `delimiter` and returns the last part. If the string is empty or the delimiter is not found, the original string is returned. + +Parameters: + +* `s` — the input string to split. +* `delimiter` — the delimiter used to split the input string. + +Returns: + +* A string representing the last part after splitting the input string. + +Example in a template: + +```go +{{ extractLastPart "ddp/demo-service" "/" }} // Output: "demo-service" +``` + +### toJSON + +`toJSON` serializes the given value into a JSON string. Accepts any data type. If serialization is not possible, an error is returned. + +Parameters: + +* `v` — the value to serialize to JSON. + +Returns: + +* A JSON string representing the input value. +* An error that occurred during serialization. + +Example in a template: + +```go +{{ toJSON . }} // Output: JSON representation of the object in the current context +``` + +### toYAML + +`toYAML` serializes the given value into a YAML string. Accepts any data type. If serialization is not possible, an error is returned. + +Parameters: + +* `v` — the value to serialize to YAML. + +Returns: + +* A string with the YAML representation of the input value. +* An error that occurred during serialization. + +Example in a template: + +```go +{{ toYAML . }} // Output: YAML representation of the object in the current context +``` + +### fromYAML + +`fromYAML` parses a YAML string into a `map` for use in a template (for example, to merge with `dict` or access by key). + +Parameters: + +* `s` — a string containing YAML. + +Returns: + +* A `map` with the data from the string. +* An empty `map` if the string is empty. +* An error if the YAML is invalid. + +Example in a template: + +```go +{{ index (fromYAML "first: a\nsecond: b\n") "first" }} // Output: "a" +``` + +### replaceChar + +`replaceChar` replaces all occurrences of a specified character in a string with another specified character. + +Parameters: + +* `s` — the source string in which to perform the replacement. +* `oldChar` — the character to replace. +* `newChar` — the character to replace it with. + +Returns: + +* The modified string, where all occurrences of `oldChar` have been replaced with `newChar`. + +Example in a template: + +```go +{{ replaceChar "hello/world" "/" "-" }} // Output: "hello-world" +``` + +### toSlug + +`toSlug` converts an arbitrary string into a valid identifier form: + +* The result contains only lowercase Latin letters and digits, with hyphens between fragments. +* The result has no leading hyphen. +* The result is no longer than 64 characters. +* Characters outside the allowed set are replaced with a single hyphen. +* Leading and trailing hyphens are removed. + +Parameters: + +* `s` — the source string. + +Returns: + +* A string in identifier form, or an empty string. + +Example in a template: + +```go +{{ toSlug "My Service/Name!" }} // Output: "my-service-name" +``` + +### filteredItems + +`filteredItems` filters an array of items (maps) by a requested key value. Returns an array of items whose value at the specified key matches the target value. + +Parameters: + +* `data` — the array of data to filter. +* `key` — the key whose value is checked. +* `value` — the target value to compare against. + +Returns: + +* An array of items whose value at the specified key matches the target value. +* An error, if a problem occurs during filtering. + +Example in a template: + +```go +{{ filteredItems .items "name" "Alice" }} // Output: [{"name": "Alice", "age": 30}] +``` + +### anyOf + +`anyOf` checks whether at least one element of the array satisfies the comparison condition. + +Parameters: + +* `operator` — the comparison operator (eq, ne, lt, le, gt, ge). +* `value` — the target value to compare against. +* `key` — the key whose value is used for comparison. +* `data` — the array of data (maps). + +Returns: + +* `true` if at least one value from the data array satisfies the condition. + +Example in a template: + +```go +{{ anyOf "eq" "value" "key" .data }} // Output: true if at least one record satisfies the condition +``` + +### allOf + +`allOf` checks whether all elements of the array satisfy the comparison condition. + +Parameters: + +* `operator` — the comparison operator (eq, ne, lt, le, gt, ge). +* `value` — the target value to compare against. +* `key` — the key whose value is used for comparison. +* `data` — the array of data (maps). + +Returns: + +* `true` only if all values satisfy the condition. + +Example in a template: + +```go +{{ allOf "gt" 10 "age" .users }} // Output: true if all users are older than 10 +``` + +### getFieldValue + +`getFieldValue` retrieves a field's value by key from a structure represented as a map. + +Parameters: + +* `items` — a data structure in the form of a `map`. +* `key` — the key whose value should be retrieved. + +Returns: + +* The value obtained by the key. +* An error if the structure is missing or the key is not found. + +Example in a template: + +```go +{{ getFieldValue .item "name" }} // Output: the value of the "name" field from the .item structure +``` + +### findValueInDictArray + +`findValueInDictArray` searches an array of dictionaries for an item whose value at the specified key matches the given value, and returns the value of another key. + +Parameters: + +* `data` — the array of dictionaries (map[string]interface{}) to search. +* `filterKey` — the key used for filtering. +* `filterValue` — the value that the value at filterKey must match. +* `targetKey` — the key whose value should be retrieved from the found item. + +Returns: + +* The value corresponding to targetKey in the found dictionary. +* An error if the item is not found or targetKey is missing. + +Example in a template: + +```go +{{ findValueInDictArray .items "environment" "test" "url" }} // Output: the value of the "url" key from the first found dictionary where "environment" equals "test". +``` + +### generatePassword + +`generatePassword` generates a random password with the specified parameters. + +Parameters: + +* `length` — password length (default: 16). +* `includeUppercase` — include uppercase letters A-Z (default: true). +* `includeLowercase` — include lowercase letters a-z (default: true). +* `includeNumbers` — include digits 0-9 (default: true). + +Returns: + +* A string with the generated password. +* An error if a password cannot be generated with the specified parameters. + +Examples in a template: + +```go +{{ generatePassword }} // Output: a random 16-character password +{{ generatePassword 12 }} // Output: a random 12-character password +{{ generatePassword 8 true true true }} // Output: an 8-character password +{{ generatePassword 10 false true true }} // Output: a 10-character password using only lowercase letters and digits +``` + +### encodeUnicode + +`encodeUnicode` converts a string into a sequence of Unicode escape sequences. Each character in the string is encoded in the format `\uXXXX`, where `XXXX` is the four-digit hexadecimal representation of the character's code point. + +Parameters: + +* `s` — the string to encode into Unicode escape sequences. + +Returns: + +* A string where each character is represented as a `\uXXXX` escape sequence. + +Example in a template: + +```go +{{ encodeUnicode "Привет" }} // Output: "\u041f\u0440\u0438\u0432\u0435\u0442" +{{ encodeUnicode "Hello" }} // Output: "\u0048\u0065\u006c\u006c\u006f" +``` + +### decodeUnicode + +`decodeUnicode` decodes a string containing Unicode escape sequences back into a regular string. The function handles escape sequences of the form `\uXXXX`, where `XXXX` is a four-digit hexadecimal number representing a Unicode code point. + +Parameters: + +* `s` — the string with Unicode escape sequences to decode. + +Returns: + +* The decoded string, where all Unicode escape sequences have been converted to characters. +* An error if decoding fails (for example, due to an incorrectly formatted escape sequence). + +Example in a template: + +```go +{{ decodeUnicode "\u041f\u0440\u0438\u0432\u0435\u0442" }} // Output: "Привет" +{{ decodeUnicode "\u0048\u0065\u006c\u006c\u006f" }} // Output: "Hello" +``` + +### jwtSign + +`jwtSign` creates a signed JWT from the given claims, signing key, and algorithm. + +Parameters: + +* `claims` — a `map` or a JSON string. Standard fields: "sub", "iss", "aud", "exp", "iat", "nbf". +* `signingKey` — the signing key: for HS256/HS384/HS512, a secret string; for RS256/ES256 and others, the PEM-encoded private key. +* `algorithm` — the signing algorithm: HS256, HS384, HS512, RS256, RS384, RS512, ES256, ES384, ES512, PS256, etc. +* `headers` — JWT headers (optional): a `map` or a JSON string, e.g. "kid", "cty". An empty string or empty `map` means no headers are set. + +Returns: + +* A string with the signed JWT. +* An error for invalid parameters or key. + +Examples in a template: + +```go +{{ jwtSign (dict "sub" "user-123" "iss" "ddp") .credentials.secret "HS256" "" }} +``` + +## Global variables + +Global variables are shared variables that can be reused in templating when actions are launched. + +To substitute the value of a global variable, use the following construct in a field that supports templates: + +```go +{{ .global.. }} +``` + +where: + +- `global` — indicates that a global variable is being accessed. +- `slug` — the identifier of the global variable set. +- `key` — the key of the variable whose value should be substituted. + +{{< alert level="warning" >}} +Global variables are stored in the DDP database in plain text, and their values can be retrieved by users through the web interface. It is not recommended to store sensitive data in global variables. +{{< /alert >}} + +### Configuring global variables + +Global variables are configured in the "Self-service" → "Global variables" section. + +The following naming rules apply: + +- The name of a global variable set cannot be empty. +- The identifier of a global variable set cannot be empty and must meet the following conditions: + - Contain only the characters `a-z`, `A-Z`, digits, or underscores. + - Not start with a digit. +- The key of each variable in the set cannot be empty and must meet the following conditions: + - Contain only the characters `a-z`, `A-Z`, digits, or underscores. + - Not start with a digit. +- The value of each variable in the set cannot be empty. + +## Team variables + +Team variables can be used in all actions, workflows, and processes. + +Team variables are configured in the "Administration" → "Teams" section, in the team editing menu. +Each user can edit the variables of the teams they belong to — this can be done in the user's profile. + +To get the value of a team variable, use the following construct: + +```go +{{ .team. }} +``` + +When launching an action, the user must select the team whose variables will be substituted. +When launching a workflow or process, the team is selected once — its variables are used in all actions within it. + +## Action variables + +### Action parameters + +Action parameters are available through the `{{ .property.* }}` context and contain the values passed when the action is launched. + +To get the value of an action parameter, use the following construct: + +```go +{{ .property. }} +``` + +where: + +- `property` — indicates that an action parameter is being accessed. +- `property_slug` — the identifier of the parameter whose value should be substituted. + +Parameter identifiers can be viewed on the "User form" tab in the action configuration window. + +Usage examples: + +```go +{{ .property.environment }} // Value of the "environment" parameter +{{ .property.count }} // Value of the "count" parameter +{{ .property.url }} // Value of the "url" parameter +``` + +### Action response + +The action response is available through the `{{ .response.* }}` context and contains the data returned after the action is executed. + +To get a value from the action's response, use the following construct: + +```go +{{ .response. }} +``` + +where: + +- `response` — indicates that the action's response is being accessed. +- `field_name` — the name of the field in the response whose value should be substituted. + +For the response format, see the documentation for the specific action, or check it in the DDP interface: + +1. Open the action's menu (the three-dot button on the action card). +1. Select "Action runs". +1. Open the configuration of one of the action's runs. +1. Find the "Response" column in the table. + +Usage examples: + +```go +{{ .response.status }} // Response status +{{ .response.data.id }} // ID from the response data +{{ .response.headers.auth }} // Value of the authorization header +``` + +{{< alert level="warning" >}} +The `{{ .response.* }}` context can only be used in fields that describe entity update rules after an action is run. +{{< /alert >}} + +## Credentials + +Credentials are available in all actions, workflows, processes, widgets, data sources, and external services through the `{{ .credentials.* }}` context. + +To get the value of credentials, use the following construct: + +```go +{{ .credentials. }} +``` + +where: + +- `credentials` — indicates that credentials are being accessed. +- `credentials_slug` — the identifier of the credentials whose value should be substituted. + +The `credentials_slug` identifier matches the one specified on the "Authorization" tab, in the "Credentials" section, in the DDP object configuration dialogs. + +Usage examples: + +```go +{{ .credentials.token }} // Access token +{{ .credentials.username }} // Username +{{ .credentials.password }} // Password +{{ .credentials.accessKeyId }} // Access Key ID for S3 +{{ .credentials.secretAccessKey }} // Secret Access Key for S3 +{{ .credentials.apiKey }} // API key +{{ .credentials.bearerToken }} // Bearer token +``` + +## Entity + +An entity is available in widgets with `Resource` scope, actions, processes, and workflows through the `{{ .entity.* }}` context. + +To get the value of an entity field, use the following construct: + +```go +{{ .entity. }} +``` + +where: + +- `entity` — indicates that an entity is being accessed. +- `field_name` — the name of the entity field whose value should be substituted. + +### Basic entity fields + +```go +{{ .entity.uuid }} // Entity UUID +{{ .entity.slug }} // Entity identifier +{{ .entity.name }} // Entity name +{{ .entity.description }} // Entity description +``` + +### Entity parameters + +Entity parameters are available through the `{{ .entity.properties.* }}` context and contain the custom parameters configured for a specific entity. + +To get the value of an entity parameter, use the following construct: + +```go +{{ .entity.properties. }} +``` + +where: + +- `entity` — indicates that an entity is being accessed. +- `properties` — indicates the entity's parameters. +- `property_slug` — the identifier of the entity parameter whose value should be substituted. + +Usage examples: + +```go +{{ .entity.properties.projectId }} // Project ID from the entity's parameters +{{ .entity.properties.branch }} // Git branch from the entity's parameters +{{ .entity.properties.environment }} // Environment from the entity's parameters +{{ .entity.properties.apiUrl }} // API URL from the entity's parameters +{{ .entity.properties.version }} // Version from the entity's parameters +``` + +## Process parameters + +For each process, you can define shared parameters whose values can be used in all actions that are part of the process. + +To get the value of a process parameter, use the following construct: + +```go +{{ .process. }} +``` + +where: + +- `process` — indicates that the process is being accessed. +- `property_slug` — the identifier of the process parameter whose value should be substituted. + +The parameter type and default value are set in the process editing interface. For each specific parameter, the user can override the default value when launching the process, if editing the parameter is allowed. + +Usage examples: + +```go +{{ .process.deploymentUrl }} // Deployment URL from the process parameters +{{ .process.branch }} // Git branch from the process parameters +{{ .process.environment }} // Environment from the process parameters +``` + +## Workflow parameters + +For each workflow, you can define shared parameters whose values can be used in all actions that are part of the workflow. + +To get the value of a workflow parameter, use the following construct: + +```go +{{ .workflow. }} +``` + +where: + +- `workflow` — indicates that the workflow is being accessed. +- `property_slug` — the identifier of the workflow parameter whose value should be substituted. + +The parameter type and default value are set in the workflow editing interface. For each specific parameter, the user can override the default value when launching the workflow, if editing the parameter is allowed. + +Usage examples: + +```go +{{ .workflow.apiEndpoint }} // API endpoint from the workflow parameters +{{ .workflow.notificationEmail }} // Notification email from the workflow parameters +{{ .workflow.retryAttempts }} // Number of retry attempts from the workflow parameters +``` + +## Process store + +The store is only available in processes and is used to pass data between steps. Writing is done via rules in actions and the "Template" element (see [Process store](../../admin/processes/store/)); reading is done via placeholders in templates. + +To read a value, use: + +```go +{{ .store. }} +``` + +The path matches the "Target" field in the write rules. Nested keys and array indices are supported: + +```go +{{ .store.projectId }} +{{ .store.notification.engagements }} +{{ .store.items[0].status }} +``` + +### Process loop context + +While a loop body inside a process is running, the `_loop` object is available in templates: + +```go +{{ .store._loop.item }} // current collection item or iteration number +{{ .store._loop.index }} // 0-based index +{{ .store._loop.total }} // total number of iterations +{{ .store._loop.first }} // true on the first iteration +{{ .store._loop.last }} // true on the last iteration +``` + +For nested loops, the parent context: `{{ .store._loop.parent }}`. From eae05b7a822e4cbf5349f7e0c76d75e2ec743618 Mon Sep 17 00:00:00 2001 From: lada7878 Date: Wed, 5 Aug 2026 12:36:29 +0500 Subject: [PATCH 5/5] english version Signed-off-by: lada7878 --- .../codescoring/createcodescoringproject.md | 6 ++--- .../admin/actions/debug/debug.md | 2 +- .../documentation/admin/actions/debug/fail.md | 2 +- .../defectdojo/createdefectdojoengagement.md | 4 ++-- .../defectdojo/createdefectdojoproduct.md | 4 ++-- .../defectdojo/deletedefectdojoproduct.md | 2 +- .../admin/actions/gitlab/_index.md | 2 +- .../actions/gitlab/creategitlabbranches.md | 4 ++-- .../gitlab/creategitlabgroupvariables.md | 4 ++-- .../gitlab/creategitlabmergerequest.md | 6 ++--- .../actions/gitlab/creategitlabproject.md | 6 ++--- .../gitlab/creategitlabprojectvariables.md | 6 ++--- .../gitlab/creategitlabprojectwebhook.md | 10 ++++---- .../actions/gitlab/creategitlabrelease.md | 2 +- .../admin/actions/gitlab/creategitlabtag.md | 4 ++-- .../gitlab/createrepositoryfromtemplate.md | 6 ++--- .../actions/gitlab/deletegitlabproject.md | 6 ++--- .../actions/gitlab/startgitlabpipeline.md | 6 ++--- .../admin/actions/kafka/createkafkaacls.md | 16 ++++++------- .../admin/actions/kafka/createkafkatopics.md | 14 +++++------ .../admin/actions/kafka/createkafkausers.md | 20 ++++++++-------- .../admin/actions/kafka/deletekafkaacls.md | 22 ++++++++--------- .../admin/actions/kafka/deletekafkatopics.md | 12 +++++----- .../admin/actions/kafka/deletekafkausers.md | 16 ++++++------- .../actions/keycloak/createkeycloakclient.md | 10 ++++---- .../kubernetes/createkubernetesresource.md | 6 ++--- .../kubernetes/deletekubernetesresource.md | 10 ++++---- .../kubernetes/getkubernetesresource.md | 24 +++++++++---------- .../actions/nexus/assignnexusprivilege.md | 2 +- .../admin/actions/nexus/assignnexusrole.md | 4 ++-- .../actions/nexus/createnexusprivilege.md | 2 +- .../actions/nexus/createnexusrepository.md | 16 ++++++------- .../admin/actions/nexus/createnexusrole.md | 2 +- .../admin/actions/nexus/createnexususer.md | 2 +- .../actions/nexus/deletenexusprivilege.md | 2 +- .../actions/nexus/deletenexusrepository.md | 8 +++---- .../admin/actions/nexus/deletenexusrole.md | 2 +- .../admin/actions/nexus/deletenexususer.md | 2 +- .../documentation/admin/actions/overview.md | 16 ++++++------- .../sonarqube/createsonarqubeproject.md | 2 +- .../sonarqube/deletesonarqubeproject.md | 2 +- .../sonarqube/deletesonarqubeprojects.md | 2 +- .../vault/createvaultkubernetesauthrole.md | 4 ++-- .../admin/actions/vault/createvaultsecret.md | 2 +- .../admin/actions/vault/deletevaultsecret.md | 2 +- .../documentation/admin/actions/wait/wait.md | 2 +- 46 files changed, 153 insertions(+), 153 deletions(-) diff --git a/content/documentation/admin/actions/codescoring/createcodescoringproject.md b/content/documentation/admin/actions/codescoring/createcodescoringproject.md index 1a2cd98e..ff0f4478 100644 --- a/content/documentation/admin/actions/codescoring/createcodescoringproject.md +++ b/content/documentation/admin/actions/codescoring/createcodescoringproject.md @@ -7,7 +7,7 @@ CreateCodeScoringProject — creates a new project in CodeScoring. The action uses the CodeScoring API to register a project with the specified parameters: - project name, - repository URL, -- VCS system ID, +- VCS ID, - an option to automatically run SCA analysis after cloning the repository. ### Request example @@ -25,9 +25,9 @@ run_sca_after_clone: true | -------------------- | -------- | ---------------------------------------------------------------------------- | | name | Yes | Project name in CodeScoring | | repository | Yes | Repository URL (e.g., ) | -| vcs_id | Yes | VCS system ID in CodeScoring (must be greater than 0) | +| vcs_id | Yes | VCS ID in CodeScoring (must be greater than 0) | | run_sca_after_clone | No | Automatically run SCA analysis after cloning the repository | ### Response -The response returns the created project object with the following information: project identifier (pk), name, project type, description, repository information, project status, access permissions, license, number of dependencies and vulnerabilities, project languages, scan schedule status, and the dates of the first and last SCA scan. +The response contains the created project object with the following information: project identifier (pk), name, project type, description, repository information, project status, access permissions, license, number of dependencies and vulnerabilities, project languages, scan schedule status, and the dates of the first and last SCA scans. diff --git a/content/documentation/admin/actions/debug/debug.md b/content/documentation/admin/actions/debug/debug.md index 28b2f666..9406ccb6 100644 --- a/content/documentation/admin/actions/debug/debug.md +++ b/content/documentation/admin/actions/debug/debug.md @@ -3,7 +3,7 @@ title: Debug weight: 10 --- -Debug runs a debug action. It lets you perform a specified number of wait cycles, as well as write arbitrary data to the log and return it in the action's response. +Debug runs a debugging action. It performs a specified number of wait cycles, writes arbitrary data to the log, and returns that data in the action response. ### Request example diff --git a/content/documentation/admin/actions/debug/fail.md b/content/documentation/admin/actions/debug/fail.md index bbc12a16..804ef385 100644 --- a/content/documentation/admin/actions/debug/fail.md +++ b/content/documentation/admin/actions/debug/fail.md @@ -3,7 +3,7 @@ title: Fail weight: 20 --- -Fail emulates an action execution error. Intended for use in processes as a debugging element. +Fail simulates an action execution error. It is intended for use as a debugging step in processes. ### Request example diff --git a/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md b/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md index ce1c78ef..79cb2c7f 100644 --- a/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md +++ b/content/documentation/admin/actions/defectdojo/createdefectdojoengagement.md @@ -5,7 +5,7 @@ weight: 30 {{< alert level="info" >}} -Running this action requires a token — an API v2 Key for the user on whose behalf the action will be run. +This action requires an API v2 key for the user on whose behalf it will run. {{< /alert >}} CreateDefectdojoEngagement — creates a new engagement in DefectDojo. The action uses the DefectDojo API v2. @@ -22,4 +22,4 @@ lead: '1' ### Request specification -The list of fields corresponds to the official DefectDojo API, `/api/v2/engagements`, for more information see [the DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). +The fields correspond to the official DefectDojo API endpoint `/api/v2/engagements`. For details, see the [DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). diff --git a/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md b/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md index cafdad49..19b1ae58 100644 --- a/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md +++ b/content/documentation/admin/actions/defectdojo/createdefectdojoproduct.md @@ -5,7 +5,7 @@ weight: 10 {{< alert level="info" >}} -Running this action requires a token — an API v2 Key for the user on whose behalf the action will be run. +This action requires an API v2 key for the user on whose behalf it will run. {{< /alert >}} CreateDefectdojoProduct — creates a new product in DefectDojo. The action uses the DefectDojo API v2. @@ -20,4 +20,4 @@ prod_type: 1 ### Request specification -The list of fields corresponds to the official DefectDojo API, `/api/v2/products`, for more information see [the DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). +The fields correspond to the official DefectDojo API endpoint `/api/v2/products`. For details, see the [DefectDojo documentation](https://demo.defectdojo.org/api/v2/oa3/swagger-ui/). diff --git a/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md b/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md index 3db5fee1..276d6c4c 100644 --- a/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md +++ b/content/documentation/admin/actions/defectdojo/deletedefectdojoproduct.md @@ -5,7 +5,7 @@ weight: 20 {{< alert level="info" >}} -Running this action requires a token — an API v2 Key for the user on whose behalf the action will be run. +This action requires an API v2 key for the user on whose behalf it will run. {{< /alert >}} DeleteDefectdojoProduct — deletes a product from DefectDojo. The action uses the DefectDojo API v2. diff --git a/content/documentation/admin/actions/gitlab/_index.md b/content/documentation/admin/actions/gitlab/_index.md index 46d8b304..e788929d 100644 --- a/content/documentation/admin/actions/gitlab/_index.md +++ b/content/documentation/admin/actions/gitlab/_index.md @@ -1,4 +1,4 @@ --- -title: Gitlab +title: GitLab weight: 20 --- diff --git a/content/documentation/admin/actions/gitlab/creategitlabbranches.md b/content/documentation/admin/actions/gitlab/creategitlabbranches.md index 603770c9..8739fddb 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabbranches.md +++ b/content/documentation/admin/actions/gitlab/creategitlabbranches.md @@ -4,7 +4,7 @@ weight: 40 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} CreateGitlabBranches — creates new branches in the target repository. @@ -25,7 +25,7 @@ branches: | project_id | Yes | Identifier of the project in which to create the branches | | branches | Yes | List of branches to create | | branches.branch | Yes | Name of the new branch | -| branches.ref | Yes | Name of an existing branch or a commit SHA hash | +| branches.ref | Yes | Name of an existing branch or a commit SHA | ### Note diff --git a/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md b/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md index 9856cf29..609f14ac 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md +++ b/content/documentation/admin/actions/gitlab/creategitlabgroupvariables.md @@ -4,7 +4,7 @@ weight: 80 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} CreateGitlabGroupVariables — creates group-level variables in GitLab. @@ -25,7 +25,7 @@ variables: | group_id | Yes | Identifier of the group in which to create the variables | | variables | Yes | List of variables to create | -The field list for variables corresponds to the official GitLab Group-level Variables API, `/groups/:id/variables`, for more information see [the GitLab documentation](https://docs.gitlab.com/api/group_level_variables/#create-variable). +The fields for each variable correspond to the official GitLab group-level variables API, `/groups/:id/variables`. For details, see the [GitLab documentation](https://docs.gitlab.com/api/group_level_variables/#create-variable). ### Note diff --git a/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md b/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md index 34b2f9f1..03d49bf4 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md +++ b/content/documentation/admin/actions/gitlab/creategitlabmergerequest.md @@ -6,8 +6,8 @@ weight: 70 {{< alert level="info" >}} Running this action requires credentials: -- `password` — the password (token) of the user on whose behalf the action will be run. -- `username` — the username on whose behalf the action will be run. +- `password` — the password (token) for the user on whose behalf the action will run. +- `username` — the username of the user on whose behalf the action will run. {{< /alert >}} CreateGitlabMergeRequest — creates a new Merge Request (MR) in the target repository. Files stored in the source repository are added to the Merge Request. Files may contain variables whose values will be substituted at the time the MR is created. @@ -54,7 +54,7 @@ The platform: 1. Reads the variables passed when the action is launched and merges them with the variables from `values.yaml`. Variables passed at launch take priority. 1. Reads the `.templateignore` file and determines the directories and files excluded from templating. 1. Renders the files from the templates, taking into account `values.yaml` and the variables passed to the action. -1. Changes the remote of the repository to the target one, according to its ID (`target_project_id`), and performs a git push to the branch in the source project (`source_project_branch`), or to the `main` branch. +1. Changes the repository remote to the target repository identified by `target_project_id`, then runs `git push` to the branch in the source project (`source_project_branch`) or to the `main` branch. 1. Creates an MR according to the specified settings by sending a POST request to the GitLab API. ### Note diff --git a/content/documentation/admin/actions/gitlab/creategitlabproject.md b/content/documentation/admin/actions/gitlab/creategitlabproject.md index 7c7e571d..3005be8a 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabproject.md +++ b/content/documentation/admin/actions/gitlab/creategitlabproject.md @@ -1,13 +1,13 @@ --- -title: CreateGitlabProjecte +title: CreateGitlabProject weight: 20 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} -CreateGitlabProject — creates a new project in GitLab. The action calls the GitLab API to create a project with the specified parameters, such as name, project path, description, and other settings. A GitLab token, which must be provided in the credentials, is used for authentication. +CreateGitlabProject — creates a new project in GitLab through the GitLab API, using the specified name, project path, description, and other settings. Authentication uses a GitLab token provided in the credentials. ### Request example diff --git a/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md b/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md index 16608389..683bb2c8 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md +++ b/content/documentation/admin/actions/gitlab/creategitlabprojectvariables.md @@ -1,10 +1,10 @@ --- -title: CreateGitlabGroupVariables +title: CreateGitlabProjectVariables weight: 90 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} CreateGitlabProjectVariables — creates project-level variables in GitLab. @@ -25,7 +25,7 @@ variables: | project_id | Yes | Identifier of the project in which to create the variables | | variables | Yes | List of variables to create | -The field list for variables corresponds to the official GitLab Project-level CI/CD variables API, `/projects/:id/variables`, for more information see [the GitLab documentation](https://docs.gitlab.com/api/project_level_variables/#create-a-variable). +The fields for each variable correspond to the official GitLab project-level CI/CD variables API, `/projects/:id/variables`. For details, see the [GitLab documentation](https://docs.gitlab.com/api/project_level_variables/#create-a-variable). ### Note diff --git a/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md b/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md index 07bd9a01..9f88e405 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md +++ b/content/documentation/admin/actions/gitlab/creategitlabprojectwebhook.md @@ -4,7 +4,7 @@ weight: 30 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} CreateGitlabProjectWebhook — creates a webhook in a GitLab project. @@ -26,10 +26,10 @@ pipeline_events: true | ----------------------- | ------------------ | ----------------------------------------------------------------- | | project_id | Yes | Identifier of the project in which to create the webhook | | url | Yes | Webhook URL | -| push_events | Yes | Trigger the webhook on push to the repository | -| issues_events | Yes | Trigger the webhook when an Issue is created | -| merge_requests_events | Yes | Trigger the webhook when a Merge Request is created | -| pipeline_events | Yes | Trigger the webhook when a Pipeline is run | +| push_events | Yes | Trigger the webhook when changes are pushed to the repository | +| issues_events | Yes | Trigger the webhook when an issue is created | +| merge_requests_events | Yes | Trigger the webhook when a merge request is created | +| pipeline_events | Yes | Trigger the webhook when a pipeline is run | ### Note diff --git a/content/documentation/admin/actions/gitlab/creategitlabrelease.md b/content/documentation/admin/actions/gitlab/creategitlabrelease.md index 06aa435f..870b0fe3 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabrelease.md +++ b/content/documentation/admin/actions/gitlab/creategitlabrelease.md @@ -4,7 +4,7 @@ weight: 60 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} CreateGitlabRelease — creates a GitLab release based on an existing tag. diff --git a/content/documentation/admin/actions/gitlab/creategitlabtag.md b/content/documentation/admin/actions/gitlab/creategitlabtag.md index 8484bd8a..74687d63 100644 --- a/content/documentation/admin/actions/gitlab/creategitlabtag.md +++ b/content/documentation/admin/actions/gitlab/creategitlabtag.md @@ -4,7 +4,7 @@ weight: 50 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} CreateGitlabTag — creates a new tag in a GitLab project. @@ -24,7 +24,7 @@ message: Tag description | ---------------------- | -------- | ------------------------------------------------------------------------------------ | | project_id | Yes | Identifier of the project in which to create the tag | | tag_name | Yes | Name of the tag | -| ref | Yes | Name of the branch, a tag, or a commit SHA hash the new tag will point to | +| ref | Yes | Name of the branch or tag, or the commit SHA, that the new tag will point to | | message | Yes | Tag description | ### Note diff --git a/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md b/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md index c964dc21..433fe588 100644 --- a/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md +++ b/content/documentation/admin/actions/gitlab/createrepositoryfromtemplate.md @@ -6,8 +6,8 @@ weight: 10 {{< alert level="info" >}} Running this action requires credentials: -- `password` — the password (token) of the user on whose behalf the action will be run. -- `username` — the username on whose behalf the action will be run. +- `password` — the password (token) for the user on whose behalf the action will run. +- `username` — the username of the user on whose behalf the action will run. {{< /alert >}} CreateRepositoryFromTemplate — creates a new repository from a template in GitLab. The rendering mechanism is based on [Go template](https://developer.hashicorp.com/nomad/docs/reference/go-template-syntax) and supports all built-in methods, as well as extensions added by the platform. @@ -51,7 +51,7 @@ The platform: 1. Reads the variables passed when the action is launched and merges them with the variables from `values.yaml`. Variables passed at launch take priority during the merge. 1. Reads the `.templateignore` file and determines the directories and files excluded from templating. 1. Renders the files from the templates, taking into account `values.yaml` and the variables passed to the action. -1. Changes the remote of the repository to the target one (`targetRepositoryUrl`) and pushes to the target branch (`targetBranch`) or to the `main` branch. +1. Changes the repository remote to the target repository (`targetRepositoryUrl`) and pushes to the target branch (`targetBranch`) or to the `main` branch. ### Implementation details diff --git a/content/documentation/admin/actions/gitlab/deletegitlabproject.md b/content/documentation/admin/actions/gitlab/deletegitlabproject.md index 472fa23c..46aa2fc8 100644 --- a/content/documentation/admin/actions/gitlab/deletegitlabproject.md +++ b/content/documentation/admin/actions/gitlab/deletegitlabproject.md @@ -1,13 +1,13 @@ --- -title: StartGitlabPipeline +title: DeleteGitlabProject weight: 110 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} -DeleteGitlabProject — deletes an existing project in GitLab. The action calls the GitLab API to delete the project. A GitLab token, which must be provided in the credentials, is used for authentication. +DeleteGitlabProject — deletes an existing project in GitLab through the GitLab API. Authentication uses a GitLab token provided in the credentials. ### Request example diff --git a/content/documentation/admin/actions/gitlab/startgitlabpipeline.md b/content/documentation/admin/actions/gitlab/startgitlabpipeline.md index 0836c14e..f11294ad 100644 --- a/content/documentation/admin/actions/gitlab/startgitlabpipeline.md +++ b/content/documentation/admin/actions/gitlab/startgitlabpipeline.md @@ -4,10 +4,10 @@ weight: 100 --- {{< alert level="info" >}} -Running this action requires the token of the user on whose behalf it will be run. +This action requires a token for the user on whose behalf it will run. {{< /alert >}} -StartGitlabPipeline — starts a pipeline run in GitLab. +StartGitlabPipeline — starts a pipeline in GitLab. ### Request example @@ -24,7 +24,7 @@ variables: | Name | Required | Description | | --------------------------- | -------- | ---------------------------------------------------------------------------------- | | project_id | Yes | Identifier of the project in which to run the pipeline | -| ref | Yes | Name of the branch, a tag, or a commit SHA hash on which the pipeline will run | +| ref | Yes | Name of the branch or tag, or the commit SHA, on which the pipeline will run | | variables | No | List of variables to pass to the pipeline being run | | variables.key | Yes | Variable name | | variables.value | Yes | Variable value | diff --git a/content/documentation/admin/actions/kafka/createkafkaacls.md b/content/documentation/admin/actions/kafka/createkafkaacls.md index 8a16cf0e..1c5fd708 100644 --- a/content/documentation/admin/actions/kafka/createkafkaacls.md +++ b/content/documentation/admin/actions/kafka/createkafkaacls.md @@ -5,9 +5,9 @@ weight: 50 {{< alert level="info" >}} -Running this action requires credentials: -* `user` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `user` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} CreateKafkaACLs — creates a set of ACLs in Kafka. @@ -54,17 +54,17 @@ acls: | Name | Required | Description | Possible values | Default value | | ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------ | -| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | -| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | +| securityProtocol | Yes | Protocol for connecting to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | +| saslMechanism | No | SASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | | acls | Yes | Set of ACLs to create | - | - | -| acls.ops | Yes | List of operations for which the rule will be created | [List of possible operations](#list-of-possible-operations) | - | +| acls.ops | Yes | List of operations to which the rule applies | [List of possible operations](#list-of-possible-operations) | - | | acls.pattern | Yes | Pattern type | [List of possible patterns](#list-of-possible-patterns) | - | | acls.topics | No | List of topic names to which the rule applies | - | - | | acls.groups | No | List of group names to which the rule applies | - | - | | acls.transactional_ids | No | List of transaction IDs to which the rule applies | - | - | | acls.tokens | No | List of tokens to which the rule applies | - | - | -| acls.allow | No | List of principals (user, group) for which the rule is allowed | - | - | -| acls.deny | No | List of principals (user, group) for which the rule is denied | - | - | +| acls.allow | No | List of principals (users or groups) allowed by the rule | - | - | +| acls.deny | No | List of principals (users or groups) denied by the rule | - | - | | acls.hosts | No | List of hosts for which the operation is allowed | - | - | | acls.deny_hosts | No | List of hosts for which the operation is denied | - | - | diff --git a/content/documentation/admin/actions/kafka/createkafkatopics.md b/content/documentation/admin/actions/kafka/createkafkatopics.md index a14cc114..4f50a822 100644 --- a/content/documentation/admin/actions/kafka/createkafkatopics.md +++ b/content/documentation/admin/actions/kafka/createkafkatopics.md @@ -5,9 +5,9 @@ weight: 10 {{< alert level="info" >}} -Running this action requires credentials: -* `user` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `user` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} CreateKafkaTopics — creates new topics in Kafka. @@ -29,9 +29,9 @@ topics: | Name | Required | Description | Possible values | | -------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | -| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| partitions | Yes | Number of partitions the topic will be split into | - | +| securityProtocol | Yes | Protocol for connecting to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | SASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| partitions | Yes | Number of partitions into which each topic will be divided | - | | replication_factor | Yes | Number of copies (replicas) of each topic partition to place on different brokers | - | -| configs | Yes | Key-value configuration for the topics being created | Values are listed [in the Kafka documentation](https://kafka.apache.org/documentation/#topicconfigs) | +| configs | Yes | Key-value configuration for the topics to create | Values are listed [in the Kafka documentation](https://kafka.apache.org/documentation/#topicconfigs) | | topics | Yes | List of topic names to create | - | diff --git a/content/documentation/admin/actions/kafka/createkafkausers.md b/content/documentation/admin/actions/kafka/createkafkausers.md index 151c0ab4..709c8236 100644 --- a/content/documentation/admin/actions/kafka/createkafkausers.md +++ b/content/documentation/admin/actions/kafka/createkafkausers.md @@ -5,9 +5,9 @@ weight: 30 {{< alert level="info" >}} -Running this action requires credentials: -* `user` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `user` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} CreateKafkaUsers — creates new SASL/SCRAM users in Kafka. @@ -32,10 +32,10 @@ users: | Name | Required | Description | Possible values | | ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| users | Yes | Set of users to create | - | -| users.user | Yes | Name of the user to create | - | -| users.password | Yes | Password of the user to create | - | -| users.mechanism | Yes | Authentication mechanism of the user to create | SCRAM-SHA-256, SCRAM-SHA-512 | -| users.iterations | Yes | Number of iterations used for password hashing | From 4096 to 16384 | +| securityProtocol | Yes | Protocol for connecting to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | SASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| users | Yes | Set of users to create | - | +| users.user | Yes | Username to create | - | +| users.password | Yes | Password for the user | - | +| users.mechanism | Yes | Authentication mechanism for the user | SCRAM-SHA-256, SCRAM-SHA-512 | +| users.iterations | Yes | Number of iterations used to hash the password | From 4096 to 16384 | diff --git a/content/documentation/admin/actions/kafka/deletekafkaacls.md b/content/documentation/admin/actions/kafka/deletekafkaacls.md index 1c1ed916..d38a07a4 100644 --- a/content/documentation/admin/actions/kafka/deletekafkaacls.md +++ b/content/documentation/admin/actions/kafka/deletekafkaacls.md @@ -5,9 +5,9 @@ weight: 60 {{< alert level="info" >}} -Running this action requires credentials: -* `user` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `user` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} DeleteKafkaACLs — deletes a set of ACLs in Kafka. @@ -63,10 +63,10 @@ acls: | Name | Required | Description | Possible values | Default value | | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------ | -| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | -| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | +| securityProtocol | Yes | Protocol for connecting to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | - | +| saslMechanism | No | SASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | - | | acls | Yes | Set of ACLs to delete | - | - | -| acls.ops | Yes | List of operations for which the rule will be deleted | [List of possible operations](#list-of-possible-operations) | - | +| acls.ops | Yes | List of operations to which the rule to delete applies | [List of possible operations](#list-of-possible-operations) | - | | acls.pattern | Yes | Pattern type | [List of possible patterns](#list-of-possible-patterns) | - | | acls.any_resource | No | All resources | - | false | | acls.topics | No | List of topic names to which the rule applies | - | - | @@ -77,13 +77,13 @@ acls: | acls.any_transactional_id | No | Any transaction | - | false | | acls.tokens | No | List of tokens to which the rule applies | - | - | | acls.any_token | No | All tokens | - | false | -| acls.allow | No | List of principals (user, group) for which the rule is allowed | - | - | -| acls.any_allow | No | Any principal (user, group) | - | false | +| acls.allow | No | List of principals (users or groups) allowed by the rule | - | - | +| acls.any_allow | No | Any principal (user or group) | - | false | | acls.allow_hosts | No | List of hosts for which the operation is allowed | - | - | | acls.any_allow_hosts | No | Any host from which the operation is allowed | - | false | -| acls.deny | No | List of principals (user, group) for which the rule will be denied | - | - | -| acls.any_deny | No | Any principal (user, group) | - | false | -| acls.deny_hosts | No | List of hosts for which the operation will be denied | - | - | +| acls.deny | No | List of principals (users or groups) denied by the rule | - | - | +| acls.any_deny | No | Any principal (user or group) | - | false | +| acls.deny_hosts | No | List of hosts from which the operation is denied | - | - | | acls.any_deny_hosts | No | Any host from which the operation is denied | - | false | ### List of possible patterns diff --git a/content/documentation/admin/actions/kafka/deletekafkatopics.md b/content/documentation/admin/actions/kafka/deletekafkatopics.md index 99de53c7..9aa85f26 100644 --- a/content/documentation/admin/actions/kafka/deletekafkatopics.md +++ b/content/documentation/admin/actions/kafka/deletekafkatopics.md @@ -5,9 +5,9 @@ weight: 20 {{< alert level="info" >}} -Running this action requires credentials: -* `user` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `user` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} DeleteKafkaTopics — deletes existing topics in Kafka. @@ -26,6 +26,6 @@ topics: | Name | Required | Description | Possible values | | -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| topics | Yes | List of topic names to delete | - | +| securityProtocol | Yes | Protocol for connecting to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | SASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| topics | Yes | List of topic names to delete | - | diff --git a/content/documentation/admin/actions/kafka/deletekafkausers.md b/content/documentation/admin/actions/kafka/deletekafkausers.md index 3d946ea8..37981010 100644 --- a/content/documentation/admin/actions/kafka/deletekafkausers.md +++ b/content/documentation/admin/actions/kafka/deletekafkausers.md @@ -5,9 +5,9 @@ weight: 40 {{< alert level="info" >}} -Running this action requires credentials: -* `user` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `user` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} DeleteKafkaUsers — deletes existing SASL/SCRAM users in Kafka. @@ -28,8 +28,8 @@ users: | Name | Required | Description | Possible values | | ------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------- | -| securityProtocol | Yes | Protocol used to connect to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | -| saslMechanism | No | Authentication mechanism to be used by SASL. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | -| users | Yes | Set of users to delete | - | -| users.user | Yes | Name of the user to delete | - | -| users.mechanism | Yes | Authentication mechanism of the user to delete | SCRAM-SHA-256, SCRAM-SHA-512 | +| securityProtocol | Yes | Protocol for connecting to Kafka. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#adminclientconfigs_security.protocol) | PLAINTEXT, SASL_PLAINTEXT, SASL_SSL | +| saslMechanism | No | SASL authentication mechanism. Required when using the SASL_PLAINTEXT or SASL_SSL protocol. For more information, see [the Kafka documentation](https://kafka.apache.org/documentation/#security_sasl_mechanism) | PLAIN, SCRAM-SHA-256, SCRAM-SHA-512 | +| users | Yes | Set of users to delete | - | +| users.user | Yes | Username to delete | - | +| users.mechanism | Yes | Authentication mechanism associated with the user to delete | SCRAM-SHA-256, SCRAM-SHA-512 | diff --git a/content/documentation/admin/actions/keycloak/createkeycloakclient.md b/content/documentation/admin/actions/keycloak/createkeycloakclient.md index 35016ac0..30a46ea3 100644 --- a/content/documentation/admin/actions/keycloak/createkeycloakclient.md +++ b/content/documentation/admin/actions/keycloak/createkeycloakclient.md @@ -5,9 +5,9 @@ weight: 10 {{< alert level="info" >}} -Running this action requires credentials: -* `username` — the username on whose behalf the action will be run. -* `password` — the password of the user on whose behalf the action will be run. +This action requires the following credentials: +* `username` — the username under which the action runs. +* `password` — the password for that user. {{< /alert >}} CreateKeycloakClient — creates a new client in Keycloak. @@ -36,5 +36,5 @@ config: | Name | Required | Description | Possible values | | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| realm | Yes | Realm in Keycloak in which to create the client | - | -| config | Yes | Parameters of the client to create, according to the [Keycloak ClientRepresentation specification](https://www.keycloak.org/docs-api/latest/rest-api/index.html#ClientRepresentation) | - | +| realm | Yes | Keycloak realm in which to create the client | - | +| config | Yes | Parameters for the client to create, as defined in the [Keycloak ClientRepresentation specification](https://www.keycloak.org/docs-api/latest/rest-api/index.html#ClientRepresentation) | - | diff --git a/content/documentation/admin/actions/kubernetes/createkubernetesresource.md b/content/documentation/admin/actions/kubernetes/createkubernetesresource.md index 8823e1cb..02399bf3 100644 --- a/content/documentation/admin/actions/kubernetes/createkubernetesresource.md +++ b/content/documentation/admin/actions/kubernetes/createkubernetesresource.md @@ -5,10 +5,10 @@ weight: 10 {{< alert level="info" >}} -Running this action requires a Kubernetes service account token. +This action requires a Kubernetes service account token. {{< /alert >}} -CreateKubernetesResource — creates one or more new resources in a Kubernetes cluster, or updates existing ones. +CreateKubernetesResource — creates one or more resources in a Kubernetes cluster or updates existing resources. ### Request example @@ -28,4 +28,4 @@ manifests: | Name | Required | Description | | ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------- | -| manifests | Yes | Kubernetes manifests to be applied | +| manifests | Yes | Kubernetes manifests to apply | diff --git a/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md b/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md index b56bcfc8..0fc25efd 100644 --- a/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md +++ b/content/documentation/admin/actions/kubernetes/deletekubernetesresource.md @@ -4,7 +4,7 @@ weight: 30 --- {{< alert level="info" >}} -Running this action requires a Kubernetes service account token. +This action requires a Kubernetes service account token. {{< /alert >}} DeleteKubernetesResource — deletes an existing resource in a Kubernetes cluster. @@ -23,8 +23,8 @@ namespace: example | Name | Required | Description | Possible values | | --------------------------- | ----------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| group | Yes | API group of the resource. Specifies which API group the object being deleted belongs to | [Determining the required Group and Version](getkubernetesresource/#determining-the-required-group-and-version) | +| group | Yes | API group of the resource. Specifies the API group to which the object being deleted belongs | [Determining the required Group and Version](getkubernetesresource/#determining-the-required-group-and-version) | | version | Yes | API version of the resource | [Determining the required Group and Version](getkubernetesresource/#determining-the-required-group-and-version) | -| resource_type | Yes | Type of the resource to delete | pods, services, deployments, statefulsets, daemonsets, replicasets, jobs, cronjobs, nodes, namespaces, configmaps, secrets, persistentvolumes, persistentvolumeclaims, limitranges, resourcequotas, horizontalpodautoscalers, ingresses, networkpolicies, serviceaccounts, roles, clusterroles, rolebindings, clusterrolebindings, podsecuritypolicies, storageclasses, volumeattachments, events, endpoints, customresourcedefinitions | -| resource_name | Yes | Name of the specific resource to delete | - | -| namespace | Yes | Namespace in which the resource is located | - | +| resource_type | Yes | Type of resource to delete | pods, services, deployments, statefulsets, daemonsets, replicasets, jobs, cronjobs, nodes, namespaces, configmaps, secrets, persistentvolumes, persistentvolumeclaims, limitranges, resourcequotas, horizontalpodautoscalers, ingresses, networkpolicies, serviceaccounts, roles, clusterroles, rolebindings, clusterrolebindings, podsecuritypolicies, storageclasses, volumeattachments, events, endpoints, customresourcedefinitions | +| resource_name | Yes | Name of the resource to delete | - | +| namespace | Yes | Namespace containing the resource | - | diff --git a/content/documentation/admin/actions/kubernetes/getkubernetesresource.md b/content/documentation/admin/actions/kubernetes/getkubernetesresource.md index c72b6bdb..e25ac18b 100644 --- a/content/documentation/admin/actions/kubernetes/getkubernetesresource.md +++ b/content/documentation/admin/actions/kubernetes/getkubernetesresource.md @@ -5,7 +5,7 @@ weight: 20 {{< alert level="info" >}} -Running this action requires a Kubernetes service account token. +This action requires a Kubernetes service account token. {{< /alert >}} GetKubernetesResource — retrieves a resource from a Kubernetes cluster. @@ -24,11 +24,11 @@ namespace: default | Name | Required | Description | Possible values | | --------------------------- | -------- | ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | -| group | Yes | API group of the resource. Specifies which API group the requested object belongs to | [Determining the required Group and Version](#determining-the-required-group-and-version) | +| group | Yes | API group of the resource. Specifies the API group to which the requested object belongs | [Determining the required Group and Version](#determining-the-required-group-and-version) | | version | Yes | API version of the resource | [Determining the required Group and Version](#determining-the-required-group-and-version) | -| resource_type | Yes | Type of the resource to retrieve | - | -| resource_name | Yes | Name of the specific resource to retrieve | - | -| namespace | Yes | Namespace in which the resource is located | - | +| resource_type | Yes | Type of resource to retrieve | - | +| resource_name | Yes | Name of the resource to retrieve | - | +| namespace | Yes | Namespace containing the resource | - | ### Response @@ -36,14 +36,14 @@ On success, the action returns the resource object in the `resource` field. If t | Name | Description | | ------------ | --------------------------------------------------- | -| `resource` | Resource object in Kubernetes format | +| `resource` | Resource object in Kubernetes format | ### Determining the required Group and Version -Each resource type corresponds to its own API group (Group) and version (Version). -The full list of API resources with their groups and versions is provided [in the Kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/). +Each resource type has its own API group (Group) and version (Version). +A complete list of API resources, groups, and versions is available [in the Kubernetes documentation](https://kubernetes.io/docs/reference/kubernetes-api/). -If you don't know which API groups and versions are required, you can use current values. +If you do not know which API groups and versions are required, you can look up the current values. There are several ways to determine them: #### Using the `d8 k` utility @@ -73,12 +73,12 @@ FIELDS: #### Using the documentation 1. Find the resource you need (for example, Deployment). -1. The API Group and version are specified in the header. Example for Deployment: +1. Find the API group and version in the header. For example, for Deployment: ```yaml apiVersion: apps/v1 ``` Here: - * "API Group" is apps; - * "Version" is v1. + * `API Group` is `apps`; + * `Version` is `v1`. diff --git a/content/documentation/admin/actions/nexus/assignnexusprivilege.md b/content/documentation/admin/actions/nexus/assignnexusprivilege.md index 5211a0bc..fc9823ed 100644 --- a/content/documentation/admin/actions/nexus/assignnexusprivilege.md +++ b/content/documentation/admin/actions/nexus/assignnexusprivilege.md @@ -5,7 +5,7 @@ weight: 40 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} AssignNexusPrivilege — assigns privileges to an existing role in Nexus Repository Manager 3. The action retrieves the role's current configuration and merges its existing privileges with the new ones. diff --git a/content/documentation/admin/actions/nexus/assignnexusrole.md b/content/documentation/admin/actions/nexus/assignnexusrole.md index 0863e9bb..0661e63e 100644 --- a/content/documentation/admin/actions/nexus/assignnexusrole.md +++ b/content/documentation/admin/actions/nexus/assignnexusrole.md @@ -5,10 +5,10 @@ weight: 70 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} -AssignNexusRole — assigns roles to an existing user in Nexus Repository Manager 3. The action retrieves the user's current configuration and merges its existing roles with the new ones. +AssignNexusRole — assigns roles to an existing user in Nexus Repository Manager 3. The action retrieves the user's current configuration and merges the user's existing roles with the new ones. ### Request example diff --git a/content/documentation/admin/actions/nexus/createnexusprivilege.md b/content/documentation/admin/actions/nexus/createnexusprivilege.md index 43240528..780b1e5c 100644 --- a/content/documentation/admin/actions/nexus/createnexusprivilege.md +++ b/content/documentation/admin/actions/nexus/createnexusprivilege.md @@ -5,7 +5,7 @@ weight: 30 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} CreateNexusPrivilege — creates a new privilege in Nexus Repository Manager 3. Privileges define access rights to repositories and other Nexus resources. diff --git a/content/documentation/admin/actions/nexus/createnexusrepository.md b/content/documentation/admin/actions/nexus/createnexusrepository.md index 72545a19..a650f4b1 100644 --- a/content/documentation/admin/actions/nexus/createnexusrepository.md +++ b/content/documentation/admin/actions/nexus/createnexusrepository.md @@ -5,11 +5,11 @@ weight: 10 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} `CreateNexusRepository` — creates a new repository of any supported type (maven, docker, npm, etc.) in Nexus Repository Manager 3 using the REST API. -Format, type, and other key settings are fully configurable and match the Nexus API. +The format, type, and other key settings are fully configurable and correspond to the Nexus API. ### Request example (Maven hosted) @@ -58,7 +58,7 @@ docker: | Field | Required | Description | Example | | ------------- | ------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------ | -| description | No | Documentation on the purpose of this action/repository. Not used by Nexus itself, only for the UI | - | +| description | No | Description of the action or repository's purpose. Used only in the UI, not by Nexus itself | - | | name | Yes | Name of the repository to create. Must be unique within Nexus | my-maven-repo | | format | Yes | Format (`maven`, `docker`, `npm`, `raw`, etc.) | maven | | type | Yes | Type: `hosted`, `proxy`, or `group` | hosted | @@ -74,8 +74,8 @@ docker: ### Requirements -- Only use the blocks (`maven`, `group`, `proxy`, `docker`, etc.) that are supported for your type/format. -- For maven hosted, `maven: {versionPolicy, layoutPolicy}` is required. -- For group, `group.memberNames` is required. -- For proxy, `proxy.remoteUrl` is required. -- For docker, specify the docker-specific fields in `docker`. +- Use only the blocks (`maven`, `group`, `proxy`, `docker`, etc.) supported by the selected type and format. +- For Maven hosted repositories, `maven: {versionPolicy, layoutPolicy}` is required. +- For group repositories, `group.memberNames` is required. +- For proxy repositories, `proxy.remoteUrl` is required. +- For Docker repositories, specify the Docker-specific fields in `docker`. diff --git a/content/documentation/admin/actions/nexus/createnexusrole.md b/content/documentation/admin/actions/nexus/createnexusrole.md index 06db96f4..b7a77de7 100644 --- a/content/documentation/admin/actions/nexus/createnexusrole.md +++ b/content/documentation/admin/actions/nexus/createnexusrole.md @@ -5,7 +5,7 @@ weight: 60 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} CreateNexusRole — creates a new role in Nexus Repository Manager 3. Roles combine privileges and can include other roles. diff --git a/content/documentation/admin/actions/nexus/createnexususer.md b/content/documentation/admin/actions/nexus/createnexususer.md index 49d4f6c0..6d2c680e 100644 --- a/content/documentation/admin/actions/nexus/createnexususer.md +++ b/content/documentation/admin/actions/nexus/createnexususer.md @@ -5,7 +5,7 @@ weight: 90 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} CreateNexusUser — creates a new user in Nexus Repository Manager 3. diff --git a/content/documentation/admin/actions/nexus/deletenexusprivilege.md b/content/documentation/admin/actions/nexus/deletenexusprivilege.md index 7ae2236d..87ed38e3 100644 --- a/content/documentation/admin/actions/nexus/deletenexusprivilege.md +++ b/content/documentation/admin/actions/nexus/deletenexusprivilege.md @@ -5,7 +5,7 @@ weight: 50 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} DeleteNexusPrivilege — deletes a privilege from Nexus Repository Manager 3. diff --git a/content/documentation/admin/actions/nexus/deletenexusrepository.md b/content/documentation/admin/actions/nexus/deletenexusrepository.md index 11f45aad..2d36a76a 100644 --- a/content/documentation/admin/actions/nexus/deletenexusrepository.md +++ b/content/documentation/admin/actions/nexus/deletenexusrepository.md @@ -5,7 +5,7 @@ weight: 20 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} `DeleteNexusRepository` — deletes an existing repository from Nexus Repository Manager 3. @@ -24,6 +24,6 @@ name: my-repo-to-delete ### Algorithm -- Performs a `DELETE` request to `/service/rest/v1/repositories/{name}`, where `{name}` is the value of the `name` field. -- If the repository is found and deleted, a 204 is returned. -- If it is not found, a 404 error is returned. +- Sends a `DELETE` request to `/service/rest/v1/repositories/{name}`, where `{name}` is the value of the `name` field. +- If the repository is found and deleted, the request returns status code 204. +- If the repository is not found, the request returns a 404 error. diff --git a/content/documentation/admin/actions/nexus/deletenexusrole.md b/content/documentation/admin/actions/nexus/deletenexusrole.md index 8317e8e5..f5cf81df 100644 --- a/content/documentation/admin/actions/nexus/deletenexusrole.md +++ b/content/documentation/admin/actions/nexus/deletenexusrole.md @@ -5,7 +5,7 @@ weight: 80 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} DeleteNexusRole — deletes a role from Nexus Repository Manager 3. diff --git a/content/documentation/admin/actions/nexus/deletenexususer.md b/content/documentation/admin/actions/nexus/deletenexususer.md index 1d0b0df5..2d3620c8 100644 --- a/content/documentation/admin/actions/nexus/deletenexususer.md +++ b/content/documentation/admin/actions/nexus/deletenexususer.md @@ -5,7 +5,7 @@ weight: 100 {{< alert level="info" >}} -Running this action requires a token — a base64(`admin:password`) string used as Basic Auth for requests to Nexus. +Running this action requires a token — a base64(`admin:password`) string used for HTTP Basic authentication in requests to Nexus. {{< /alert >}} DeleteNexusUser — deletes a user from Nexus Repository Manager 3. diff --git a/content/documentation/admin/actions/overview.md b/content/documentation/admin/actions/overview.md index 5c55c92a..046ca752 100644 --- a/content/documentation/admin/actions/overview.md +++ b/content/documentation/admin/actions/overview.md @@ -4,7 +4,7 @@ description: Action configuration in Deckhouse Development Platform (DDP) — re weight: 10 --- -Actions are a platform mechanism for running operations in external infrastructure systems and services. With actions, for example, you can: +Actions are a platform mechanism for running operations in external infrastructure systems and services. For example, actions can: - create projects, variables, branches, tags, releases, and merge requests in [GitLab](../gitlab/); - create resources in [Kubernetes](../kubernetes/) and retrieve them; @@ -38,7 +38,7 @@ When creating or editing an action, specify the basic information: An action can be of the following types: -- "Built-in" — the action's execution logic is described inside the platform. For built-in actions, you must select one of the preconfigured backends. +- "Built-in (BuiltIn)" — the action's execution logic is defined within the platform. For built-in actions, you must select one of the preconfigured backends. - "Webhook" — the action's execution logic is fully configured by the user. #### Retry parameters @@ -102,7 +102,7 @@ project_id: {{ .property.project_id }} With this request body, the expression `{{ .property.project_id }}` is replaced with the value of the `project_id` parameter that the user entered in the action's launch form. -For built-in action types, the "Request body" parameter is part of the action's configuration, and a sample of this configuration is available. +For built-in actions, the "Request body" parameter is part of the action configuration, and a configuration example is available. ### User form @@ -122,7 +122,7 @@ Each parameter can have a default value that is pre-filled in the form when the For non-editable or hidden parameters, it is recommended to set a default value, since the user will not be able to change them when launching the action. {{< /alert >}} -The parameter description is shown when launching the action by clicking the "info" icon button. It is recommended to fill it in to make it easier to understand the purpose of the parameters and reduce the risk of errors when launching the action. +The parameter description is shown when launching the action by clicking the "info" icon. Providing a description makes the parameter's purpose easier to understand and reduces the risk of errors when launching the action. Parameter values can use [Go template](https://developer.hashicorp.com/nomad/tutorials/templates/go-template-syntax) template functions. For example, the expression `{{ .entity.name }}` in a parameter value means that when the action is launched, the name of the entity it is running for will be substituted. @@ -216,7 +216,7 @@ If the "Create entity relations" option is enabled, the platform automatically c #### User credentials update -If the user credentials update option is enabled, the action automatically updates the user's credentials according to the update rules. +If the user credentials update option is enabled, the action automatically updates the user's credentials according to the specified rules. | Field | Description | | ------------------- | --------------------------------------- | @@ -232,7 +232,7 @@ For example, when running an action that returns a new API key in its response: } ``` -to update the credentials, specify the following update rules: +To update the credentials, specify the following rules: 1. Source: `{{ .response.apiKey }}`. 1. Credentials type: select the type of credentials to be updated. @@ -309,11 +309,11 @@ When approval is enabled, you can enable notifications and specify how they are #### Use external service -Selection of the external services for which the action can be run. If multiple external services are added, a specific one can be selected directly when launching the action. +Select the external services for which the action can be run. If multiple external services are added, a specific service can be selected when launching the action. #### URL and HTTP headers -The address to which the request will be sent, and the HTTP headers. +Specify the address to which the request will be sent and the HTTP headers. Headers support Go templates in the form `{{ .credentials. }}` for substituting user credentials. diff --git a/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md b/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md index ff81af02..7ab790ca 100644 --- a/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md +++ b/content/documentation/admin/actions/sonarqube/createsonarqubeproject.md @@ -4,7 +4,7 @@ weight: 10 --- {{< alert level="info" >}} -Running this action requires a SonarQube token of the User Token type, generated by the user on whose behalf the action will be run. +Running this action requires a SonarQube User Token generated by the user on whose behalf the action will run. {{< /alert >}} CreateSonarqubeProject — creates a new project in SonarQube. diff --git a/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md b/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md index 82eb38bd..0e7f8033 100644 --- a/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md +++ b/content/documentation/admin/actions/sonarqube/deletesonarqubeproject.md @@ -4,7 +4,7 @@ weight: 20 --- {{< alert level="info" >}} -Running this action requires a SonarQube token of the User Token type, generated by the user on whose behalf the action will be run. +Running this action requires a SonarQube User Token generated by the user on whose behalf the action will run. {{< /alert >}} DeleteSonarqubeProject — deletes a project from SonarQube. diff --git a/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md b/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md index 6a67ebf5..32e35b62 100644 --- a/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md +++ b/content/documentation/admin/actions/sonarqube/deletesonarqubeprojects.md @@ -4,7 +4,7 @@ weight: 30 --- {{< alert level="info" >}} -Running this action requires a SonarQube token of the User Token type, generated by the user on whose behalf the action will be run. +Running this action requires a SonarQube User Token generated by the user on whose behalf the action will run. {{< /alert >}} DeleteSonarqubeProjects — deletes one or more projects from SonarQube. diff --git a/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md b/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md index 67205a2c..e1fa8eb9 100644 --- a/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md +++ b/content/documentation/admin/actions/vault/createvaultkubernetesauthrole.md @@ -4,7 +4,7 @@ weight: 30 --- {{< alert level="info" >}} -Running this action requires a Vault token with permissions to create/update Kubernetes auth backend roles. +Running this action requires a Vault token with permission to create or update Kubernetes auth backend roles. {{< /alert >}} CreateVaultKubernetesAuthRole — creates or updates a Kubernetes authentication role in HashiCorp Vault. @@ -36,7 +36,7 @@ optional: | bound_service_account_namespaces | Yes | List of namespaces allowed to access via this role | | optional | No | Additional role parameters (listed in the table below) | -Supported values in optional: +Supported values for `optional`: | Field | Type | Description | | ------------------------- | --------------- | ----------------------------------------------------------------------- | diff --git a/content/documentation/admin/actions/vault/createvaultsecret.md b/content/documentation/admin/actions/vault/createvaultsecret.md index e0d8fee0..b87d8be2 100644 --- a/content/documentation/admin/actions/vault/createvaultsecret.md +++ b/content/documentation/admin/actions/vault/createvaultsecret.md @@ -5,7 +5,7 @@ weight: 10 {{< alert level="info" >}} -Running this action requires a Vault token with the permissions needed to create secrets. +Running this action requires a Vault token with permission to create secrets. {{< /alert >}} CreateVaultSecret — creates a secret with one or more values in HashiCorp Vault. diff --git a/content/documentation/admin/actions/vault/deletevaultsecret.md b/content/documentation/admin/actions/vault/deletevaultsecret.md index 55da80fe..4c0e7daf 100644 --- a/content/documentation/admin/actions/vault/deletevaultsecret.md +++ b/content/documentation/admin/actions/vault/deletevaultsecret.md @@ -5,7 +5,7 @@ weight: 20 {{< alert level="info" >}} -Running this action requires a Vault token with the permissions needed to create secrets. +Running this action requires a Vault token with permission to create secrets. {{< /alert >}} DeleteVaultSecret — deletes a secret from HashiCorp Vault. diff --git a/content/documentation/admin/actions/wait/wait.md b/content/documentation/admin/actions/wait/wait.md index 96149b71..2a8d4243 100644 --- a/content/documentation/admin/actions/wait/wait.md +++ b/content/documentation/admin/actions/wait/wait.md @@ -3,7 +3,7 @@ title: Wait weight: 10 --- -Wait waits for a specified number of seconds; a random addition to the duration (jitter) can optionally be applied. Intended for use in processes as a delay element, including for waiting until the results of a previous action have been applied. +Wait pauses execution for a specified number of seconds and can optionally add a random duration (jitter). It is intended for use in processes as a delay element, including while waiting for the results of a previous action to be applied. ### Request example