Skip to content

alekcz/google-credentials

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
doc
 
 
 
 
 
 
 
 
 
 
 
 

google-credentials

A Clojure library for loading gcloud credentials from an environment variable instead of a .json file.

Build Status codecov

Clojars Project

Background

When interoping with the Google SDK the initialization process is more or less as follows:

  1. Load credentials from file
  2. Initialize credentials
  3. Initialize the SDK by passing the credentials to it.
  4. Access resource in the Google cloud

This library allows the credentials to be loaded from the environment variable: GOOGLE_APPLICATION_CREDENTIALS.
You can also load the credentials from a custom environment variable. I've found this really useful when deploying applications or running CI/CD outside the Google cloud.

You still need to perform steps 2 - 4 to get up and running.

Usage

Current: [alekcz/googlecredentials "3.0.1"]

Deprecated: [alekcz/google-credentials "x.x.x"]
(The dash in the package name creates problems)

  1. Get the json file containing your service account creditials by following the instruction here https://cloud.google.com/docs/authentication/getting-started
  2. Copy the contents of your .json into the GOOGLE_APPLICATION_CREDENTIALS environment variable. In your ~/.bash_profile and in Travis CI you should escape your credentials using singe quotes (').
(require '[googlecredentials.core :as g-cred])

    ;; By default load from GOOGLE_APPLICATION_CREDENTIALS
    (-> (. StorageOptions newBuilder)
        (.setCredentials (g-cred/load-service-credentials)) 
        (.build) 
        (.getService))

    ;; Load from custom environment variable
    (def firebase-options   (-> (new FirebaseOptions$Builder) 
                                (.setCredentials (g-cred/load-service-credentials :firebase-config)) 
                                (.build))   
    (.initializeApp FirebaseApp firebase-options)   

    ;; Load from custom environment variable as string
    (def firebase-options   (-> (new FirebaseOptions$Builder) 
                                (.setCredentials (g-cred/load-service-credentials "FIREBASE_CONFIG")) 
                                (.build))   
    (.initializeApp FirebaseApp firebase-options)   

     ;; generic example
    (def cred   (-> (<options-builder>)
                    (.setCredentials (g-cred/load-service-credentials)) 
                    (.build))  
    (<cloud-library>/<initialisation-function> cred)

License

Copyright © 2020 Alexander Oloo

This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.

This Source Code may also be made available under the following Secondary Licenses when the conditions for such availability set forth in the Eclipse Public License, v. 2.0 are satisfied: GNU General Public License as published by the Free Software Foundation, either version 2 of the License, or (at your option) any later version, with the GNU Classpath Exception which is available at https://www.gnu.org/software/classpath/license.html.

About

A Clojure library for loading gcloud credentials from an environment variable instead of a .json file

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published