google-cloud-container 1.5.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c374df41e31e289d655985998d017c3e0f29af9d3787e7d9ceed8f2acc42c8c
-  data.tar.gz: 3857004e40e39fbbd4437fc96046d469d56f1221235017454d890d75eb7da2c0
+  metadata.gz: 8b3565c1e07fa325993515a83d6a251d2687ef4716ddab5c3c014f09d3de187f
+  data.tar.gz: cbc37c0a9e6c2931c0a100d610aa9ee6a9fea746781da1f42cf230b7d7310031
 SHA512:
-  metadata.gz: 5e3489421afda038c428774e619d29b42947a140253b05ec9560ce00c5525d04b4f0c98b01d6277c257f02ceca4aa7425026829d812b630c8a90cddaa17553a4
-  data.tar.gz: 8bc3332d0fde3b4820f7f91fea9ea6325dee13b9170eaa589ef745f6a75b589aa45c84cd5d4229e25b4f524888e760764343523597fe3b48b677b3311921ee1d
+  metadata.gz: 17225c73088aace638ca7982bdbf37ef3ae528fd24991a359e0a82dd9288b9132c157aeb3bb24b5c26b58e27b00239833a6ebefb9374582e6e8d5573061faa7c
+  data.tar.gz: 0a7d46f27ae8bb2f6767d8177db6a06649bb21c50a87a739dbe09e8b2c1da16caf7fd48dc8787ea90e364be99b48c04635c9cde68f2cc9d42675028dce6e724f

data/.yardopts

@@ -8,5 +8,4 @@
 -
 README.md
 AUTHENTICATION.md
-MIGRATING.md
 LICENSE.md

data/README.md

@@ -16,8 +16,7 @@ for this library, google-cloud-container, 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-container-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-container-v1/latest),
-[google-cloud-container-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-container-v1beta1/latest).
+[google-cloud-container-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-container-v1/latest).
 
 See also the [Product Documentation](https://cloud.google.com/kubernetes-engine)
 for more usage information.
@@ -35,43 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/container.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Migrating from 0.x versions
-
-The 1.0 release of the google-cloud-container client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for earlier
-versions of this library will likely require updates to use this version.
-See the {file:MIGRATING.md MIGRATING.md} document for more information.
-
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-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
-```
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-container-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-container-v1/latest).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 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

data/lib/google/cloud/container/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Container
-      VERSION = "1.5.1"
+      VERSION = "2.0.0"
     end
   end
 end

data/lib/google/cloud/container.rb

@@ -56,6 +56,11 @@ module Google
       # supported by that API version, and the corresponding gem is available, the
       # appropriate versioned client will be returned.
       #
+      # Raises an exception if the currently installed versioned client gem for the
+      # given API version does not support the ClusterManager service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::Container.cluster_manager_available?}.
+      #
       # ## About ClusterManager
       #
       # Google Kubernetes Engine Cluster Manager v1
@@ -75,6 +80,32 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the ClusterManager service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::Container.cluster_manager}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the ClusterManager service,
+      # or if the versioned client gem needs an update to support the ClusterManager service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.cluster_manager_available? version: :v1
+        require "google/cloud/container/#{version.to_s.downcase}"
+        package_name = Google::Cloud::Container
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::Container.const_get package_name
+        return false unless service_module.const_defined? :ClusterManager
+        service_module = service_module.const_get :ClusterManager
+        service_module.const_defined? :Client
+      rescue ::LoadError
+        false
+      end
+
       ##
       # Configure the google-cloud-container library.
       #

metadata

@@ -1,55 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-container
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-container-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.33'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.33'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 2.a
-- !ruby/object:Gem::Dependency
-  name: google-cloud-container-v1beta1
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.34'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.34'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.a
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +47,6 @@ files:
 - ".yardopts"
 - AUTHENTICATION.md
 - LICENSE.md
-- MIGRATING.md
 - README.md
 - lib/google-cloud-container.rb
 - lib/google/cloud/container.rb
@@ -83,7 +55,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -91,15 +62,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: API Client library for the Kubernetes Engine API
 test_files: []

data/MIGRATING.md

@@ -1,280 +0,0 @@
-## Migrating to google-cloud-container 1.0
-
-The 1.0 release of the google-cloud-container client is a significant upgrade
-based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby),
-and includes substantial interface changes. Existing code written for earlier
-versions of this library will likely require updates to use this version.
-This document describes the changes that have been made, and what you need to
-do to update your usage.
-
-To summarize:
-
- *  The library has been broken out into three libraries. The new gems
-    `google-cloud-container-v1` and `google-cloud-container-v1beta1` contain the
-    actual client classes for versions V1 and V1beta1 of the Kubernetes Engine
-    service, and the gem `google-cloud-container` now simply provides a
-    convenience wrapper. See [Library Structure](#library-structure) for more
-    info.
- *  The library uses a new configuration mechanism giving you closer control
-    over endpoint address, network timeouts, and retry. See
-    [Client Configuration](#client-configuration) for more info. Furthermore,
-    when creating a client object, you can customize its configuration in a
-    block rather than passing arguments to the constructor. See
-    [Creating Clients](#creating-clients) for more info.
- *  Previously, positional arguments were used to indicate required arguments.
-    Now, all method arguments are keyword arguments, with documentation that
-    specifies whether they are required or optional. Additionally, you can pass
-    a proto request object instead of separate arguments. See
-    [Passing Arguments](#passing-arguments) for more info.
- *  Previously, clients reported RPC errors by raising instances of
-    `Google::Gax::GaxError` and its subclasses. Now, RPC exceptions are of type
-    `Google::Cloud::Error` and its subclasses. See
-    [Handling Errors](#handling-errors) for more info.
- *  Some classes have moved into different namespaces. See
-    [Class Namespaces](#class-namespaces) for more info.
-
-### Library Structure
-
-Older 0.x releases of the `google-cloud-container` gem were all-in-one gems that
-included potentially multiple clients for multiple versions of the Kubernetes
-Engine service. The `Google::Cloud::Container.new` factory method would
-return you an instance of a `Google::Cloud::Container::V1::ClusterManagerClient`
-object for the V1 version of the service, or a
-`Google::Cloud::Container::V1beta1::ClusterManagerClient` object for the
-V1beta1 version of the service. All these classes were defined in the same gem.
-
-With the 1.0 release, the `google-cloud-container` gem still provides factory
-methods for obtaining clients. (The method signatures will have changed. See
-[Creating Clients](#creating-clients) for details.) However, the actual client
-classes have been moved into separate gems, one per service version. The
-`Google::Cloud::Container::V1::ClusterManager::Client` class, along with its
-helpers and data types, is now part of the `google-cloud-container-v1` gem.
-Similarly, the `Google::Cloud::Container::V1beta1::ClusterManager::Client`
-class is part of the `google-cloud-container-v1beta1` gem. 
-
-For normal usage, you can continue to install the `google-cloud-container` gem
-(which will bring in the versioned client gems as dependencies) and continue to
-use factory methods to create clients. However, you may alternatively choose to
-install only one of the versioned gems. For example, if you know you will only
-`V1` of the service, you can install `google-cloud-container-v1` by itself, and
-construct instances of the
-`Google::Cloud::Container::V1::ClusterManager::Client` client class directly.
-
-### Client Configuration
-
-In older releases, if you wanted to customize performance parameters or
-low-level behavior of the client (such as credentials, timeouts, or
-instrumentation), you would pass a variety of keyword arguments to the client
-constructor. It was also extremely difficult to customize the default settings.
-
-With the 1.0 release, a configuration interface provides control over these
-parameters, including defaults for all instances of a client, and settings for
-each specific client instance. For example, to set default credentials and
-timeout for all Kubernetes Engine V1 ClusterManager clients:
-
-```
-Google::Cloud::Container::V1::ClusterManager::Client.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Individual RPCs can also be configured independently. For example, to set the
-timeout for the `create_cluster` call:
-
-```
-Google::Cloud::Container::V1::ClusterManager::Client.configure do |config|
-  config.rpcs.create_cluster.timeout = 20.0
-end
-```
-
-Defaults for certain configurations can be set for all Kubernetes Engine versions
-globally:
-
-```
-Google::Cloud::Container.configure do |config|
-  config.credentials = "/path/to/credentials.json"
-  config.timeout = 10.0
-end
-```
-
-Finally, you can override the configuration for each client instance. See the
-next section on [Creating Clients](#creating-clients) for details.
-
-### Creating Clients
-
-In older releases, to create a client object, you would use the
-`Google::Cloud::Container.new` class method. Keyword arguments were available to
-select a service version and to configure parameters such as credentials and
-timeouts.
-
-With the 1.0 release, use the `Google::Cloud::Container.cluster_manager` class
-method to create a client object. You may select a service version using the
-`:version` keyword argument. However, other configuration parameters should be
-set in a configuration block when you create the client.
-
-Old:
-```
-client = Google::Cloud::Container.new credentials: "/path/to/credentials.json"
-```
-
-New:
-```
-client = Google::Cloud::Container.cluster_manager do |config|
-  config.credentials = "/path/to/credentials.json"
-end
-```
-
-The configuration block is optional. If you do not provide it, or you do not
-set some configuration parameters, then the default configuration is used. See
-[Client Configuration](#client-configuration).
-
-### Passing Arguments
-
-In older releases, the intent had been for required arguments to be passed as
-positional method arguments, and for optional arguments to be passed as keyword
-arguments. However, this rule didn't always hold cleanly because some arguments,
-including required arguments, were at one point deprecated and replaced, leading
-to a confusing mix of positional and keyword arguments, as well as some breaking
-changes.
-
-With the 1.0 release, all RPC arguments are passed as keyword arguments,
-regardless of whether they are required or optional. For example:
-
-Old:
-```
-client = Google::Cloud::Container.new
-
-name = "projects/my-project/locations/-/clusters/my-cluster"
-logging_service = "logging.googleapis.com"
-
-# logging_service is a positional argument and name is a keyword argument,
-# although both are required.
-response = client.set_logging_service logging_service, name: name
-```
-
-New:
-```
-client = Google::Cloud::Container.cluster_manager
-
-name = "projects/my-project/locations/-/clusters/my-cluster"
-logging_service = "logging.googleapis.com"
-
-# Both name and logging_service are keyword arguments.
-response = client.set_logging_service name: name,
-                                      logging_service: logging_service
-```
-
-In the 1.0 release, it is also possible to pass a request object, either
-as a hash or as a protocol buffer.
-
-New:
-```
-client = Google::Cloud::Container.cluster_manager
-
-request = Google::Cloud::Container::V1::SetLoggingServiceRequest.new(
-  name: "projects/my-project/locations/-/clusters/my-cluster",
-  logging_service: "logging.googleapis.com"
-)
-
-# Pass a request object as a positional argument:
-response = client.set_logging_service request
-```
-
-Finally, in older releases, to provide call options, you would pass a
-`Google::Gax::CallOptions` object with the `:options` keyword argument. In the
-1.0 release, pass call options using a _second set_ of keyword arguments.
-
-Old:
-```
-client = Google::Cloud::Container.new
-
-name = "projects/my-project/locations/-/clusters/my-cluster"
-logging_service = "logging.googleapis.com"
-
-options = Google::Gax::CallOptions.new timeout: 10.0
-
-response = client.set_logging_service logging_service, name: name, options: options
-```
-
-New:
-```
-client = Google::Cloud::Container.cluster_manager
-
-name = "projects/my-project/locations/-/clusters/my-cluster"
-logging_service = "logging.googleapis.com"
-
-# Use a hash to wrap the normal call arguments (or pass a request object), and
-# then add further keyword arguments for the call options.
-response = client.set_logging_service(
-  { name: name, logging_service: logging_service },
-  timeout: 10.0
-)
-```
-
-### Handling Errors
-
-The client reports standard
-[gRPC error codes](https://github.com/grpc/grpc/blob/master/doc/statuscodes.md)
-by raising exceptions. In older releases, these exceptions were located in the
-`Google::Gax` namespace and were subclasses of the `Google::Gax::GaxError` base
-exception class, defined in the `google-gax` gem. However, these classes were
-different from the standard exceptions (subclasses of `Google::Cloud::Error`)
-thrown by other client libraries such as `google-cloud-storage`.
-
-The 1.0 client library now uses the `Google::Cloud::Error` exception hierarchy,
-for consistency across all the Google Cloud client libraries. In general, these
-exceptions have the same name as their counterparts from older releases, but
-are located in the `Google::Cloud` namespace rather than the `Google::Gax`
-namespace.
-
-Old:
-```
-client = Google::Cloud::Container.new
-
-name = "projects/my-project/locations/-/clusters/my-cluster"
-logging_service = "logging.googleapis.com"
-
-begin
-  response = client.set_logging_service logging_service, name: name
-rescue Google::Gax::Error => e
-  # Handle exceptions that subclass Google::Gax::Error
-end
-```
-
-New:
-```
-client = Google::Cloud::Container.cluster_manager
-
-name = "projects/my-project/locations/-/clusters/my-cluster"
-logging_service = "logging.googleapis.com"
-
-begin
-  response = client.set_logging_service name: name,
-                                        logging_service: logging_service
-rescue Google::Cloud::Error => e
-  # Handle exceptions that subclass Google::Cloud::Error
-end
-```
-
-### Class Namespaces
-
-In older releases, some data type (protobuf) classes were located under the module
-`Google::Container`. In the 1.0 release, these classes have been moved into the
-same `Google::Cloud::Container` module by the client object, for consistency.
-
-In older releases, the client object was of class
-`Google::Cloud::Container::V1::ClusterManagerClient`.
-In the 1.0 release, the client object is of class
-`Google::Cloud::Container::V1::ClusterManager::Client`.
-Note that most users will use the `Google::Cloud::Container.cluster_manager`
-factory method to create instances of the client object, so you may not need to
-reference the actual class directly.
-See [Creating Clients](#creating-clients).
-
-In older releases, the credentials object was of class
-`Google::Cloud::Container::V1::Credentials`.
-In the 1.0 release, the credentials object is of class
-`Google::Cloud::Container::V1::ClusterManager::Credentials`.
-Again, most users will not need to reference this class directly.
-See [Client Configuration](#client-configuration).