CLI: System

The system command suite manages the DSO environment, including plugin installation and diagnostics. This is primarily used for Cloud Mode.

Subcommands

1. system setup

Installs or updates DSO providers (plugins) on the host. Requires root privileges.

docker dso system setup [flags]

Flags:

--providers

Comma-separated list of providers (aws, azure, vault, huawei)

--all

Install all available providers

--no-verify

Skip SHA256 integrity checks (not recommended)

Examples:

docker dso system setup --providers aws,azure
docker dso system setup --all

2. system doctor

Performs a comprehensive diagnostic check of the DSO installation and runtime environment.

docker dso system doctor

Checks Performed:

  • Binary Integrity: Verifies the DSO plugin hash
  • Mode Detection: Identifies if the system is in Local or Cloud mode
  • Vault Status: Checks accessibility of the local vault
  • Plugin Health: Verifies connectivity for each installed provider
  • Systemd Status: Checks if the DSO agent daemon is running (Cloud Mode)

Example:

docker dso system doctor

Example Output

# System Setup Output
[INFO] Installing DSO providers...
[OK] AWS provider installed
[OK] Azure provider installed
[INFO] Setting up systemd service...
[OK] Service registered
# System Doctor Output
✓ Binary Integrity: OK
✓ Mode: Cloud Mode
✓ Vault Status: Accessible
✓ AWS Provider: Connected
✓ Azure Provider: Connected
✓ Agent Daemon: Running

Supported Providers

AWS Secrets Manager
Azure Key Vault
HashiCorp Vault
Huawei Cloud KMS

Cloud Mode Setup Workflow

# 1. Install provider plugins
docker dso system setup --providers aws
# 2. Verify installation
docker dso system doctor
# 3. Configure dso.yaml with provider details
# dso.yaml:
provider: aws
region: us-west-2
vault: my-secrets-vault
# 4. Deploy with cloud-sourced secrets
docker dso up -d

Best Practices

  • Run system setup before switching to Cloud Mode
  • Use system doctor to diagnose issues
  • Only install providers you need (smaller footprint)
  • Verify provider connectivity after setup

Troubleshooting

Plugin Installation Failed

Run docker dso system doctor to check binary integrity and permissions.

Provider Connectivity Issues

Verify provider credentials and network access. Use --debug flag for detailed logs.

Related Commands