Quick Start Guide

The SSD Scanner CLI is a lightweight tool developed by OpsMx for performing secure software delivery (SSD) scans from customer environments. This page covers system requirements, installation steps and post-installation verification for a quick start with SSD.

SSD Hybrid Architecture

The SSD solution operates in a hybrid model: scanning runs inside the customer environment, and results are securely transmitted to the central SSD platform.

Key Components:

• Customer Environment

• On-prem CLI or CI/CD Webhook initiates scans.

• Targets include applications, container images, and Kubernetes clusters.

• Scan requests and results flow securely to the SSD environment.

• SSD Environment

• Core components: SSD Gate, SSD Service, SSD OPA, Toolchain, Dgraph, and supporting services (RabbitMQ, Temporal, Postgres, MinIO/S3).

• Results and vulnerability data are stored in SSD Vuln DB and SSD OSS DB.

• Communication Path

• The CLI securely connects over HTTPS to the SSD Gate endpoint (e.g., https://ssd.opsmx.net).

• No inbound connectivity to customer environments is required.

System Requirements

Category	Requirement	Details
Operating System	Ubuntu 20.04 / 22.04	Supported architectures: amd64, arm64
User Access	Sudo privileges	Required for package installation and binary copy
Disk Space	≥ 500 GB	For CLI and temporary data
Memory	≥ 32 GB	Recommended: 32 GB or higher
Dependencies	curl, sudo	Installed automatically if missing

Installation Steps

Execute the below command on your Ubuntu VM:

curl -L -o install_ssd_scanner_cli.sh https://raw.githubusercontent.com/OpsMx/ssd-scanner-cli-public/refs/heads/main/install_ssd_scanner_cli.sh && chmod +x install_ssd_scanner_cli.sh && ./install_ssd_scanner_cli.sh

This command does the following:

1. Downloads the official installation script from the OpsMx GitHub repository.

2. Installs prerequisites (curl, sudo) if not already present.

3. Detects your system architecture (amd64 or arm64).

4. Downloads the appropriate CLI binary.

5. Copies the binary to /usr/local/bin.

6. Verifies that the installation completed successfully.

Post-Installation Verification

After installation, confirm the CLI is available:

ssd-scanner-cli --help

Displays all available commands and options.

Connectivity Test

Before performing scans, verify that your environment can reach the SSD endpoint:

curl -I https://<SSD_URL>

A 200 OK or 302 Found response confirms successful connectivity.

Troubleshooting

Below are few issues you may face and the resoltion for it:

Issue	Possible Cause	Resolution
curl: (6) Could not resolve host	DNS or firewall block	Check DNS or whitelist required endpoints
Permission denied	User lacks sudo	Run as sudo user
Failed to download	GitHub or SSD endpoint blocked	Verify outbound access
command not found	Binary not in PATH	Run sudo cp ssd-scanner-cli /usr/local/bin