Skip to content

Commit e73f8b8

Browse files
authored
First update
1 parent ff17f04 commit e73f8b8

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/credentials.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ use the MFTF credentials feature to hide sensitive [data][] like integration tok
55

66
Currently MFTF supports two types of credential storage: **.credentials file** and **HashiCorp vault**.
77

8-
# Configure File Storage
8+
#3 Configure File Storage
99

1010
The MFTF creates a sample file for credentials during [initial setup][]: `magento2/dev/tests/acceptance/.credentials.example`.
1111
The file contains an example list of keys for fields that can require credentials.
1212

13-
### Create `.credentials`
13+
## Create `.credentials`
1414

1515
To make the MFTF process the file with credentials, change directories to `magento2/dev/tests/acceptance/` and copy `.credentials.example` to `.credentials`.
1616

@@ -22,7 +22,7 @@ cd dev/tests/acceptance/
2222
cp .credentials.example .credentials
2323
```
2424

25-
### Add `.credentials` to `.gitignore`
25+
## Add `.credentials` to `.gitignore`
2626

2727
Verify that the file is excluded from tracking by `.gitignore` (unless you need this behavior):
2828

@@ -36,7 +36,7 @@ The command outputs the path if the file is excluded:
3636
.credentials
3737
```
3838

39-
### Define sensitive data in `.credentials` file
39+
## Define sensitive data in `.credentials` file
4040

4141
Open the `.credentials` file, for Magento core credentials, uncomment the fields you want to use, and add your values:
4242

@@ -69,14 +69,14 @@ Otherwise you are free to use any other `key_name` you like, as they are merely
6969
vendor/my_awesome_service_token=rRVSVnh3cbDsVG39oTMz4A
7070
```
7171

72-
# Configure Vault Storage
72+
## Configure Vault Storage
7373

7474
Hashicorp vault secures, stores, and tightly controls access to data in modern computing.
7575
It provides advanced data protection for your testing credentials.
7676

7777
MFTF works with both `vault enterprise` and `vault open source` that use `KV Version 2` secret engine.
7878

79-
### Install vault CLI
79+
## Install vault CLI
8080

8181
Download and install vault CLI tool if you want to run or develop MFTF tests locally. [Download Vault][Download Vault]
8282

@@ -95,7 +95,7 @@ vault login -method -path
9595
MFTF uses `KV Version 2` secret engine for secret storage.
9696
More information for working with `KV Version 2` can be found in [Vault KV2][Vault KV2].
9797

98-
#### Secrets path and key convention
98+
### Secrets path and key convention
9999

100100
The path and key for secret data must follow:
101101

@@ -111,7 +111,7 @@ secret/mftf/magento/carriers_usps_userid
111111
secret/mftf/magento/carriers_usps_password
112112
```
113113

114-
#### Write secrets to vault
114+
### Write secrets to vault
115115

116116
You can use vault CLI or Api to write secret data (credentials, etc) to vault. Here is a CLI example:
117117

@@ -132,14 +132,14 @@ CREDENTIAL_VAULT_ADDRESS=http://127.0.0.1:8200
132132
CREDENTIAL_VAULT_SECRET_BASE_PATH=secret
133133
```
134134

135-
# Configure both File Storage and Vault Storage
135+
## Configure both File Storage and Vault Storage
136136

137-
It's possible and sometimes useful to setup and use both `.credentials` file and vault for secret storage at the same time.
137+
It is possible and sometimes useful to setup and use both `.credentials` file and vault for secret storage at the same time.
138138
In this case, MFTF tests are able to read secret data at runtime from both storage, and local `.credentials` file will take precedence.
139139

140140
<!-- {% raw %} -->
141141

142-
# Use credentials in a test
142+
## Use credentials in a test
143143

144144
Credentials can be used in actions: [`fillField`][], [`magentoCLI`][], and [`createData`][].
145145

0 commit comments

Comments
 (0)