Project

hiera-eyaml-gkms

0.0
Low commit activity in last 3 years
No release in over a year
hiera-eyaml-gkmscraigwatson/hiera-eyaml-gkmsHomepageDocumentationSource CodeBug TrackerWiki
Google Cloud KMS plugin for Hiera-EYAML
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
15,654
Stars
1
Forks
3
Watchers
3
 Releases
Current version
0.2.0
Total releases
6
First release
2019-03-11
Latest release
2022-11-13
 Issues
Open Issues
1
Closed Issues
0
Total Issues
1
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
5
Pull Request Acceptance Rate
83%
 Development
Primary Language
Ruby
Licenses
Apache-2.0
Average date of last 50 commits
2020-07-18
Reverse Dependencies
0

 Dependencies

Runtime

google-cloud-kms
= 2.0.0
hiera-eyaml
>= 3.2.0, < 4.0
 Project Readme

hiera-eyaml-gkms

Build Status Gem Version Gem Downloads

This is a plugin encryptor for the hiera-eyaml project, which encrypts and decrypts Hiera data using Google Cloud KMS, based on hiera-eyaml-kms by Allan Denot.

Google Cloud KMS is a service that encrypts and decrypts data through API calls. Permissions are controlled by IAM.

Using KMS avoids having to expose private keys to decrypt information when running Puppet.

Requirements

The Google Cloud Ruby SDK and the hiera-eyaml Gem are dependencies:

$ gem install hiera-eyaml google-cloud-kms

Installation

$ gem install hiera-eyaml-gkms

Then see hiera-eyaml documentation for how to use the eyaml tool to encrypt and use the 'GKMS' encryption_type for values to be encrypted with this plugin.

Configuration

This plugin adds several options to hiera-eyaml:

--gkms-project      Required: GCP Project
--gkms-keyring      Required: Google Cloud KMS Keyring
--gkms-crypto-key   Required: Google Cloud KMS Key
--gkms-location     Google Cloud KMS Keyring location (default: europe-west1)
--gkms-auth-type    Authentication type for Google API (default: serviceaccount)
--gkms-credentials  Path to service account JSON file (Required when using serviceaccount authentication type)

The minimum configuration required is the GCP project, keyring and crypto-key to use. If using a service account, you will also need to point the plugin to the JSON file containing the service account key.

If using a configuration YAML file:

---
gkms_project: 'graphite-melon-123567'
gkms_auth_type: 'machineaccount'
gkms_location: 'europe-west1'
gkms_keyring: 'keyring'
gkms_crypto_key: 'puppet_eyaml'

Usage with Google Compute Engine

The plugin can also be run using Google Compute Engine's service account by passing --gke-auth-type=machineaccount, and will need to be configured with the following IAM permissions:

Terraform Example

Note: Due to changes in Terraform provider syntax and formatting, this code may age!

resource "google_kms_key_ring" "keyring" {
  name     = "keyring"
  location = "europe-west1"
}

resource "google_kms_crypto_key" "puppet_eyaml" {
  name     = "puppet_eyaml"
  key_ring = google_kms_key_ring.keyring.self_link

  lifecycle {
    prevent_destroy = true
  }
}

resource "google_kms_crypto_key_iam_member" "eyaml" {
  crypto_key_id = google_kms_crypto_key.puppet_eyaml.self_link
  role          = "roles/cloudkms.cryptoKeyEncrypterDecrypter"
  member        = "serviceAccount:${data.google_project.project.number}-compute@developer.gserviceaccount.com"
}

resource "google_compute_instance_template" "template" {
  ...

  service_account {
    scopes = ["https://www.googleapis.com/auth/cloudkms"]
  }

  ...
}

Development