Quick SMB deployment workflow

You can deploy SMB services using multiple methods to match your operational preferences and infrastructure requirements. Deployment options include CLI-based commands, YAML specification files, or the dashboard interface.

Overview

Each deployment method offers distinct advantages for different use cases:

  • CLI-based deployment provides direct control for quick setups and troubleshooting.
  • YAML-based deployment enables reproducible configurations for production environments.
  • Dashboard-based deployment offers a visual interface for users who prefer graphical management tools.

Deployment workflow

The following diagram illustrates the SMB deployment workflow and the available deployment methods:
Figure 1. SMB deployment workflow
Diagram showing three SMB deployment methods: CLI-based, YAML-based, and Dashboard-based deployment workflows

SMB deployment methods

You can deploy SMB using one of the following approaches.

CLI-based deployment (imperative method)

Use command-line interface commands to create and manage SMB clusters and shares step-by-step. This method provides direct control and is ideal for the following scenarios:

  • Quick deployment and testing scenarios
  • Interactive configuration and troubleshooting tasks
  • Environments where administrators prefer command-line interfaces

For detailed instructions, see Managing SMB clusters by using imperative method.

YAML-based deployment (declarative method)

Define SMB configuration in YAML specification files and apply them to the cluster. This method is recommended for the following scenarios:

  • Production deployments requiring consistency and repeatability
  • Infrastructure-as-Code (IaC) workflows and automation
  • Version-controlled configuration management
  • Automated deployment pipelines and CI/CD integration

For detailed instructions, see Composing resource specifications for declarative method.

Dashboard-based deployment (UI method)

Use the Dashboard web interface to configure and manage SMB services through an intuitive graphical interface. This method is best for the following scenarios:

  • Environments where users prefer graphical interfaces
  • Visual monitoring and management requirements
  • Quick configuration changes and updates
  • Teams with varied levels of technical expertise

For detailed instructions, see Managing SMB service, shares, and clusters.

Choosing the right deployment method

Consider the following factors when selecting a deployment approach:

Method Best For Key Benefits
CLI-based (imperative) Quick setups; testing; troubleshooting Direct control; immediate feedback; flexible configuration
YAML-based (declarative) Production environments; automation workflows Reproducible deployments; version control; scalability
Dashboard-based (UI) Visual management; mixed skill levels User-friendly interface; visual feedback; accessibility

Related information

After selecting a deployment method, refer to the following topics:

  • Prerequisites for SMB deployment
  • Detailed deployment instructions for the selected method
  • SMB cluster and share configuration procedures
  • Advanced features: access control, encryption, and QoS configuration