form.yml

---
hana:
  $name: HANA
  $type: group
  install_packages:
    $name: Install required packages
    $type: boolean
    $default: true
    $help: Install all required packages from currently existing repositories
  saptune_solution:
    $name: saptune solution to apply
    $type: text
    $default: HANA
    $help: saptune solution to apply to all nodes
    $optional: true
  software_path:
    $name: Path to HANA platform installation media folder
    $type: text
    $help: The path to already extracted HANA platform installation media folder which can be local or already mounted shared location (NFS, SMB, etc). This will have preference over hana installation media archive
    $optional: true
  use_hana_archive_file:
    $name: Use archive file for HANA platform installation
    $type: boolean
    $default: false
    $help: Mark this option if you want to use a hana archive file for the HANA installation
  hana_archive_file:
    $name: Path to HANA platform installation media archive
    $visibleIf: .use_hana_archive_file == true
    $type: text
    $help: The path to installation media archive in any of the RAR, ZIP, EXE or SAR format. For SAR archive, please also provide the sapcar executable path for extraction
    $optional: true
  hana_extract_dir:
    $name: Path to extract the HANA installation media archive
    $visibleIf: .use_hana_archive_file == true
    $type: text
    $default: /sapmedia_extract/HANA
    $help: The HANA archive will be extracted to this path. By default this path is /sapmedia_extract/HANA
    $optional: true
  sapcar_exe_file:
    $name: Path to sapcar executable if extracting HANA SAR archive
    $visibleIf: .use_hana_archive_file == true
    $type: text
    $help: The path to sapcar executable to extract HANA SAR archive
    $optional: true
  ha_enabled:
    $name: Enable HA cluster configuration
    $type: boolean
    $default: true
    $help: Enable the HA cluster configuration which will install the SAPHanaSR hook. To use this option the primary and secondary nodes must be defined in the pillar file
  scale_out:
    $name: Enable HANA scale-out deployment
    $type: boolean
    $default: false
    $help: Enable HANA scale-out deployment. To use this option the HANA roles must be defined in the pillar file.
  monitoring_enabled:
    $name: Enable the host to be monitored by exporters
    $type: boolean
    $default: false
    $help: Enable the node monitoring via exporters which will be installed and configured in all the nodes. Customize the exporter configuration in each node's dedicated sections.
  ha_dr_sustkover_enabled:
    $name: Enable HANA HA/DR provdider hook susTkOver
    $type: boolean
    $default: false
    $help: See https://documentation.suse.com/sbp/all/single-html/SLES4SAP-hana-sr-guide-PerfOpt-15/#cha.s4s.hana-hook for details.
  ha_dr_suschksrv_enabled:
    $name: Enable HANA HA/DR provdider hook susChkSrv
    $type: boolean
    $default: false
    $help: See https://documentation.suse.com/sbp/all/single-html/SLES4SAP-hana-sr-guide-PerfOpt-15/#cha.s4s.hana-hook for details.
  ha_dr_suschksrv_action_on_lost:
    $name: Configure "Action on lost" for HANA HA/DR provider hook susChkSrv
    $type: select
    $values: [stop, fence]
    $help: See `man 7 susChkSrv.py` and https://documentation.suse.com/sbp/all/single-html/SLES4SAP-hana-sr-guide-PerfOpt-15/#cha.s4s.hana-hook for details.
  nodes:
    $name: Nodes
    $type: edit-group
    $minItems: 1
    $itemName: ""
    $prototype:
      host:
        $name: Hostname to install HANA
        $type: text
        $optional: false
      sid:
        $name: HANA system identifier (SID)
        $type: text
        $optional: false
        $help: System ID of the HANA installation
      instance:
        $name: HANA instance number
        $type: text
        $optional: false
      password:
        $name: SAP user password
        $type: password
        $optional: false
        $help: This is the OS <sid>adm user password. Will be used to check if there is an already installed HANA.
      scenario_type:
        $name: HANA scenario type
        $type: select
        $values: [performance-optimized, cost-optimized]
      cost_optimized_parameters:
        $name: HANA parameters for cost-optimized
        $visibleIf: .scenario_type == cost-optimized
        $optional: true
        $type: group
        global_allocation_limit:
          $name: HANA memory allocation limit
          $type: text
          $optional: false
          $help: This is the memory size limit to be set for HANA in Mb
        preload_column_tables:
          $name: HANA preload column tables
          $type: boolean
          $default: false
          $optional: false
          $help: Choose this option to set the HANA behavior of preloading column tables on startup
      install_checkbox:
        $name: Install HANA
        $type: boolean
        $default: true
      install:
        $name: Install new HANA instance
        $visibleIf: .install_checkbox == true
        $optional: true
        $type: group
        local_software_path_checkbox:
          $name: Use local HANA installation media
          $type: boolean
          $default: false
          $help: Specify the installation media on this node, otherwise global software path will be used.
        software_path:
          $name: Path to local HANA installation media
          $visibleIf: .local_software_path_checkbox == true
          $type: text
          $optional: false
          $help: The path to already extracted HANA platform installation media folder which can be local or already mounted shared location (NFS, SMB, etc). This will have preference over global software path.
        root_user:
          $name: Machine root user
          $type: text
          $optional: false
        root_password:
          $name: Machine root password
          $type: password
          $optional: false
        use_config_file:
          $name: Use configuration file
          $type: boolean
          $default: false
          $help: Mark this option if you want to use a custom config file for the HANA installation options
        config_file:
          $name: Configuration file
          $visibleIf: .use_config_file == true
          $type: text
          $help: Path to the config file location. The template can be generated with the hdblcm --dump_configfile_template option
        use_hdb_pwd_file:
          $name: Fetch HANA passwords from XML file
          $type: boolean
          $default: false
          $help: Mark this option if you want to fetch HANA passwords from XML file for the HANA installation options
        hdb_pwd_file:
          $name: Path to XML file with HANA Passwords
          $visibleIf: .use_hdb_pwd_file == true
          $type: text
          $help: Path to the XML file location. The password template can be generated with the hdblcm --dump_configfile_template option
        sapadm_password:
          $name: SAP admin password (<sid>adm)
          $visibleIf: .use_config_file == false
          $type: password
          $help: The password of the SAP administrator user
        system_user_password:
          $name: SAP SYSTEM user password
          $visibleIf: .use_config_file == false
          $type: password
          $help: The password of the database SYSTEM (superuser) user
        extra_parameters:
          $name: Installation extra options
          $help: Optional configuration parameters (exact name as in the config file)
          $optional: true
          $type: edit-group
          $itemName: ""
          $prototype:
            $name: Extra parameter
            key:
              $name: Value to update
            value:
              $name: New value
      system_replication:
        $type: group
        system_replication_options:
          $name: System replication options
          $type: select
          $values: [None, Primary, Secondary]
      primary:
        $visibleIf: .system_replication#system_replication_options == Primary
        $optional: true
        $type: group
        name:
          $name: Primary Site Name
          $type: text
          $optional: false
        create_backup:
          $name: Create new database backup
          $type: boolean
          $default: false
          $help: Mark if you want the execute the database backup. Mandatory before enabling the System Replication
        backup:
          $name: Backup
          $optional: true
          $visibleIf: .create_backup == true
          $type: group
          key_name:
            $name: Key Name (hdbuserstore)
            $type: text
            $optional: true
          user_name:
            $name: SAP user
            $type: text
            $optional: true
          user_password:
            $name: SAP user password
            $type: password
            $optional: true
          database:
            $name: Database name to backup
            $type: text
            $optional: false
            $placeholder: SYSTEMDB
          file:
            $name: Backup file name
            $type: text
            $optional: false
            $help: File name for the backup that will be created
        create_userkey:
          $name: Create new key (hdbuserstore)
          $type: boolean
          $default: false
          $help: Mark this option to create a new key into the hdbuserstore
        userkey:
          $name: User key (hdbuserstore)
          $optional: true
          $visibleIf: .create_userkey == true
          $type: group
          key_name:
            $name: New key name
            $type: text
            $optional: false
          environment:
            $name: Environment
            $type: text
            $optional: false
            $help: Use the format <host>:<port number>
          user_name:
            $name: SAP user
            $type: text
            $default: SYSTEM
            $optional: false
          user_password:
            $name: SAP user password
            $type: password
            $optional: false
          database:
            $name: Database name
            $type: text
            $default: SYSTEMDB
            $optional: false
      secondary:
        $visibleIf: .system_replication#system_replication_options == Secondary
        $optional: true
        $name: Secondary node
        $type: group
        name:
          $name: Secondary site name
          $type: text
          $optional: false
        remote_host:
          $name: Primary node hostname
          $type: text
          $optional: false
          $help: Hostname of the primary HANA instance to connect the system replication
        remote_instance:
          $name: Primary node instance number
          $type: text
          $optional: false
          $help: Instance number of the primary HANA instance to connect the system replication
        replication_mode:
          $name: Replication mode
          $type: select
          $values: [sync, syncmem, async]
        operation_mode:
          $name: Operation mode
          $type: select
          $values: [logreplay, delta_datashipping]
        primary_timeout:
          $name: Timeout to wait until the primary node is enabled
          $type: text
          $optional: true
        interval:
          $name: Interval used to check if the primary instance is ready
          $type: text
          $optional: true

      add_exporter:
        $name: Add SAP HANA database metrics exporter
        $type: boolean
        $default: false
        $help: Mark if you want add the SAP HANA database metrics exporter
      exporter:
        $name: SAP HANA database metrics exporter
        $optional: true
        $visibleIf: .add_exporter == true
        $type: group
        exposition_port:
          $name: SAP HANA exporter exposition port
          $type: text
          $optional: false
        multi_tenant:
          $name: Enable Multi tenant monitoring
          $type: boolean
          $default: true
          $help: If enabled, the exporter will select all the tenants listed on the SYSTEMDB metadata and open a connection to each of them in order to collect metrics
        user:
          $name: SAP HANA user
          $type: text
          $default: SYSTEM
          $optional: false
        password:
          $name: SAP HANA password
          $type: password
          $optional: false
        port:
          $name: HANA database port
          $type: text
          $default: 30013
          $optional: false
          $help: If multi tenant is enabled, this port must point to a SYSTEMDB database port (3XX13 be default)
        timeout:
          $name: Connection timeout
          $type: text
          $default: 30
          $optional: true
          $help: Timeout in seconds for HANA database connection