openstead
Deploy and operate

Shell access and one-off jobs

Inspect a running application or execute a tracked command using its release environment.

Suggest a change

Openstead provides two ways to execute application commands: an interactive shell inside a running instance and a one-off command in a fresh execution container. Both require an eligible active paid application service and permission to operate it.

Open an interactive shell

  1. Open the service's Shell page.
  2. Select an available instance if the service has several.
  3. Connect and run the diagnostic command.
  4. Disconnect when finished.

The session is attached to the selected live instance. It can inspect files and mounted data visible to that instance. Commands can change production state, so treat the shell with the same care as application administration.

Sessions expire after 20 minutes. An account can have two active terminal sessions at a time. If a deployment replaces the instance, refresh the instance list and reconnect.

Run a one-off command

Use Run a command or One-Off Jobs for a command that should execute with the current release image and environment and retain its output and exit status.

Examples include:

python manage.py check --deploy
php artisan migrate:status

Each one-off command runs in a fresh container with access to the permitted private network. It does not share the running application's writable filesystem or persistent disk. Files created in that execution are not a way to update the deployed application's source or upload directory.

Use a deployment's pre-deploy command for migrations that must gate a release. Use a cron job for a repeating schedule.

Availability by service

ServiceInteractive shellOne-off application commands
Paid running web service, private service, or workerYes, when a live instance is availableYes
Static releaseNo application containerNo application container
Cron jobNo permanent instanceUse its run controls and history
Managed databaseNo application shellUse its database connection or management tools
Free web instanceRequires an upgradeRequires an upgrade

For MySQL administration, see MySQL. Do not use application shell credentials as a replacement for database access controls.

Make lasting changes through deployments

Editing source code in a shell is temporary and bypasses your repository history. Commit the change to Git and deploy it. Store durable application data in its database, persistent disk, or object storage, and take an appropriate backup before changing production records.

Need a hand? Contact Openstead support.

On this page