Skip to content

Commit

Permalink
[EDP-DDM-28658] github: issue 60, updated rest integration docs, adde…
Browse files Browse the repository at this point in the history
…d reference example notes, updated diagrams, removed old comments and added minor fixes

Change-Id: I03667b7fbb2c640b28c153e58577a7654f103118
(cherry picked from commit c462093d6755a1c0ff3a603c9de62e1f81517fd9)
  • Loading branch information
[email protected] committed Oct 11, 2023
1 parent 13029fc commit 3a6d128
Show file tree
Hide file tree
Showing 11 changed files with 113 additions and 220 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@ include::platform:ROOT:partial$templates/document-attributes/arch-set-en.adoc[]
include::platform:ROOT:partial$admonitions/language-en.adoc[]

== Definitions
//Інсталятор:: набір програмних засобів для розгортання Платформи
Installer:: a set of software tools for deploying the Platform

//Для розгортання Платформи управління реєстрами застосовується Інсталятор, який постачається у вигляді zip архіву
To deploy the Registry Management Platform, the Installer is used, which is delivered in the form of a zip archive
*_Installer_* is a set of software tools for deploying the Platform

//Структура Інсталятору:
Structure of the Installer:
The Installer is used to deploy the Platform for state registries, which is delivered as a zip archive.

.Installer structure
[plantuml, structure, svg]
----
@startuml
Expand Down Expand Up @@ -67,9 +65,9 @@ package "Installer" as installer {
@enduml
----


//== Діаграма послідовності розгортання платформи
== Platform deployment sequence diagram

.Platform deployment sequence diagram
[plantuml, install_flow, svg]
----
@startuml
Expand All @@ -87,8 +85,8 @@ autonumber
title Platform deployment sequence diagram
group Preparing the Installer for deployment
devops -> jumpbox: Downloading the Installer archive
devops -> jumpbox: Downloading certificates digital-signature-ops
devops -> jumpbox: Uploading the Installer archive
devops -> jumpbox: Uploading certificates digital-signature-ops
devops -> jumpbox: Server readiness check (prerequisites)
devops -> docker_load: Authentication in Openshift
devops -> docker_load: Setting parameters (env)
Expand All @@ -105,16 +103,17 @@ install.sh -> minio: Deployment Minio
install.sh -> openshift: Downloading docker images in nexus (control-plane-nexus)
install.sh -> openshift: Deployment of user-management and downloading digital-signature-ops certificates
install.sh -> openshift: Deployment Control Plane
install.sh -> openshift: Downloading xsd in nexus (control-plane-nexus)
install.sh -> openshift: Downloading access parameters in Minio
install.sh -> openshift: Loading xsd in nexus (control-plane-nexus)
install.sh -> openshift: Loading access parameters in Minio
devops -> jumpbox: Checking the log and saving the Control Plane access parameters in a safe place
end
@enduml
----

//== Діаграма послідовності оновлення платформи
== Platform upgrade sequence diagram

.Platform upgrade sequence diagram
[plantuml, update_flow, svg]
----
@startuml
Expand All @@ -132,8 +131,8 @@ autonumber
title Platform deployment sequence diagram
group Preparing the Installer for deployment
devops -> jumpbox: Downloading the Installer archive
devops -> jumpbox: Downloading certificates digital-signature-ops
devops -> jumpbox: Uploading the Installer archive
devops -> jumpbox: Uploading digital-signature-ops certificates
devops -> jumpbox: Server readiness check (prerequisites)
devops -> docker_load: Authentication in Openshift
devops -> docker_load: Setting parameters (env)
Expand All @@ -146,53 +145,35 @@ install.sh -> vault: Status update Vault
install.sh -> minio: Status update Minio
install.sh -> openshift: Downloading docker images in nexus (control-plane-nexus)
install.sh -> openshift: Deployment of Control Plane
install.sh -> openshift: Downloading xsd in nexus (control-plane-nexus)
install.sh -> openshift: Downloading access parameters in Minio
install.sh -> openshift: Uploading xsd in nexus (control-plane-nexus)
install.sh -> openshift: Uploading access parameters in Minio
devops -> jumpbox: Checking the log and the correctness of the update
end
@enduml
----
////
== Опис модулів Інсталятора (functions.sh)
INIT-CHECK:: перевірка необхідних параметрів та наявності сертифікатів digital-signature-ops (тільки для початкового розгортання)
ENCRYPTION-ETCD:: налаштування шифрування ETCD та затвердження сертифікатів Openshift
INSTALL-CLUSTER-MGMT:: розгортання базових компонент cluster-mgmt
* catalog-source
* storage
* keycloak-operator-crd (підкомпонент control-plane-installer)
* logging
* service-mesh
INSTALL-NEXUS:: розгортання control-plane-nexus (сховище докер образів та xsd)
VAULT-INSTALL:: розгортання центрального Vault
MINIO-INSTALL:: розгортання центрального Minio
INIT-NEXUS:: завантаження докер образів
INSTALL-ADDITIONAL-COMPONENTS:: завантаження digital-signature-ops сертифікатів та розгортання user-management
INSTALL-CONTROL-PLANE:: розгортання компонент Control Plane
NEXUS-RESOURCE-UPLOAD:: завантаження nexus ресурсів (xsd)
BACKUP-CREDENTIALS:: параметрів доступу в Minio
USAGE:: допоміжний модуль для виводу інформації про використання install.sh
////
== Installer modules description (functions.sh)

== Installer modules description (_functions.sh_)

INIT-CHECK:: checking the necessary parameters and availability of certificates digital-signature-ops (for initial deployment only)

ENCRYPTION-ETCD:: setting up ETCD encryption and validating Openshift certificates
INSTALL-CLUSTER-MGMT:: deployment of basic components cluster-mgmt
* catalog-source
* storage
* keycloak-operator-crd (subcomponent control-plane-installer)
* logging
* service-mesh

INSTALL-NEXUS:: deployment of control-plane-nexus (docker image repository and xsd)
VAULT-INSTALL:: deployment of central Vault
MINIO-INSTALL:: deployment of central Minio

INSTALL-CLUSTER-MGMT:: deploying basic components of the `cluster-mgmt`:
* `catalog-source`
* `storage`
* `keycloak-operator-crd` (subcomponent of the `control-plane-installer`)
* `logging`
* `service-mesh`

INSTALL-NEXUS:: deploying `control-plane-nexus` (docker image repository and xsd)

VAULT-INSTALL:: deploying the central Vault
MINIO-INSTALL:: deploying the central Minio
INIT-NEXUS:: loading docker images
INSTALL-ADDITIONAL-COMPONENTS:: downloading of digital-signature-ops certificates and deployment of user-management
INSTALL-CONTROL-PLANE:: deployment of Control Plane components
NEXUS-RESOURCE-UPLOAD:: downloading of nexus resources (xsd)
INSTALL-ADDITIONAL-COMPONENTS:: uploading `digital-signature-ops` certificates and deploying `user-management`
INSTALL-CONTROL-PLANE:: deploying the Control Plane components
NEXUS-RESOURCE-UPLOAD:: uploading nexus resources (xsd)
BACKUP-CREDENTIALS:: access parameters in Minio
USAGE:: auxiliary module for displaying usage information install.sh
USAGE:: auxiliary module for displaying usage information _install.sh_
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Standard integration connectors/extensions, or *Element Templates*, are meant to
[%collapsible]
._Business process extensions catalog_
====
* [*] xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[Типові розширення для користувацьких задач (User task templates)]
* [*] xref:bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc[Типові розширення для сервісних задач (Service task templates)]
* [*] xref:registry-develop:bp-modeling/bp/element-templates/user-task-templates/user-task-overview.adoc[User task templates]
* [*] xref:bp-modeling/bp/element-templates/service-task-templates/service-task-overview.adoc[Service task templates]
* [*] xref:bp-modeling/bp/element-templates/call-activities/call-activities-overview.adoc[]
* [*] xref:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[Типові розширення для інтеграції з іншими реєстрами на Платформі]
* [*] xref:bp-modeling/bp/element-templates/rest-integration-registries/rest-integration-registries-overview.adoc[]
====
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ You can check whether the Service Entry was created using the `*ServiceEntries*`
. In the *Filter by kind* search field, search for `ServiceEntry` and select the corresponding service.
+
image:registry-develop:bp-modeling/bp/rest-connector/rest-connector-1.png[]
+

. From the *Project* dropdown list, select the registry that will use the external service.
. Open the *Instances* tab and find the required `ServiceEntry`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,14 @@ To start a business process in your registry, the system needs to accept the inc
.Accepting the process start variables in a target registry
image::registry-admin/external-integration/rest-api-no-trembita/accept-map-params-bp.png[]
====

[TIP]
====
[%collapsible]
.Where can I find an example of a reference business process?
=====
include::partial$snippets/demo-reg-reference-examples-en.adoc[]

An example of a BPMN process diagram will be available in the demo-registry's regulations by searching for the keywords -- *_create-school-auto-sign_*. The names of the forms can be found inside the corresponding User Tasks of the business process in the *`Form key`* field.
=====
====
Loading

0 comments on commit 3a6d128

Please sign in to comment.