Patchwork D6982: automation: improve documentation for credentials management

login
register
mail settings
Submitter phabricator
Date Oct. 5, 2019, 6:29 p.m.
Message ID <3c5a02d94686fe4ed8a941b820efe080@localhost.localdomain>
Download mbox | patch
Permalink /patch/41991/
State Not Applicable
Headers show

Comments

phabricator - Oct. 5, 2019, 6:29 p.m.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-devel.
Closed by commit rHGf71b3c561b93: automation: improve documentation for credentials management (authored by indygreg).
This revision was automatically updated to reflect the committed changes.
This revision was not accepted when it landed; it landed in state "Needs Review".

REPOSITORY
  rHG Mercurial

CHANGES SINCE LAST UPDATE
  https://phab.mercurial-scm.org/D6982?vs=16837&id=16850

CHANGES SINCE LAST ACTION
  https://phab.mercurial-scm.org/D6982/new/

REVISION DETAIL
  https://phab.mercurial-scm.org/D6982

AFFECTED FILES
  contrib/automation/README.rst

CHANGE DETAILS




To: indygreg, #hg-reviewers
Cc: mercurial-devel

Patch

diff --git a/contrib/automation/README.rst b/contrib/automation/README.rst
--- a/contrib/automation/README.rst
+++ b/contrib/automation/README.rst
@@ -47,12 +47,25 @@ 
 for how ``boto3`` works. Once you have configured your environment such
 that ``boto3`` can find credentials, interaction with AWS should *just work*.
 
-.. hint::
+To configure ``boto3``, you can use the ``aws configure`` command to
+write out configuration files. (The ``aws`` command is typically provided
+by an ``awscli`` package available in your package manager, including
+``pip``.) Alternatively, you can write out files in ``~/.aws/`` directly.
+e.g.::
+
+   # ~/.aws/config
+   [default]
+   region = us-west-2
 
-   Typically you have a ``~/.aws/credentials`` file containing AWS
-   credentials. If you manage multiple credentials, you can override which
-   *profile* to use at run-time by setting the ``AWS_PROFILE`` environment
-   variable.
+   # ~/.aws/credentials
+   [default]
+   aws_access_key_id = XXXX
+   aws_secret_access_key = YYYY
+
+If you have multiple AWS accounts, you can name the profile something
+different from ``default``. e.g. ``hg``. You can influence which profile
+is used by ``boto3`` by setting the ``AWS_PROFILE`` environment variable.
+e.g. ``AWS_PROFILE=hg``.
 
 Resource Management
 -------------------