Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
nleach999 committed May 16, 2024
1 parent 73270c4 commit 62806c3
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions manual/operation/deployment.tex
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,28 @@ \section{\cxoneflow Execution}

\noindent\\This executes the container with your defined \texttt{config.yml}, mapping a local directory
containing secrets files to \texttt{/run/secrets}, and exposing port 8000 locally for receipt of
webhook payloads.
unencrypted webhook payloads.




\section{Deployment Considerations}

The \cxoneflow container is stateless, listens on port 8000 for unencrypted webhook event delivery,
and listens on port 8443 for encrypted webhook event delivery. It is possible to map port 80 and 443
externally to the internal container ports.
externally to the internal container ports. A default self-signed SSL certificate will be used
for encrypted traffic via port 8443 unless a custom SSL certificate configuration is provided.

The number of CPU cores on the host where the container is executing may be over-allocated to other
containers or processes. Having the container use a high number of worker processes for an over-allocated
host will make the performance worse. It is suggested that the \cxoneflow instances are scaled
to run on different physical hosts to ensure availability. This will mean you'll need to place the
\cxoneflow host endpoints behind a load balancer. The \cxoneflow endpoint \texttt{/ping} is available
for monitoring each running instance to ensure it is alive.
host will degrade performance. The operation of \cxoneflow is not computationally intense
but it does perform rapid network and disk I/O when cloning source code and communicating with
remote system APIs.

It is suggested that the \cxoneflow instances are scaled to run on different physical hosts to
ensure availability. This will mean you'll need to place the \cxoneflow host endpoints behind
a load balancer. The \cxoneflow endpoint \texttt{/ping} is available for monitoring each
running instance to ensure it is alive.



0 comments on commit 62806c3

Please sign in to comment.