TechDocs/GCS: Enable authentication using environemnt variables

GOOGLE_APPLICATION_CREDENTIALS is the environment variable used by the client. Compute Engine, Google Kubernetes Engine, App Engine, Cloud Run, and Cloud Functions automatically provide a default service account and set this env variable. https://cloud.google.com/docs/authentication/production
2021-01-09 16:07:39 +01:00
parent 70b6384c26
commit 1ef5d0f13c
3 changed files with 43 additions and 38 deletions
@@ -123,17 +123,19 @@ export interface Config {
           */
          googleGcs?: {
            /**
-             * API key used to write to a storage bucket.
+             * (Optional) API key used to write to a storage bucket.
+             * If not set, environment variables will be used to authenticate.
+             * Read more: https://cloud.google.com/docs/authentication/production
             * attr: 'credentials' - accepts a string value
             * @visibility secret
             */
-            credentials: string;
+            credentials?: string;
            /**
             * GCP Project ID where the Cloud Storage Bucket is hosted.
             * attr: 'projectId' - accepts a string value
             * @visibility secret
             */
-            projectId: string;
+            projectId?: string;
            /**
             * Cloud Storage Bucket Name
             * attr: 'bucketName' - accepts a string value