pnap_rancher_api 1.0.5 → 2.0.0

data/spec/models/workload_cluster_config_spec.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.4.0
+OpenAPI Generator version: 7.2.0
 
 =end
 
@@ -22,30 +22,32 @@ describe RancherApi::WorkloadClusterConfig do
 
   describe 'test an instance of WorkloadClusterConfig' do
     it 'should create an instance of WorkloadClusterConfig' do
-      expect(instance).to be_instance_of(RancherApi::WorkloadClusterConfig)
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(RancherApi::WorkloadClusterConfig)
     end
   end
+
   describe 'test attribute "name"' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   describe 'test attribute "server_count"' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   describe 'test attribute "server_type"' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 
   describe 'test attribute "location"' do
     it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
     end
   end
 

data/spec/spec_helper.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 0.1
 Contact: support@phoenixnap.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
+OpenAPI Generator version: 7.2.0
 
 =end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pnap_rancher_api
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 2.0.0
 platform: ruby
 authors:
 - PhoenixNAP
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-25 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -62,17 +62,13 @@ files:
 - Rakefile
 - VERSION
 - docs/Cluster.md
-- docs/ClusterConfiguration.md
-- docs/ClusterWorkloadConfiguration.md
 - docs/ClustersApi.md
 - docs/DeleteResult.md
 - docs/Error.md
 - docs/Node.md
 - docs/NodePool.md
-- docs/NodePoolSshConfig.md
 - docs/RancherClusterCertificates.md
 - docs/RancherClusterConfig.md
-- docs/RancherClusterConfigCertificates.md
 - docs/RancherServerMetadata.md
 - docs/SshConfig.md
 - docs/WorkloadClusterConfig.md
@@ -82,34 +78,24 @@ files:
 - lib/pnap_rancher_api/api_error.rb
 - lib/pnap_rancher_api/configuration.rb
 - lib/pnap_rancher_api/models/cluster.rb
-- lib/pnap_rancher_api/models/cluster_configuration.rb
-- lib/pnap_rancher_api/models/cluster_workload_configuration.rb
 - lib/pnap_rancher_api/models/delete_result.rb
 - lib/pnap_rancher_api/models/error.rb
 - lib/pnap_rancher_api/models/node.rb
 - lib/pnap_rancher_api/models/node_pool.rb
-- lib/pnap_rancher_api/models/node_pool_ssh_config.rb
 - lib/pnap_rancher_api/models/rancher_cluster_certificates.rb
 - lib/pnap_rancher_api/models/rancher_cluster_config.rb
-- lib/pnap_rancher_api/models/rancher_cluster_config_certificates.rb
 - lib/pnap_rancher_api/models/rancher_server_metadata.rb
 - lib/pnap_rancher_api/models/ssh_config.rb
 - lib/pnap_rancher_api/models/workload_cluster_config.rb
 - lib/pnap_rancher_api/version.rb
 - pnap_rancher_api.gemspec
 - spec/api/clusters_api_spec.rb
-- spec/api_client_spec.rb
-- spec/configuration_spec.rb
-- spec/models/cluster_configuration_spec.rb
 - spec/models/cluster_spec.rb
-- spec/models/cluster_workload_configuration_spec.rb
 - spec/models/delete_result_spec.rb
 - spec/models/error_spec.rb
 - spec/models/node_pool_spec.rb
-- spec/models/node_pool_ssh_config_spec.rb
 - spec/models/node_spec.rb
 - spec/models/rancher_cluster_certificates_spec.rb
-- spec/models/rancher_cluster_config_certificates_spec.rb
 - spec/models/rancher_cluster_config_spec.rb
 - spec/models/rancher_server_metadata_spec.rb
 - spec/models/ssh_config_spec.rb
@@ -128,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -141,20 +127,14 @@ specification_version: 4
 summary: Rancher Solution API Ruby Gem
 test_files:
 - spec/api/clusters_api_spec.rb
-- spec/api_client_spec.rb
-- spec/configuration_spec.rb
-- spec/models/error_spec.rb
-- spec/models/rancher_cluster_config_spec.rb
 - spec/models/workload_cluster_config_spec.rb
-- spec/models/cluster_spec.rb
+- spec/models/rancher_cluster_config_spec.rb
+- spec/models/error_spec.rb
 - spec/models/ssh_config_spec.rb
-- spec/models/cluster_configuration_spec.rb
-- spec/models/node_spec.rb
-- spec/models/node_pool_spec.rb
-- spec/models/node_pool_ssh_config_spec.rb
-- spec/models/rancher_cluster_config_certificates_spec.rb
-- spec/models/rancher_server_metadata_spec.rb
-- spec/models/cluster_workload_configuration_spec.rb
+- spec/models/cluster_spec.rb
 - spec/models/delete_result_spec.rb
 - spec/models/rancher_cluster_certificates_spec.rb
+- spec/models/node_spec.rb
+- spec/models/rancher_server_metadata_spec.rb
+- spec/models/node_pool_spec.rb
 - spec/spec_helper.rb

data/docs/ClusterConfiguration.md

@@ -1,30 +0,0 @@
-# RancherApi::ClusterConfiguration
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **token** | **String** | Shared secret used to join a server or agent to a cluster. | [optional] |
-| **tls_san** | **String** | This maps to ranchers `tls-san`. Add additional hostname or IP as a Subject Alternative Name in the TLS cert. | [optional] |
-| **etcd_snapshot_schedule_cron** | **String** | This maps to ranchers `etcd-snapshot-schedule-cron`. Snapshot interval time in cron spec. eg. every 5 hours ‘0 */5 * * *’. Default: at 12 am/pm | [optional][default to '0 0,12 * * *'] |
-| **etcd_snapshot_retention** | **Integer** | This maps to ranchers `etcd-snapshot-retention`. Number of snapshots to retain. | [optional][default to 5] |
-| **node_taint** | **String** | This maps to ranchers `node-taint`. Registering kubelet with set of taints. By default, server nodes will be schedulable and thus your workloads can get launched on them. If you wish to have a dedicated control plane where no user workloads will run, you can use taints. | [optional] |
-| **cluster_domain** | **String** | This maps to ranchers `cluster-domain`. Cluster Domain. | [optional] |
-| **certificates** | [**RancherClusterConfigCertificates**](RancherClusterConfigCertificates.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'pnap_rancher_api'
-
-instance = RancherApi::ClusterConfiguration.new(
-  token: gS7SnDnY5st0ryJxMXA7,
-  tls_san: mydomain.com,
-  etcd_snapshot_schedule_cron: 0 0,12 * * *,
-  etcd_snapshot_retention: 5,
-  node_taint: CriticalAddonsOnly=true:NoExecute,
-  cluster_domain: cluster.local,
-  certificates: null
-)
-```
-

data/docs/ClusterWorkloadConfiguration.md

@@ -1,24 +0,0 @@
-# RancherApi::ClusterWorkloadConfiguration
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **name** | **String** | The name of the workload cluster. This field is autogenerated if not provided. | [optional] |
-| **server_count** | **Integer** | Number of configured servers. Currently only server counts of 1 and 3 are possible. | [optional][default to 1] |
-| **server_type** | **String** | Node server type. Cannot be changed once the cluster is created. Currently this field should be set to either `s0.d1.small`, `s0.d1.medium`, `s1.c1.small`, `s1.c1.medium`, `s1.c2.medium`, `s1.c2.large`, `s1.e1.small`, `s1.e1.medium`, `s1.e1.large`, `s2.c1.small`, `s2.c1.medium`, `s2.c1.large`, `s2.c2.small`, `s2.c2.medium`, `s2.c2.large`, `d1.c1.small`, `d1.c2.small`, `d1.c3.small`, `d1.c4.small`, `d1.c1.medium`, `d1.c2.medium`, `d1.c3.medium`, `d1.c4.medium`, `d1.c1.large`, `d1.c2.large`, `d1.c3.large`, `d1.c4.large`, `d1.m1.medium`, `d1.m2.medium`, `d1.m3.medium`, `d1.m4.medium`, `d2.c3.medium`, `d2.c4.medium`, `d2.c5.medium`, `d2.c3.large`, `d2.c4.large`, `d2.c5.large`, `d2.m2.medium`, `d2.m2.large` or `d2.m2.xlarge`. | [default to 's0.d1.small'] |
-| **location** | **String** | Workload cluster location. Cannot be changed once cluster is created. Currently this field should be set to `PHX`, `ASH`, `SGP`, `NLD`, `CHI`, `SEA` or `AUS`. |  |
-
-## Example
-
-```ruby
-require 'pnap_rancher_api'
-
-instance = RancherApi::ClusterWorkloadConfiguration.new(
-  name: Workload CLuster,
-  server_count: 3,
-  server_type: s0.d1.small,
-  location: PHX
-)
-```
-

data/docs/NodePoolSshConfig.md

@@ -1,22 +0,0 @@
-# RancherApi::NodePoolSshConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **install_default_keys** | **Boolean** | Define whether public keys marked as default should be installed on this node. These are public keys that were already recorded on this system. Use <a href='https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/get' target='_blank'>GET /ssh-keys</a> to retrieve a list of possible values. | [optional][default to true] |
-| **keys** | **Array<String>** | List of public SSH keys. | [optional] |
-| **key_ids** | **Array<String>** | List of public SSH key identifiers. These are public keys that were already recorded on this system. Use <a href='https://developers.phoenixnap.com/docs/bmc/1/routes/ssh-keys/get' target='_blank'>GET /ssh-keys</a> to retrieve a list of possible values. | [optional] |
-
-## Example
-
-```ruby
-require 'pnap_rancher_api'
-
-instance = RancherApi::NodePoolSshConfig.new(
-  install_default_keys: true,
-  keys: [ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDF9LdAFElNCi7JoWh6KUcchrJ2Gac1aqGRPpdZNowObpRtmiRCecAMb7bUgNAaNfcmwiQi7tos9TlnFgprIcfMWb8MSs3ABYHmBgqEEt3RWYf0fAc9CsIpJdMCUG28TPGTlRXCEUVNKgLMdcseAlJoGp1CgbHWIN65fB3he3kAZcfpPn5mapV0tsl2p+ZyuAGRYdn5dJv2RZDHUZBkOeUobwsij+weHCKAFmKQKtCP7ybgVHaQjAPrj8MGnk1jBbjDt5ws+Be+9JNjQJee9zCKbAOsIo3i+GcUIkrw5jxPU/RTGlWBcemPaKHdciSzGcjWboapzIy49qypQhZe1U75 user],
-  key_ids: ["5fa54d1e91867c03a0a7b4a4"]
-)
-```
-

data/docs/RancherClusterConfigCertificates.md

@@ -1,22 +0,0 @@
-# RancherApi::RancherClusterConfigCertificates
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **ca_certificate** | **String** | The SSL CA certificate to be used for rancher admin. | [optional] |
-| **certificate** | **String** | The SSL certificate to be used for rancher admin. | [optional] |
-| **certificate_key** | **String** | The SSL certificate key to be used for rancher admin. | [optional] |
-
-## Example
-
-```ruby
-require 'pnap_rancher_api'
-
-instance = RancherApi::RancherClusterConfigCertificates.new(
-  ca_certificate: null,
-  certificate: null,
-  certificate_key: null
-)
-```
-

data/lib/pnap_rancher_api/models/cluster_configuration.rb

@@ -1,290 +0,0 @@
-=begin
-#Rancher Solution API
-
-#Simplify enterprise-grade Kubernetes cluster operations and management with Rancher on Bare Metal Cloud. Deploy Kubernetes clusters using a few API calls.<br> <br> <span class='pnap-api-knowledge-base-link'> Knowledge base articles to help you can be found <a href='https://phoenixnap.com/kb/rancher-bmc-integration-kubernetes' target='_blank'>here</a> </span><br> <br> <b>All URLs are relative to (https://api.phoenixnap.com/solutions/rancher/v1beta)</b> 
-
-The version of the OpenAPI document: 0.1
-Contact: support@phoenixnap.com
-Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.1.0
-
-=end
-
-require 'date'
-require 'time'
-
-module RancherApi
-  class ClusterConfiguration
-    # Shared secret used to join a server or agent to a cluster.
-    attr_accessor :token
-
-    # This maps to ranchers `tls-san`. Add additional hostname or IP as a Subject Alternative Name in the TLS cert.
-    attr_accessor :tls_san
-
-    # This maps to ranchers `etcd-snapshot-schedule-cron`. Snapshot interval time in cron spec. eg. every 5 hours ‘0 */5 * * *’. Default: at 12 am/pm
-    attr_accessor :etcd_snapshot_schedule_cron
-
-    # This maps to ranchers `etcd-snapshot-retention`. Number of snapshots to retain.
-    attr_accessor :etcd_snapshot_retention
-
-    # This maps to ranchers `node-taint`. Registering kubelet with set of taints. By default, server nodes will be schedulable and thus your workloads can get launched on them. If you wish to have a dedicated control plane where no user workloads will run, you can use taints.
-    attr_accessor :node_taint
-
-    # This maps to ranchers `cluster-domain`. Cluster Domain.
-    attr_accessor :cluster_domain
-
-    attr_accessor :certificates
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'token' => :'token',
-        :'tls_san' => :'tlsSan',
-        :'etcd_snapshot_schedule_cron' => :'etcdSnapshotScheduleCron',
-        :'etcd_snapshot_retention' => :'etcdSnapshotRetention',
-        :'node_taint' => :'nodeTaint',
-        :'cluster_domain' => :'clusterDomain',
-        :'certificates' => :'certificates'
-      }
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'token' => :'String',
-        :'tls_san' => :'String',
-        :'etcd_snapshot_schedule_cron' => :'String',
-        :'etcd_snapshot_retention' => :'Integer',
-        :'node_taint' => :'String',
-        :'cluster_domain' => :'String',
-        :'certificates' => :'RancherClusterConfigCertificates'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-      ])
-    end
-
-    # List of class defined in allOf (OpenAPI v3)
-    def self.openapi_all_of
-      [
-      :'RancherClusterConfig'
-      ]
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `RancherApi::ClusterConfiguration` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `RancherApi::ClusterConfiguration`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'token')
-        self.token = attributes[:'token']
-      end
-
-      if attributes.key?(:'tls_san')
-        self.tls_san = attributes[:'tls_san']
-      end
-
-      if attributes.key?(:'etcd_snapshot_schedule_cron')
-        self.etcd_snapshot_schedule_cron = attributes[:'etcd_snapshot_schedule_cron']
-      else
-        self.etcd_snapshot_schedule_cron = '0 0,12 * * *'
-      end
-
-      if attributes.key?(:'etcd_snapshot_retention')
-        self.etcd_snapshot_retention = attributes[:'etcd_snapshot_retention']
-      else
-        self.etcd_snapshot_retention = 5
-      end
-
-      if attributes.key?(:'node_taint')
-        self.node_taint = attributes[:'node_taint']
-      end
-
-      if attributes.key?(:'cluster_domain')
-        self.cluster_domain = attributes[:'cluster_domain']
-      end
-
-      if attributes.key?(:'certificates')
-        self.certificates = attributes[:'certificates']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          token == o.token &&
-          tls_san == o.tls_san &&
-          etcd_snapshot_schedule_cron == o.etcd_snapshot_schedule_cron &&
-          etcd_snapshot_retention == o.etcd_snapshot_retention &&
-          node_taint == o.node_taint &&
-          cluster_domain == o.cluster_domain &&
-          certificates == o.certificates
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [token, tls_san, etcd_snapshot_schedule_cron, etcd_snapshot_retention, node_taint, cluster_domain, certificates].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      new.build_from_hash(attributes)
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      self.class.openapi_types.each_pair do |key, type|
-        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
-          self.send("#{key}=", nil)
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        end
-      end
-
-      self
-    end
-
-    # Deserializes the data based on type
-    # @param string type Data type
-    # @param string value Value to be deserialized
-    # @return [Object] Deserialized data
-    def _deserialize(type, value)
-      case type.to_sym
-      when :Time
-        Time.parse(value)
-      when :Date
-        Date.parse(value)
-      when :String
-        value.to_s
-      when :Integer
-        value.to_i
-      when :Float
-        value.to_f
-      when :Boolean
-        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
-          true
-        else
-          false
-        end
-      when :Object
-        # generic object (usually a Hash), return directly
-        value
-      when /\AArray<(?<inner_type>.+)>\z/
-        inner_type = Regexp.last_match[:inner_type]
-        value.map { |v| _deserialize(inner_type, v) }
-      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
-        k_type = Regexp.last_match[:k_type]
-        v_type = Regexp.last_match[:v_type]
-        {}.tap do |hash|
-          value.each do |k, v|
-            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
-          end
-        end
-      else # model
-        # models (e.g. Pet) or oneOf
-        klass = RancherApi.const_get(type)
-        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
-      end
-    end
-
-    # Returns the string representation of the object
-    # @return [String] String presentation of the object
-    def to_s
-      to_hash.to_s
-    end
-
-    # to_body is an alias to to_hash (backward compatibility)
-    # @return [Hash] Returns the object in the form of hash
-    def to_body
-      to_hash
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-    # Outputs non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    # @param [Object] value Any valid value
-    # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
-      if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
-      elsif value.is_a?(Hash)
-        {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
-        end
-      elsif value.respond_to? :to_hash
-        value.to_hash
-      else
-        value
-      end
-    end
-
-  end
-
-end