Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Page Navigation:

Table of Contents
maxLevel1

(blue star) Confidence Level Moderate  This article includes input from several JPLers. Multiple subject matter experts can indicate that a page is more frequently reviewed and updated.


The Science Data System (SDS) command line interface provides numerous functions for operators to interact with HySDS components.

Accessing the SDS CLI:

First, ssh
  1. SSH into Mozart

using a pem file with appropriate permissionsIf a message appears stating the authenticity of the host IP can’t be established, and if you want to continue connecting, type: yes
  1. as the hydsops user.

  2. Once connected, input the command: sds (#1) to display a list of possible commands (#2) available for the sds cli. It looks like this:

    Image Modified
Figure 1: (#1) sds command to display positional arguments, (#2) list of arguments

Status

Enter sds status to show the status of the HySDS components, including: RabbitMQ, Redis, and Elasticsearch (#3). Here is an example status output:

Figure 2: (#3) Elasticsearch status in sds cli

Start

The sds start command starts all supervisord services. Examples include: sds start all, sds start mozart, sds start factotum, sds start metrics, & sds start grq.

Stop

The sds stop command shuts down all system services and all supervisor services on every machine. Examples include: sds stop all, sds stop grq, sds stop mozart, sds stop factotum, & sds stop metrics.

Restart

The sds restart command …. restarts all system services. Examples include: sds restart all, sds restart grq, sds restart mozart, sds restart factotum, & sds restart metrics.

Reset

Note

Reset is an advanced command; only use it when you need to. Generally not used by operators.

The sds reset command clears out all the jobs and tasks from Mozart. This command is useful when things are stuck; reset clears out all previous runs. Examples include: sds reset all, sds reset grq, sds reset mozart, sds reset factotum, & sds reset metrics.

Supervisord

When you don’t want to use the sds cli, and want to to do something more sophisticated. Supervisord is a process watcher. Generally when a worker is isn’t running properly. It abstracts away the details of the components for the operator.

{{A process manager,

Note

There is a known issue where it leaves a sock file. (There is a ssh workaround)

supervisorctl update = Reload config and add/remove as necessary, and will restart affected programs.

supervisorctl reread = Reload the daemon’s configuration files, without add/remove (no restarts)

supervisorctl status = Get all process status info.

supervisorctl stop all = Stop all processes

supervisorctl start all = Start all processes

supervisorctl help<action> = Print help for <action>

Info

For additional supervisorctl command: http://supervisord.org/running.html


(lightbulb) Have Questions? Ask a HySDS Developer:

Anyone can join our public Slack channelto learn more about HySDS. JPL employees can join #HySDS-Community

(blue star)

JPLers can also ask HySDS questions atStack Overflow Enterprise

(blue star)

Live Search
placeholderSearch HySDS Wiki