Skip to content

presets.md

Latest commit

 

History

History
163 lines (121 loc) · 3.61 KB

presets.md

File metadata and controls

163 lines (121 loc) · 3.61 KB

Demo Presets

Demo presets provide pre-configured data sets for demonstrations, testing, and development. Each preset contains users, organizations, projects, offerings, resources, and usage data.

Available Presets

Preset Description
minimal_quickstart Basic setup for quick demos and testing
government_cloud GDPR-compliant cloud services for public sector
research_institution HPC and research computing environment
hpc_ai_platform GPU clusters and AI/ML workloads

Management Commands

List Available Presets

waldur demo_presets list
waldur demo_presets list --quiet  # Names only

View Preset Details

waldur demo_presets info minimal_quickstart

Load a Preset

# Load with confirmation prompt
waldur demo_presets load minimal_quickstart

# Skip confirmation
waldur demo_presets load minimal_quickstart --yes

# Preview without applying changes
waldur demo_presets load minimal_quickstart --dry-run

# Keep existing data (no cleanup)
waldur demo_presets load minimal_quickstart --no-cleanup

# Skip user import
waldur demo_presets load minimal_quickstart --skip-users

After loading, the command displays user credentials:

============================================================
Demo User Credentials
============================================================
  staff: demo [staff]
  support: demo [support]
  owner: demo
  manager: demo
  member: demo
============================================================

Export Current State

waldur demo_presets export my_preset --title "My Custom Setup"

REST API

List Presets

GET /api/marketplace-demo-presets/list/
Authorization: Token <staff_token>

Get Preset Details

GET /api/marketplace-demo-presets/info/{name}/
Authorization: Token <staff_token>

Load Preset

POST /api/marketplace-demo-presets/load/{name}/
Authorization: Token <staff_token>
Content-Type: application/json

{
  "dry_run": false,
  "cleanup_first": true,
  "skip_users": false,
  "skip_roles": false
}

Response includes user credentials:

{
  "success": true,
  "message": "Preset 'minimal_quickstart' loaded successfully",
  "output": "...",
  "users": [
    {"username": "staff", "password": "demo", "is_staff": true, "is_support": false},
    {"username": "owner", "password": "demo", "is_staff": false, "is_support": false}
  ]
}

Preset Contents

Each preset JSON file includes:

  • _metadata - Title, description, version, scenarios
  • users - User accounts with passwords
  • customers - Organizations
  • projects - Projects within organizations
  • offerings - Service offerings with components
  • plans - Pricing plans
  • resources - Provisioned resources
  • component_usages - Usage data per billing period
  • component_user_usages - Per-user usage breakdown
  • user_roles - Role assignments
  • constance_settings - Site configuration

Creating Custom Presets

  1. Export current state or copy an existing preset
  2. Place JSON file in src/waldur_mastermind/marketplace/demo_presets/presets/
  3. Add _metadata section with title, description, version
  4. Ensure all UUIDs are unique 32-character hex strings

UUID Format

UUIDs must be exactly 32 hexadecimal characters (0-9, a-f):

"uuid": "00000000000000000000000000000001"

User Passwords

Include plaintext passwords in the users array:

{
  "username": "demo_user",
  "password": "demo",
  "email": "demo@example.com"
}

File Location

Presets are stored in:

src/waldur_mastermind/marketplace/demo_presets/presets/