Initial Configuration
#########################

The Project Phoenix Engine Azure marketplace image takes a Base64 encoded JSON via the custom data function to preconfigure the engine. This chapter will describe the parts of this configuration.

General
===========

::

    "default": {
        "initial_tasks": "<list of tasks>",
        "autostart": "<boolean>",
        "webauth": "<boolean>"
    }

The "default" section contains generic settings.

Initial Tasks
-----------------

:Directive: initial_tasks
:Default value: <empty>
:Required: no

The "initial_tasks" setting allows to trigger some tasks during the first start of the Project Phoenix Engine. After the first start, it is emptied automatically. Here are some lists of tasks for different use cases:

    - SAP S/4HANA 2020 deployment: ``op:waitForHANAVM,op:waitForNetweaverVM,op:mountScripts,wf:hana_install,wf:s4hana_2020_install``
    - SAP BW/4HANA 2.0 deployment: ``op:waitForHANAVM,op:waitForNetweaverVM,op:mountScripts,wf:hana_install,wf:bw4hana_20_install``
    - SAP S/4HANA 1909 deployment: ``op:waitForHANAVM,op:waitForNetweaverVM,op:mountScripts,wf:hana_install,wf:s4hana_1909_install``
    - NetWeaver 7.5 ABAP deployment: ``op:waitForHANAVM,op:waitForNetweaverVM,op:mountScripts,wf:hana_install,wf:netweaver_install``
    - Standalone HANA deployment: ``op:waitForHANAVM,op:mountScripts,wf:hana_install``
    - Standalone HANA deployment and restore from backup: ``op:waitForHANAVM,op:mountScripts,wf:hana_install,wf:hana_restore``

Autostart
------------

:Directive: autostart
:Default value: false
:Required: no

The "autostart" setting controls the automatic start of the database and application server instances upon starting the VMs.

WebUI Authentication
-----------------------

:Directive: webauth
:Default value: true
:Required: no

The "webauth" setting allows to disable authentication to the Project Phoenix WebUI. When authentication is enabled, the credentials to the WebUI are "admin" with the HANA master password as password (see "hana" section).

Repository
===============

::

    "repository": {
        "storage_account_name": "<name of storage account>",
        "storage_account_sas64": "<Base64 encoded SAS token>"
    }

The "repository" section of the configuration describes the storage account used to access the SAP installation files.

Storage Account Name
-----------------------

:Directive: storage_account_name
:Default value: <empty>
:Required: yes

The "storage_account_name" setting should contain the name of the Azure storage account used as the repository.

Storage Account SAS token
----------------------------

:Directive: storage_account_sas64
:Default value: <empty>
:Required: yes

The "storage_account_sas64" setting should contain a Base64 encoded SAS token to the Azure storage account used as the repository. It requires Read and List permissions on Containers and Objects of the Blob service.

HANA Configuration
======================

::

    "hana": {
        "host": "<HANA VM IP address>",
        "hostagent_user": "<username for hostagent, usually sapadm>",
        "hostagent_password": "<hostagent user password>",
        "sid": "<HANA SID>",
        "instance_no": "<instance number>",
        "master_password": "<HANA master password>",
        "initial_load": "<name of hana backup to restore>"
    }

The "hana" section of the configuration contains the access details of the VM used to run the SAP HANA database, as well as information on the HANA database itself. If no HANA database is supposed to be managed with the Project Phoenix Engine, this section can be left out.

HANA Host
--------------

:Directive: host
:Default value: <empty>
:Required: yes

The "host" setting should contain the hostname or IP address of the VM used to run the SAP HANA database.

Host Agent OS User
----------------------

:Directive: hostagent_user
:Default value: <empty>
:Required: yes

The "hostagent_user" setting should contain the name of os user used to connect to the Host Agent on the HANA VM. This is usually "sapadm".

Host Agent User Password
--------------------------

:Directive: hostagent_password
:Default value: <empty>
:Required: yes

The "hostagent_password" setting should contain the password of os user used to connect to the Host Agent on the HANA VM.

HANA SID
-----------

:Directive: sid
:Default value: <empty>
:Required: yes

The "sid" setting should contain the SID of the HANA database.

HANA Instance Number
----------------------

:Directive: instance_no
:Default value: <empty>
:Required: yes

The "instance_no" setting should contain the instance number of the HANA database. Following SAP constraints, this number should be between 00 and 97, and have a leading 0 if it is lower than 10.

HANA Master Password
----------------------

:Directive: master_password
:Default value: <empty>
:Required: yes

The "master_password" should contain the master password to be used for the SAP HANA database installation. It should follow the SAP HANA rules for password complexity.

HANA Initial Load Backup Name
-------------------------------

:Directive: initial_load
:Default value: <empty>
:Required: no

The "initial_load" can contain the name of an initial backup to be restored in a freshly installed SAP HANA database. This should be the filename (without the .tar.gz) of the archive in the "backup" container of the repository.

NetWeaver configuration
===========================

::

    "netweaver": {
        "host": "<NetWeaver VM IP address>",
        "hostagent_user": "<username for hostagent, usually sapadm>",
        "hostagent_password": "<hostagent user password>",
        "sid": "<SAP NetWeaver SID>",
        "instance_no_scs": "<(A)SCS instance number>"
        "instance_no_pai": "<PAI instance number"
        "master_password": "<NetWeaver master password>"
    }

The "netweaver" section contains the configuration fot the NetWeaver stack deployed and managed by the Project Phoenix Engine. This section can be omitted for standalone HANA deployments.

NetWeaver Host
--------------

:Directive: host
:Default value: <empty>
:Required: yes

The "host" setting should contain the hostname or IP address of the VM used to run the SAP NetWeaver instances.

Host Agent OS User
----------------------

:Directive: hostagent_user
:Default value: <empty>
:Required: yes

The "hostagent_user" setting should contain the name of os user used to connect to the Host Agent on the NetWeaver VM. This is usually "sapadm".

Host Agent User Password
--------------------------

:Directive: hostagent_password
:Default value: <empty>
:Required: yes

The "hostagent_password" setting should contain the password of os user used to connect to the Host Agent on the NetWeaver VM.

NetWeaver SID
---------------

:Directive: sid
:Default value: <empty>
:Required: yes

The "sid" setting should contain the SID of the HANA database.

NetWeaver (A)SCS Instance Number
------------------------------------

:Directive: instance_no_scs
:Default value: <empty>
:Required: yes

The "instance_no_scs" setting should contain the instance number of the (A)SCS instance of the SAP NetWeaver installation. Following SAP constraints, this number should be between 00 and 97, and have a leading 0 if it is lower than 10.

NetWeaver PAI Instance Number
------------------------------------

:Directive: instance_no_pai
:Default value: <empty>
:Required: yes

The "instance_no_pai" setting should contain the instance number of the primary application instance of the SAP NetWeaver installation. Following SAP constraints, this number should be between 00 and 97, and have a leading 0 if it is lower than 10. It also has to be different than the instance number of the (A)SCS instance.

NetWeaver Master Password
-----------------------------

:Directive: master_password
:Default value: <empty>
:Required: yes

The "master_password" should contain the master password to be used for the SAP NetWeaver / S/4HANA installation. It should follow the SAP rules for password complexity.

Complete configuration
============================

::

    {
        "default": {
            "initial_tasks": "<list of tasks>",
            "autostart": "<boolean>",
            "webauth": "<boolean>"
        },
        "repository": {
            "storage_account_name": "<name of storage account>",
            "storage_account_sas64": "<Base64 encoded SAS token>"
        },
        "hana": {
          "host": "<HANA VM IP address>",
          "hostagent_user": "<username for hostagent, usually sapadm>",
          "hostagent_password": "<hostagent user password>",
          "sid": "<HANA SID>",
          "instance_no": "<instance number>",
          "master_password": "<HANA master password>",
          "initial_load": "<name of hana backup to restore>"
        },
        "netweaver": {
          "host": "<NetWeaver VM IP address>",
          "hostagent_user": "<username for hostagent, usually sapadm>",
          "hostagent_password": "<hostagent user password>",
          "sid": "<SAP NetWeaver SID>",
          "instance_no_scs": "<(A)SCS instance number>"
          "instance_no_pai": "<PAI instance number"
          "master_password": "<NetWeaver master password>"
        }
    }