Skip to content

Administrate the DPF Services

The services of an DPF system can be administrated by DPF CLI using the dpf service command.

Requirements

For the requirements for using DPF CLI, refer to DPF CLI.

Commands

Usage: dpf service [options] [command]

Options:
  -V, --version                 output the version number
  -h, --help                    display help for command

Commands:
  start [services...]           start services

    arguments:
      services: the list of service names
        use '-' for pipe
  stop [options] [services...]  stop services

    arguments:
      services: the list of service names
        use '-' for pipe
  status [services...]          print status of services

    arguments:
      services: the list of service names
        use '-' for pipe
  help [command]                display help for command

For all commands, pipe | can be used with the output but needs to be escaped by -, e. g. -|.

help

help displays the help for the command.

Usage: dpf service help [command]

start

start starts the DPF services, either the whole DPF, a specific service or a list of services.

Usage: dpf service start [services...]

Arguments:

  • services: list of service names, optional

Examples:

  • dpf service start

    Starts all services belonging to Digital Process Factory.

  • dpf service start seal-dpf-jobcleaner

    Starts the seal-dpf-jobcleaner service.

  • dpf service start seal-dpf-jobcleaner seal-dpf-wuwait

    Starts the services seal-dpf-jobcleaner and seal-dpf-wuwait.

status

status prints the status of the DPF services, either for the whole DPF, a specific service or a list of services.

Usage: dpf service status [services...]

Arguments:

  • services: list of service names, optional

Examples:

  • dpf service status

    Checks the status of the complete DPF system.

  • dpf service status seal-dpf-jobcleaner

    Checks the status of seal-dpf-jobcleaner service.

  • dpf service status seal-dpf-jobcleaner seal-dpf-wuwait

    Checks the status of the services seal-dpf-jobcleaner and seal-dpf-wuwait.

stop

stop stops the DPF services, either the whole DPF, a specific service or a list of services.

Usage: dpf service stop [options] [services...]

Arguments:

  • services: list of service names, optional

Options:

  • --full: Stops all services including the infrastructure.
  • --mongo <value>: Url to local MongoDB (default: mongodb://localhost:27017/test)

Examples:

  • dpf service stop

    Stops all services belonging to Digital Process Factory. The third-party components such as MongoDB, Consul and NATS will be still running.

  • dpf service stop --full

    Stops all services belonging to Digital Process Factory and the third-party components such as MongoDB, Consul and NATS.

    Caution - potentially dangerous

    Stopping infrastructure services will cause problems with other products that also depend on them.

  • dpf service stop seal-dpf-jobcleaner

    Stops the seal-dpf-jobcleaner service.

  • dpf service stop seal-dpf-jobcleaner seal-dpf-wuwait

    Stops the services seal-dpf-jobcleaner and seal-dpf-wuwait.

Back to top