Skip to main content

OpenStack Requirements

This page is the OpenStack onboarding checklist for StackConsole / CMP. Complete the common prerequisites and confirm hosting topology as well.

CMP’s OpenStack adapter supports Upstream OpenStack, Red Hat OpenStack Platform (RHOSP), Canonical Charmed OpenStack, and Virtuozzo Hybrid Infrastructure (VHI) through the same OpenStack / OpenStack-compatible REST APIs. See Supported platforms.

Bare minimum

Items marked as required to begin in the checklist must be ready before setup can start. Without those prerequisites, installation cannot proceed.


1. Access for StackConsole Team

To access the Horizon Dashboard UI, use one of:

Option A — VPN access (preferred)

NameEmail
Satish Londhesatish.londhe@stackconsole.io
Sushil Moresushil.more@stackconsole.io

Option B — IP whitelist

If VPN is not feasible, whitelist the StackConsole jump server:

14.192.19.227

2. Horizon Dashboard Credentials

This user must have full admin rights to manage zones, datastores, users, and projects.

FieldValue
Horizon Dashboard URL
Username
Password
Domain

3. CMP VM → OpenStack API connectivity

The CMP backend must reach the OpenStack control plane. Private access is recommended for production.

Method 1 — Private IP + port

http://10.0.12.10:5000 → Keystone (Identity)

Method 2 — Service domain names

https://keystone.openstack.example.com

Required OpenStack service ports

ServicePortNotes
Keystone (Identity)5000Auth and token issuance
Nova (Compute)8774VM operations
Placement8778Resource scheduling
Glance (Image)9292OS image management
Neutron (Networking)9696Network operations
Cinder (Block Storage)8776Volume management
Horizon (Dashboard)80 / 443Optional, for UI access
Magnum (Container Infra)variesOptional, for Kubernetes

4. CMP VM configuration

Shared install inputs:


5. Domain, SSL, SMTP, and app logos

Shared install inputs:


6. Known API issues to validate

Validate the following on your OpenStack environment before installation:

API version suffixes

For services that support multiple API versions, the version suffix must be present in the service endpoint URL:

ServiceRequired version suffixExample
Nova (Compute)/v2.1http://nova.example.com:8774/v2.1
Neutron (Networking)/v2.0http://neutron.example.com:9696/v2.0
Cinder (Block Storage)/v3http://cinder.example.com:8776/v3
Magnum (ContainerInfra)/v1http://magnum.example.com:9511/v1
Dynamic Cinder project ID

Cinder project ID must be dynamic, not static. The Cinder service endpoint must reference the currently selected project ID — not a hardcoded project UUID. See OpenStack Cinder API docs.

Keystone without version

Keystone must support authentication both with and without the version suffix:

  • https://keystone.openstack.example.com/v3 → must work
  • https://keystone.openstack.example.com → must also allow auth discovery

Availability Zone consistency

The Availability Zone name must be identical across all services (Nova, Cinder, Neutron). Mismatched AZ names cause silent provisioning failures.


7. Configuration values required for CMP

Provide these values at configuration time (from your OpenStack environment):

VariableRequiredDescription
project_idYesAdmin default project ID
domain_idYesDomain ID under which users and resources are created
external_network_idYesPublic network ID used for public IP assignment
open_stack_project_user_roleYesTypically member; Virtuozzo may need additional roles
open_stack_default_storage_policyOptionalDefault storage policy UUID (required if multiple storage types: SSD, NVMe, HDD)
one_gb_multiplierOptionalDefault: 1024
open_stack_admin_secretOptionalRequired for Virtuozzo (VHI) with Domain Admin role
open_stack_admin_keyOptionalRequired for Virtuozzo (VHI)
open_stack_admin_domainOptionalRequired for Virtuozzo (VHI)
open_stack_admin_projectOptionalRequired for Virtuozzo (VHI)
Virtuozzo / VHI

The open_stack_admin_* fields are only required for Virtuozzo (VHI) deployments where a Domain Admin user must manage projects, users, zones, storage policies, and quotas outside the default project scope.


8. Storage types

Configure storage type labels in OpenStack to match what you want displayed in the CMP portal (for example SSD, NVMe, HDD). CMP displays storage types as defined in OpenStack.


9. Checklist

Items needed to begin setup (without these, setup cannot proceed):

Access and OpenStack

  • VPN access to StackConsole team provided or jump server IP whitelisted
  • Horizon dashboard URL and admin credentials provided
  • OpenStack service ports reachable from CMP VMs

Staging VM

  • Staging VM and credentials provided
  • Staging URL provided
  • Staging SSL certificates provided

Production VM

  • Frontend VM and credentials provided
  • Backend VM and credentials provided
  • Database VM and credentials provided

Production URL and SSL

  • Frontend URL provided
  • Backend URL provided
  • Frontend VM can reach backend API URL (curl / connectivity tested)
  • Production SSL certificates provided

OpenStack configuration

  • API version suffixes verified on Nova, Neutron, Cinder, Magnum (as used)
  • Keystone works with and without /v3 suffix
  • Availability Zone names consistent across services
  • project_id, domain_id, external_network_id provided
  • Storage policy UUID provided (if multiple storage types)

Other

  • SMTP details provided
  • App logos (light + dark) provided when branding is required

10. OpenStack setup checkpoints

CheckNotes
At least one OS image/template available and bootable
4–5 flavors configured and available
Test user and project created; project associated with user
Logging in as that test user and creating configured services works
VM console access works from Horizon
All required OpenStack service endpoints reachable from CMP VMs