Skip to content

deploystack Client

Sorecchione07435 edited this page May 3, 2026 · 23 revisions

DeployStack — CLI Reference

Welcome to the DeployStack wiki. This page documents all available CLI commands, their arguments, and usage examples.


Table of Contents


deploy

Starts the full OpenStack deployment on the current node.

Syntax:

deploystack deploy [options]

Arguments

Argument Default Description
--allinone Generate an automatic configuration on the system and automatically start the deployment.
--config-file Start deployment from an existing configuration file.
--install-cinder {yes,no} yes Install the Cinder (Block Storage) service if set to yes.
--install-horizon {yes,no} yes Install Horizon (Dashboard) if set to yes.
--lvm-image-size-in-gb 5 LVM image size for Cinder.
--neutron-driver {ovs,ovn} ovs Network driver to use for Neutron.
--generate-only Generate the configuration automatically without starting the deployment.

Examples

Generate a pre-compiled configuration file without deploying:

deploystack deploy --allinone --generate-only

Then start the deployment using the generated file:

deploystack deploy --config-file openstack-config-xxxx.yaml

generate-config

Generates an empty template configuration file that must be filled in manually before deployment.

Syntax:

deploystack generate-config FILE_PATH

Example

deploystack generate-config ~/openstack-config.yaml

Note: deploy --allinone --generate-only creates a pre-compiled configuration file for the current system, while generate-config creates an empty file that you must compile manually.


launch

Quickly launches an OpenStack instance using the default image, flavor, and network.

Syntax:

deploystack launch [options]

Arguments

Argument Default Description
--name <name> (auto-generated) Name of the instance.
--image <image> cirros Image to use.
--flavor <flavor> m1.tiny Flavor to use.
--keypair <keypair> (auto-generated) SSH key to log into the instance. Leave empty to let the utility generate a new keypair automatically.
--password <password> Password for the administrator user (for compatible Linux/Windows images only).
--network <network> internal The main network that will be connected to the instance

Example

deploystack launch --name test-instance --password MySecret123

For issues or contributions, visit the project repository.

Clone this wiki locally