Ruby Client for the Cloud Key Management Service (KMS) API

API Client library for the Cloud Key Management Service (KMS) API

Manages keys and performs cryptographic operations in a central cloud service, for direct use by other cloud resources and applications.

Actual client classes for the various versions of this API are defined in versioned client gems, with names of the form google-cloud-kms-v*. The gem google-cloud-kms is a convenience wrapper library that brings the verisoned gems in as dependencies, and provides high-level methods for constructing clients.

View the Client Library Documentation for this library, google-cloud-kms, to see the convenience methods for constructing client objects. Reference documentation for the client objects themselves can be found in the client library documentation for the versioned client gems: google-cloud-kms-v1.

See also the Product Documentation for more usage information.

Quick Start

$ gem install google-cloud-kms

In order to use this library, you first need to go through the following steps:

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the API.
  4. Set up authentication.

Migrating from 1.x versions

The 2.0 release of the google-cloud-kms client is a significant upgrade based on a next-gen code generator, and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. See the MIGRATING.md document for more information.

Enabling Logging

To enable logging for this library, set the logger for the underlying gRPC library. The logger that you set may be a Ruby stdlib Logger as shown below, or a Google::Cloud::Logging::Logger that will write logs to Cloud Logging. See grpc/logconfig.rb and the gRPC spec_helper.rb for additional information.

Configuring a Ruby stdlib logger:

require "logger"

module MyLogger
  LOGGER = Logger.new $stderr, level: Logger::WARN
  def logger
    LOGGER
  end
end

# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
module GRPC
  extend MyLogger
end

Supported Ruby Versions

This library is supported on Ruby 2.4+.

Google provides official support for Ruby versions that are actively supported by Ruby Core—that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.4 and later. Older versions of Ruby may still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.