Workspace Creator

Creates new SAP workspace configurations for STAF testing. Generates sap-parameters.yaml and hosts.yaml from templates based on user-provided system details.

Locate Framework

This skill requires a trusted STAF checkout — a working tree the operator has verified out-of-band as either the official upstream (https://github.com/Azure/sap-automation-qa.git) or a fork of it, at a specific revision, with the framework marker ./scripts/sap_automation_qa.sh present. The operator must have verified both the source (upstream URL or fork URL) and the revision through a trusted out-of-band channel before running this skill, and must have cd-ed into that directory. If that state is not confirmed, stop and use the setup-guide skill first; it owns the setup workflow. Do not resume this skill until setup-guide (or the operator directly) confirms the checkout is trusted.

⚠️ This skill is guidance only. Do NOT modify any source code, scripts, or framework files. Only help the user by creating workspace configuration files (sap-parameters.yaml, hosts.yaml) under WORKSPACES/SYSTEM/.

When to Use

Workspace Location

All workspaces live under:

WORKSPACES/SYSTEM/{SYSTEM_CONFIG_NAME}/

The SYSTEM_CONFIG_NAME follows the convention: {ENV}-{REGION}-{SYSTEM}-{SID} Example: DEV-WEEU-SAP01-X00

Required Information

Before creating a workspace, gather:

Templates

sap-parameters.yaml Template

See templates/sap-parameters.yaml.template

All fields:

# ─── Application tier ─────────────────────────────────────────
sap_sid:                       X00
scs_high_availability:         true          # boolean
scs_cluster_type:              AFA           # Fencing mechanism: AFA (Azure Fencing Agent), ISCSI, or ASD (Azure Shared Disks)
scs_instance_number:           "00"          # 2-digit string
ers_instance_number:           "01"          # 2-digit string

# ─── Database tier ────────────────────────────────────────────
db_sid:                        HDB
db_instance_number:            "00"          # 2-digit string
platform:                      HANA          # HANA, DB2
database_high_availability:    true          # boolean
database_cluster_type:         AFA           # Fencing mechanism: AFA (Azure Fencing Agent), ISCSI, or ASD (Azure Shared Disks)
database_scale_out:            false         # boolean

# ─── Storage ──────────────────────────────────────────────────
NFS_provider:                  AFS           # AFS, ANF

# ─── Key Vault (optional — for SSH credential retrieval) ──────
key_vault_id:                  /subscriptions/.../Microsoft.KeyVault/vaults/<name>
secret_id:                     https://<name>.vault.azure.net/secrets/<secret>/<id>

# ─── Managed Identity (optional) ──────────────────────────────
user_assigned_identity_client_id: "00000000-0000-0000-0000-000000000000"

# ─── ANF (optional — when NFS_provider=ANF) ───────────────────
ANF_account_rg:                "ANF-RESOURCE-GROUP"
ANF_account_name:              "ANF-ACCOUNT-NAME"

# ─── Azure Backup (optional — for AzureBackupDatabase tests) ──
backup_vault_resource_id:      "/subscriptions/.../Microsoft.RecoveryServices/vaults/<name>"
backup_container_name:         "VMAppContainer;Compute;<rg>;<vm>"
backup_item_name:              "saphanadatabase;<sid>;<db>"
backup_target_filesystem_path: "/hana/backup/restore"
backup_target_container_name:  "VMAppContainer;Compute;<rg>;<target-vm>"
backup_target_database_name:   "SYSTEMDB"
backup_restore_point_time:     ""            # ISO 8601 UTC, empty for latest

hosts.yaml Template

See templates/hosts.yaml.template

Structure (5 groups):

{SID}_DB:                              # 2 hosts for HA
  hosts:
    {hostname}:
      ansible_host        : {IP}
      ansible_user        : azureadm
      ansible_connection  : ssh
      connection_type     : key
      virtual_host        : {virtual_hostname}
      become_user         : root
      os_type             : linux
      vm_name             : {AZURE_VM_NAME}
  vars:
    node_tier             : hana
    supported_tiers       : [hana]

{SID}_SCS:                             # 1 host
  hosts: ...
  vars:
    node_tier             : scs
    supported_tiers       : [scs]

{SID}_ERS:                             # 1 host
  vars:
    node_tier             : ers
    supported_tiers       : [ers]

{SID}_PAS:                             # 1 host
  vars:
    node_tier             : pas
    supported_tiers       : [pas]

{SID}_APP:                             # 1+ hosts
  vars:
    node_tier             : app
    supported_tiers       : [app]

Creation Steps

1. Create the directory structure:

   mkdir -p WORKSPACES/SYSTEM/{SYSTEM_CONFIG_NAME}/{logs,quality_assurance}

2. Generate sap-parameters.yaml from template with user values
3. Generate hosts.yaml from template with user values
4. Place SSH key file in workspace (if not using Key Vault)
5. Validate with workspace-validator

Output Format

After workspace creation:

✅ Workspace created: WORKSPACES/SYSTEM/DEV-WEEU-SAP01-X00/

Files created:
  ✅ sap-parameters.yaml (platform: HANA, HA: true)
  ✅ hosts.yaml (groups: X00_DB[2], X00_SCS[1], X00_ERS[1], X00_PAS[1], X00_APP[1])
  ✅ SSH key: ssh_key.pem
  ✅ logs/ directory created
  ✅ quality_assurance/ directory created

Next steps:
  1. Validate: python3 skills/workspace-validator/scripts/validate_workspace.py WORKSPACES/SYSTEM/DEV-WEEU-SAP01-X00
  2. Run tests: ./scripts/sap_automation_qa.sh --test-groups=HA_DB_HANA --test-cases=[ha-config]

Error Handling

Pre-Completion Checklist

Before reporting workspace creation complete:

• Directory exists under WORKSPACES/SYSTEM/
• sap-parameters.yaml has all required fields
• hosts.yaml has correct groups for intended test type
• All hosts have ALL fields (ansible_host, ansible_user, ansible_connection, connection_type, virtual_host, become_user, os_type, vm_name)
• SSH authentication is configured (key file, Key Vault, or password)
• logs/ and quality_assurance/ directories exist
• Validated with workspace-validator

Related Skills