Skip to content

Commit 511046d

Browse files
authoredOct 9, 2023
Merge pull request #1272 from nsantiago2719/main
Enrich AWS authentication documentation
2 parents e0c73ec + c6c9ba5 commit 511046d

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed
 

‎README.rst

+15-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,10 @@ recommended to use at least two master keys in different regions.
6464
6565
export SOPS_KMS_ARN="arn:aws:kms:us-east-1:656532927350:key/920aff2e-c5f1-4040-943a-047fa387b27e,arn:aws:kms:ap-southeast-1:656532927350:key/9006a8aa-0fa6-4c14-930e-a2dfb916de1d"
6666
67-
Your AWS credentials must be present in ``~/.aws/credentials``. sops uses aws-sdk-go.
67+
SOPS uses `aws-sdk-go-v2 <https://github.com/aws/aws-sdk-go-v2>`_ to communicate with AWS KMS. It will automatically
68+
read the credentials from the ``~/.aws/credentials`` file which can be created with the ``aws configure`` command.
69+
70+
An example of the ``~/.aws/credentials`` file is shown below:
6871

6972
.. code::
7073
@@ -73,6 +76,17 @@ Your AWS credentials must be present in ``~/.aws/credentials``. sops uses aws-sd
7376
aws_access_key_id = AKI.....
7477
aws_secret_access_key = mw......
7578
79+
In addition to the ``~/.aws/credentials`` file, you can also use the ``AWS_ACCESS_KEY_ID`` and ``AWS_SECRET_ACCESS_KEY``
80+
environment variables to specify your credentials:
81+
82+
.. code:: bash
83+
84+
export AWS_ACCESS_KEY_ID="AKI......"
85+
export AWS_SECRET_ACCESS_KEY="mw......"
86+
87+
For more information and additional environment variables, see
88+
`specifying credentials <https://aws.github.io/aws-sdk-go-v2/docs/configuring-sdk/#specifying-credentials>`_.
89+
7690
If you want to use PGP, export the fingerprints of the public keys, comma
7791
separated, in the **SOPS_PGP_FP** env variable.
7892

0 commit comments

Comments
 (0)