StackStorm/st2

st2ctl in Docker environment

Open

#4,988 opened on Jul 9, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,794 stars) (740 forks)batch import
Dockerenhancementgood first issuehelp wanted

Description

st2ctl assumes it's running in a VM environment and wasn't designed to be executed inside the Docker. We'll need to improve that.

Because listing processes or starting services is not viable in a Docker environment, where each service runs in its own Docker container, st2ctl needs a simple modification so it doesn't try to query list of processes but instead suggest to use Docker cmd.

Example commands which don't work in Docker environment:

  • st2ctl status
  • st2ctl stop
  • st2ctl start
  • st2ctl restart
  • st2ctl restart-component
  • st2ctl reopen-log-files
  • st2ctl reload lists running processes as well

Contributor guide

Tech stack
pythondockershell
Domain
devopscli
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
DockerPythonShell
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
The issue requires modifying the `st2ctl` script to detect when it is running in a Docker environment (e.g., by checking for the presence of `/.dockerenv` or the container environment variable). Once detected, the tool should output Docker specific commands (e.g., `docker ps`, `docker restart`) instead of attempting to manage services via system commands like `supervisorctl`. The contributor should examine the current `st2ctl` script (likely a shell script in the repository) to understand how it handles process management and then add a conditional block for Docker. There are no existing PRs or comments to reference.