Skip to content

Commit fd557f5

Browse files
committed
Enhance documentation for credential files and clarify SAPHanaSR provider task for SUSE
1 parent 3c45669 commit fd557f5

3 files changed

Lines changed: 23 additions & 5 deletions

File tree

docs/HIGH_AVAILABILITY.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -276,17 +276,35 @@ key_vault_id: /subscriptions/<subscription-id>/resourceGroups/<
276276
secret_id: https://<key-vault-name>.vault.azure.net/secrets/<secret-name>/<id>
277277
```
278278

279-
2.2.3. Credential Files
279+
2.2.3. **Credential Files** (Available locally)
280280

281281
The required credential files depend on the authentication method used to connect to the SAP system:
282282

283-
1. SSH Key Authentication: If connecting via SSH key, place the private key inside `WORKSPACE/SYSTEM/<DIRECTORY>` and name the file "ssh_key.ppk".
284-
1. Username and Password Authentication: If connecting using a username and password, create a password file by running the following command. It takes the username from hosts.yaml file.
283+
1. **SSH Key Authentication**: If connecting via SSH key, place the private key inside `WORKSPACE/SYSTEM/<DIRECTORY>` and name the file "ssh_key.ppk".
284+
1. **Password Authentication**: If connecting using a username and password, create a password file by running the following command. It takes the username from hosts.yaml file.
285285

286286
```bash
287287
echo "password" > WORKSPACES/SYSTEM/<DIRECTORY>/password
288288
```
289289

290+
2.2.4. **Credential Files** (From Azure Key Vault)
291+
292+
When using Azure Key Vault to store credentials, the framework retrieves authentication details directly from the key vault using the configured managed identity.
293+
294+
**Authentication Methods:**
295+
296+
1. **SSH Key Authentication**: Store the private SSH key content in Azure Key Vault as a secret.
297+
2. **Password Authentication**: Store the password in Azure Key Vault as a secret. The username is taken from the `hosts.yaml` file.
298+
299+
**Setup:**
300+
301+
1. Ensure the managed identity has "Key Vault Secrets User" role on the key vault.
302+
303+
2. Configure `key_vault_id` and `secret_id` parameters in `sap-parameters.yaml` as shown in section 2.2.2.
304+
305+
**Important**: When using Key Vault authentication, do NOT create local credential files (`ssh_key.ppk` or `password` files).
306+
307+
290308
### 3. Test Execution
291309

292310
To execute the script, run following command:

src/roles/ha_db_hana/tasks/primary-node-kill.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@
5959
get_cluster_status_db:
6060
operation_step: "test_execution"
6161
database_sid: "{{ db_sid | lower }}"
62-
saphanasr_provider: "{{ saphanasr_provider | default('SAPHanaSR') }}"
62+
saphanasr_provider: "{{ saphanasr_provider | default('SAPHanaSR') }}"
6363
register: cluster_status_test_execution
6464
retries: "{{ default_retries }}"
6565
delay: "{{ default_delay }}"

src/roles/misc/tasks/get-saphanasr-provider.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
# Licensed under the MIT License.
33

44
# /*---------------------------------------------------------------------------
5-
# | Get SAPHanaSR Provider |
5+
# | Get SAPHanaSR Provider (on SUSE only) |
66
# +--------------------------------------------------------------------------*/
77

88
- name: Get SAPHanaSR provider for SUSE

0 commit comments

Comments
 (0)