Skip to content

Commit

Permalink
Add missing ports documentation
Browse files Browse the repository at this point in the history
Request: DCS-1159
Change-Id: I44ae455b6d0d9932946639a4801c85984750c253
  • Loading branch information
mduft committed Sep 11, 2020
1 parent fd323ab commit c817b1c
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/user/chapters/power/product.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,9 @@ The fixed flag will cause the parameter to *always* use the defined default valu
|`type`
|`STRING`
|no
|Type of parameter. This defines the type of input field used to edit the parameter. Available are `STRING`, `NUMERIC`, `BOOLEAN`, `PASSWORD`.
a|Type of parameter. This defines the type of input field used to edit the parameter. Available are `STRING`, `NUMERIC`, `BOOLEAN`, `PASSWORD`, `CLIENT_PORT`, `SERVER_PORT`

The `CLIENT_PORT` and `SERVER_PORT` types are treated like `NUMERIC` parameters throughout the whole application, with the exception of the dialogs that deal with ports specifically.

|`condition`
|
Expand Down
8 changes: 8 additions & 0 deletions doc/user/chapters/user/instance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,11 @@ image::images/BDeploy_Instance_Template_Dialog_Variables.png[Instance Template D
Clicking btn:[Next] and then btn:[Close] once the template has been applied will create the processes defined in the template. The configuration will *not* be saved automatically, to allow further tuning of the configuration before doing so.

image::images/BDeploy_Instance_Template_Processes.png[Instance Template Dialog Variables,align=center,width=480,link="images/BDeploy_Instance_Template_Processes.png"]

==== Configure Ports

The *Configure Ports* page can be reached from the *Instance* context menu. This page provides a concise overview of all ports (`CLIENT_PORT` and `SERVER_PORT` parameters) used in the *Instance*.

You can edit port assignments directly from this dialog. The *Shift Ports* action allows to bulk edit port parameters and shift them upwards or downwards by a given offset.

The *Export CSV* action allows to export a CSV list of all ports configured in the system. This can be used to pass on information to external partners, for instance for further firewall configuration, etc.
8 changes: 8 additions & 0 deletions doc/user/chapters/user/processcontrol.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,14 @@ Clicking on the terminal icon displayed below the process control actions will o

image::images/BDeploy_Process_Output.png[Show and Follow Process Output,align=center,width=480,link="images/BDeploy_Process_Output.png"]

==== Server Ports

The applications server ports (if any are defined) and their state on the target minion can be viewed by clicking on the plug icon below the process controls. Each parameter of type `SERVER_PORT` is displayed here, with its description and configured value. The state is either a warning icon (port not open) or a green check ico (port is open). "Open" just means that the port is used on the target system currently. *BDeploy* cannot check whether the port was opened by the correct application.

===== Server Ports per Node

The same list of `SERVER_PORT` parameters can be found on a node as well. This will allow to view all port states for all applications configured to that node.

==== Process listing

Clicking on the gear icon below the process control will open a popup showing all operating system processes that have been started by this *Process*.
Expand Down

0 comments on commit c817b1c

Please sign in to comment.