4 Workflow Designer is a [pluggable SDC designer](https://wiki.onap.org/display/DW/Generic+Designer+Support) that allows
5 a user to design a workflow, save it, and attach it to a SDC service as an artifact. Workflow Designer also manages
6 the definitions of activities, which can be later used as parts of the designed workflows.
11 The designer is comprised of the following deployment units:
13 - Designer backend is the core component. It exposes RESTful APIs for managing workflow and activity data. The backend
14 is agnostic to the type of a workflow artifact — its main concerns are workflow inputs and outputs, and metadata.
15 One of the APIs enables to attach a certified workflow artifact to a SDC service, therefore the designer must be able
16 to call an API on SDC. In order to do so, the location of a SDC server, and
17 [SDC consumer](https://wiki.onap.org/display/DW/Consumer+creation) credentials are required.
19 - Designer frontend serves static content of a Web application for creating and managing workflows, and forwards API
20 requests to the backend. The static content includes JavaScript, images, CSS, etc. A major part of the Web application
21 is Workflow Composition View — a graphical interface for arranging a workflow sequence. The Web application also produces a
22 workflow artifact that will be sent to the backend, saved along with other data, and later used by a service. The architecture
23 allows for different implementations of the frontend component. For example, a different technology can be used for the
24 Composition View, which will probably also result in a different type of the artifacts (e.g. Bpmn.io vs. Camunda).
26 - Cassandra database is used by the designer backend as the main storage for workflow data. A dedicated instance of
27 Cassandra can be deployed, or an existing cluster may be used.
29 - Database initialization scripts run once per deployment to create the necessary Cassandra keyspaces and tables, pre-populate data, etc.
34 The procedure below describes manual deployment on plain Docker for development or a demo.
38 Create a dedicated instance of Cassandra. This step is optional if you already have a Cassandra cluster.
39 The designer is not expected to have problems working with Cassandra 3.x, but has been tested with 2.1.x because this is the version used by
42 An easy way to spin up a Cassandra instance is using a Cassandra Docker image as described in the
43 [official documentation](https://hub.docker.com/_/cassandra/).
47 `docker run -d --name workflow-cassandra cassandra:2.1`
49 ## 2. Database Initialization
51 **WARNING**: *This step must be executed only once.*
53 `docker run -ti -e CS_HOST=<cassandra-host> -e CS_PORT=<cassandra-port> -e CS_AUTHENTICATE=true/false
54 -e CS_USER=<cassandra-user> -e CS_PASSWORD=<cassandra-password> nexus3.onap.org:10001/onap/workflow-init:latest`
56 ### Environment Variables
58 - CS_HOST — Cassandra hostname or IP address.
60 - CS_PORT — Cassandra Thrift client port. If not specified, the default of 9160 will be used.
62 - CS_AUTHENTICATE — whether password authentication must be used to connect to Cassandra. A *false* will be
63 assumed if this variable is not specified.
65 - CS_USER — Cassandra username if CS_AUTHENTICATE is *true*.
67 - CS_PASSWORD — Cassandra password if CS_AUTHENTICATE is *true*.
71 Assuming you have created a dedicated Cassandra container as described in Database section, and the access to it is not
72 protected with a password, the following command will initialize the database:
74 `docker run -d --name workflow-init
75 -e CS_HOST=$(docker inspect workflow-cassandra --format={{.NetworkSettings.IPAddress}})
76 nexus3.onap.org:10001/onap/workflow-init:latest`
80 In order to see if the Workflow Designer was successfully initialized, make sure the console does not contain error messages.
81 You can also see the logs of the initialization container using `docker logs workflow-init` command.
85 `docker run -d -e SDC_PROTOCL=http/https -e SDC_ENDPOINT=<sdc-host>:<sdc-port> -e SDC_USER=<sdc-username>
86 -e SDC_PASSWORD=<sdc-password> -e CS_HOSTS=<cassandra-hosts> -e CS_PORT=<cassandra-port>
87 -e CS_AUTHENTICATE=true/false -e CS_USER=<cassandra-user> -e CS_PASSWORD=<cassandra-password>
88 -e JAVA_OPTIONS=<jvm-options> nexus3.onap.org:10001/onap/workflow-backend:latest`
90 ### Environment Variables
92 - SDC_PROTOCOL — protocol to be used for calling SDC APIs (http or https).
94 - SDC_ENDPOINT — the base path of SDC external API, in the format `host:port`, where *host* is a SDC backend server, and *port* is usually 8080.
96 - SDC_USER — Workflow consumer username
98 - SDC_PASSWORD — Workflow consumer password
100 - CS_HOSTS — comma-separated list of Cassandra hostnames or IP addresses.
102 - CS_PORT — CQL native client port. If not specified, the default of 9042 will be used.
104 - CS_AUTHENTICATE — whether password authentication must be used to connect to Cassandra. A *false* will be
105 assumed if this variable is not specified.
107 - CS_USER — Cassandra username if CS_AUTHENTICATE is *true*.
109 - CS_PASSWORD — Cassandra password if CS_AUTHENTICATE is *true*.
111 - JAVA_OPTIONS — optionally, JVM (Java Virtual Machine) arguments.
115 Assuming you have a dedicated Cassandra container as described in Database section, and the access to it is not
116 protected with a password. The following command will start a backend container:
118 `docker run -d --name workflow-backend -e SDC_PROTOCOL=http
119 -e SDC_ENDPOINT=$(docker inspect sdc-BE --format={{.NetworkSettings.IPAddress}}):8080
120 -e CS_HOSTS=$(docker inspect workflow-cassandra --format={{.NetworkSettings.IPAddress}})
121 -e SDC_USER=workflow -e SDC_PASSWORD=<secret> -e JAVA_OPTIONS="-Xmx128m -Xms128m -Xss1m"
122 nexus3.onap.org:10001/onap/workflow-backend:latest`
126 In order to verify that the Workflow Designer backend has started successfully, check the logs of the
127 backend container. For example, by running `docker logs workflow-backend`. The logs must not contain any
130 Application logs are located in the */var/log/ONAP/workflow-designer/backend* directory of a workflow backend
131 container. For example, you can view the audit log by running
132 `docker exec -ti workflow-backend less /var/log/ONAP/workflow-designer/backend/audit.log`.
136 `docker run -d -e BACKEND=http://<backend-host>:<backend-port> -e JAVA_OPTIONS=<jvm-options>
137 nexus3.onap.org:10001/onap/workflow-frontend:latest`
139 - BACKEND — root endpoint of the RESTful APIs exposed by a workflow backend server.
141 - JAVA_OPTIONS — optionally, JVM (Java Virtual Machine) arguments.
145 `docker run -d --name workflow-frontend
146 -e BACKEND=http://$(docker inspect workflow-backend --format={{.NetworkSettings.IPAddress}}):8080
147 -e JAVA_OPTIONS="-Xmx64m -Xms64m -Xss1m" -p 9088:8080 nexus3.onap.org:10001/onap/workflow-frontend:latest`
149 Notice that port 8080 of the frontend container has been
150 [mapped]( https://docs.docker.com/config/containers/container-networking/#published-ports) to port 9088 of the host
151 machine. This makes the Workflow Designer Web application accessible from the outside world via the host machine's
156 In order to check if the Workflow Designer frontend has successfully started, look at the logs of the
157 frontend container. For example, by running `docker logs workflow-frontend`. The logs should not contain
160 Workflow frontend does not have backend logic, therefore there are no application logs.
162 SDC Plugin Configuration
163 ========================
165 In order to run as an SDC pluggable designer, Workflow Designer must be added to SDC configuration as described in
166 [Generic plugin support](https://wiki.onap.org/display/DW/Generic+Designer+Support).
168 If you are deploying SDC using a standard procedure (OOM or the
169 [SDC shell script](https://wiki.onap.org/display/DW/Deploying+SDC+on+a+Linux+VM+for+Development)),
170 the easiest way to configure the Workflow plugin is to edit the *default_attributes/Plugins/WORKFLOW*
171 section of *AUTO.json*.
175 The main endpoint to load Workflow Designer Web application is defined by `"pluginSourceUrl": "http://<host>:<port>"`.
177 Keep in mind that the URL **must be accessible from a user's browser**. In most cases, `<host>` will be the hostname or
178 IP address of the machine that runs Docker engine, and `<port>` will be a host port to which you have published port
179 8080 of the Workflow frontend container.
183 In order to check the availability of a plugin, SDC uses `"pluginDiscoveryUrl"`. For Workflow the value is
184 `http://<host>:<port>/ping`.
188 Let's assume that hostname of the machine that runs Docker containers with the Workflow application is
189 *workflow.example.com*, and port 8080 of the Workflow frontend is mapped to 9088 on the host. In this case the corresponding
190 section of *AUTO.json* will look like below:
196 "workflow_discovery_url": "http://workflow.example.com:9088/ping",
197 "workflow_source_url": "http://workflow.example.com:9088"