summaryrefslogtreecommitdiffstats
path: root/util/dependency_updater/tools/datasources/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'util/dependency_updater/tools/datasources/README.md')
-rw-r--r--util/dependency_updater/tools/datasources/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/util/dependency_updater/tools/datasources/README.md b/util/dependency_updater/tools/datasources/README.md
new file mode 100644
index 0000000..f23c19b
--- /dev/null
+++ b/util/dependency_updater/tools/datasources/README.md
@@ -0,0 +1,17 @@
+# Datasources
+
+Credentials can be pre-configured via the root level
+`config.yaml` or via environment variables of the same name. If credentials are not supplied or are
+incorrect, the user will be prompted at runtime to re-enter valid credentials the datasource.
+
+**Datasources are available on the Config object as `config.datasources`.**
+
+### Gerrit Code Review Client
+
+Accessible via the config object @ `config.datasources.gerrit_client`
+
+**Authentication is mandatory to create changes, auto-approve, or stage changes.** The tool defaults
+to simulating updates if credentials are not supplied.
+
+Provides a sanitized JSON response from gerrit queries, based on
+the [Gerrit API reference](https://gerrit-review.googlesource.com/Documentation/rest-api.html)