kubernetes_references 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e0a5f4f32d9ba9c816e5a12a2789cc492a2fcd84713ebbfbf92c4ca3e975d86
+  data.tar.gz: 84067462e1752805bc906006bc041805f8369327756a0543d58800dca0e34eff
+SHA512:
+  metadata.gz: 79ebbefc87acf74ba4035bbc52f00ee95911ab7ba31573bdb1227871cd609ed7f35ba5c17caab41b38a8898ee710a6f03797878e480a5111012e9414cee59328
+  data.tar.gz: e69dcd1e11ecc685e185ec30562a5e34fba7c9506365c78dc6af96b829be346820318290f73073ddd3fa22bb755b603c4a61fa7797cbc4857c9b902c3aad43c9

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 2.6

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in kuberbetes.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Kohlrabbit
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,140 @@
+# KubernetesReferences
+
+**Current API version: v1.23**
+
+This Ruby gem attempts to collect all the Kubernetes objects available in the API as Ruby objects. Although not very useful at the moment, it could come in handy if you want to develop tools that need to play with the api's schemas.
+
+## Naming and conventions
+
+The files in this gem are named in snake_case and the classes are in camelCase.
+
+Class attributes are in snake_case to respect Ruby standards, unlike the official API, which is in camelCase.
+
+All attributes for each supported object are accepted.
+
+Plurals are preserved. `Object array` are implemented as `Array[Object]` with basic Ruby Array object, there is no such thing as a plural class.
+
+```yaml
+good: Array[KubernetesReferences::Container]
+bad: KubernetesReferences::Containers -> [KubernetesReferences::Container]
+```
+
+## Example
+
+```ruby
+require "kubernetes_references"
+
+container = KubernetesReferences::Container.new(
+  name: "my-container",
+  ports: [KubernetesReferences::ContainerPort.new(
+    container_port: 80,
+    name: "http",
+    protocol: "TCP"
+  )]
+)
+```
+
+Tired of writing "KubernetesReferences::" ? Shortcuts are present with the `Kube` prefix:
+
+```ruby
+require "kubernetes_references"
+
+container = KubeContainer.new(
+  name = "my-container",
+  ports: [KubeContainerPort.new(
+    container_port: 80,
+    name: "http",
+    protocol: "TCP"
+  )]
+)
+```
+
+Please check the test files for more examples of how to use this gem.
+
+## Types
+
+All objects have type definitions as rbs files, in the "sig" folder. To check types, the project uses Steep.
+
+```bash
+steep check
+
+No type error detected. 🧉
+```
+
+## How it works ?
+
+All classes in `lib/kubernetes_references` are inheriting from `KubernetesReferences::API`.
+
+This class implements a `#_set!` method that takes a constructor hash (`#initialize`) in order to populate class attributes (if present).
+
+```ruby
+module KubernetesReferences
+  class MyObjectClass < KubernetesReferences::API
+    attr_accessor :my_field
+    attr_accessor :another_field
+
+    # obj must be hash withfields:
+    # {
+    #   my_field: "my-value",
+    #   another_field: 1
+    # }
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end
+```
+
+Types of `my_field` and `another_field` are validated by `Steep` (in the `sig` folder):
+
+```ruby
+class KubernetesReferences::MyObjectClass
+  attr_accessor my_field: String
+  attr_accessor another_field: Integer
+end
+```
+
+This method avoids the need for additional requires such as OpenStruct or Struct.
+
+## Supported objects
+
+The Kubernetes api is extremely large and evolves regularly. For the moment, the following objects are supported:
+
+```
+core/v1 Capabilities
+core/v1 ConfigMapEnvSource
+core/v1 ConfigMapKeySelector
+core/v1 Container
+core/v1 ContainerPort
+core/v1 EnvFromSource
+core/v1 EnvVar
+core/v1 EnvVarSource
+core/v1 ExecAction
+core/v1 GRPCAction
+core/v1 HTTPGetAction
+core/v1 HTTPHeader
+core/v1 Lifecycle
+core/v1 LifecycleHandler
+core/v1 ObjectFieldSelector
+core/v1 Probe
+core/v1 Quantity # todo
+core/v1 ResourceFieldSelector
+core/v1 ResourceRequirements
+core/v1 SeccompProfile
+core/v1 SecretEnvSource
+core/v1 SecretKeySelector
+core/v1 SecurityContext
+core/v1 SELinuxOptions
+core/v1 TCPSocketAction
+core/v1 VolumeDevice
+core/v1 VolumeMount
+core/v1 WindowsSecurityContextOptions
+```
+
+## Tests
+
+The tests are written with Minitest.
+
+```
+rake test
+```

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/Steepfile

@@ -0,0 +1,32 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+#
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end
+
+target :kuberbetes do
+    signature "sig"
+    check "lib/**/*.rb"
+end

data/kubernetes_references.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/kubernetes_references/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "kubernetes_references"
+  spec.version = KubernetesReferences::VERSION
+  spec.authors = ["Kohlrabbit"]
+  spec.email = ["gautierfrancois+pgp@ik.me"]
+
+  spec.summary = "(wip) implementation of Kubernetes API objects in Ruby."
+  spec.description = "(wip) implementation of Kubernetes API objects in Ruby, with required types and normalized conventions."
+  spec.homepage = "https://github.com/Kohlrabbit/kubernetes-references"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Kohlrabbit/kubernetes-references"
+  spec.metadata["changelog_uri"] = "https://github.com/Kohlrabbit/kubernetes-references."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/kubernetes_references/api.rb

@@ -0,0 +1,18 @@
+require "kubernetes_references/errors"
+
+module KubernetesReferences
+  class API
+    def to_json
+    end
+
+    def _set!(obj)
+      obj.each do |k, v|
+        if self.respond_to?(k)
+          instance_variable_set("@#{k}", v)
+        else
+          raise InvalidObjectFieldError, k
+        end
+      end
+    end
+  end
+end

data/lib/kubernetes_references/capabilities.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class Capabilities < KubernetesReferences::API
+    attr_accessor :add
+    attr_accessor :drop
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/config_map_env_source.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class ConfigMapEnvSource < KubernetesReferences::API
+    attr_accessor :name
+    attr_accessor :optional
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/config_map_key_selector.rb

@@ -0,0 +1,11 @@
+module KubernetesReferences
+  class ConfigMapKeySelector < KubernetesReferences::API
+    attr_accessor :key
+    attr_accessor :name
+    attr_accessor :optional
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/container.rb

@@ -0,0 +1,30 @@
+module KubernetesReferences
+  class Container < KubernetesReferences::API
+    attr_accessor :args
+    attr_accessor :command
+    attr_accessor :env
+    attr_accessor :env_from
+    attr_accessor :image
+    attr_accessor :image_pull_policy
+    attr_accessor :lifecycle
+    attr_accessor :liveness_probe
+    attr_accessor :name
+    attr_accessor :ports
+    attr_accessor :readiness_probe
+    attr_accessor :resources
+    attr_accessor :security_context
+    attr_accessor :startup_probe
+    attr_accessor :stdin
+    attr_accessor :stdin_once
+    attr_accessor :termination_message_path
+    attr_accessor :termination_message_policy
+    attr_accessor :tty
+    attr_accessor :volume_devices
+    attr_accessor :volume_mounts
+    attr_accessor :working_dir
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/container_port.rb

@@ -0,0 +1,13 @@
+module KubernetesReferences
+  class ContainerPort < KubernetesReferences::API
+    attr_accessor :container_port
+    attr_accessor :host_ip
+    attr_accessor :host_port
+    attr_accessor :name
+    attr_accessor :protocol
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/env_from_source.rb

@@ -0,0 +1,11 @@
+module KubernetesReferences
+  class EnvFromSource < KubernetesReferences::API
+    attr_accessor :config_map_ref
+    attr_accessor :prefix
+    attr_accessor :secret_ref
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/env_var.rb

@@ -0,0 +1,11 @@
+module KubernetesReferences
+  class EnvVar < KubernetesReferences::API
+    attr_accessor :name
+    attr_accessor :value
+    attr_accessor :value_from
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/env_var_source.rb

@@ -0,0 +1,12 @@
+module KubernetesReferences
+  class EnvVarSource < KubernetesReferences::API
+    attr_accessor :config_map_key_ref
+    attr_accessor :field_ref
+    attr_accessor :resource_field_ref
+    attr_accessor :secret_key_ref
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/errors.rb

@@ -0,0 +1,4 @@
+module KubernetesReferences
+  class Error < StandardError ; end
+  class InvalidObjectFieldError < StandardError ; end
+end

data/lib/kubernetes_references/exec_action.rb

@@ -0,0 +1,9 @@
+module KubernetesReferences
+  class ExecAction < KubernetesReferences::API
+    attr_accessor :command
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/grpc_action.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class GRPCAction < KubernetesReferences::API
+    attr_accessor :port
+    attr_accessor :service
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/http_get_action.rb

@@ -0,0 +1,13 @@
+module KubernetesReferences
+  class HTTPGetAction < KubernetesReferences::API
+    attr_accessor :host
+    attr_accessor :http_headers
+    attr_accessor :path
+    attr_accessor :port
+    attr_accessor :scheme
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/http_header.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class HTTPHeader < KubernetesReferences::API
+    attr_accessor :name
+    attr_accessor :value
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/lifecycle.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class Lifecycle < KubernetesReferences::API
+    attr_accessor :post_start
+    attr_accessor :pre_stop
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/lifecycle_handler.rb

@@ -0,0 +1,11 @@
+module KubernetesReferences
+  class LifecycleHandler < KubernetesReferences::API
+    attr_accessor :exec
+    attr_accessor :http_get
+    attr_accessor :tcp_socket # deprecated in v1.23
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/object_field_selector.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class ObjectFieldSelector < KubernetesReferences::API
+    attr_accessor :api_version
+    attr_accessor :field_path
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/probe.rb

@@ -0,0 +1,18 @@
+module KubernetesReferences
+  class Probe < KubernetesReferences::API
+    attr_accessor :exec
+    attr_accessor :failure_threshold
+    attr_accessor :grpc
+    attr_accessor :http_get
+    attr_accessor :initial_delay_seconds
+    attr_accessor :period_seconds
+    attr_accessor :success_threshold
+    attr_accessor :tcp_socket
+    attr_accessor :termination_grace_period_seconds
+    attr_accessor :timeout_seconds
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/quantity.rb

@@ -0,0 +1,14 @@
+module KubernetesReferences
+  class Quantity < KubernetesReferences::API
+    attr_accessor :value
+
+    def initialize(obj)
+      _set!(obj)
+    end
+
+    def to_json
+      # todo: implement requirements from Kubernetes doc
+      # https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#quantity-resource-core
+    end
+  end
+end

data/lib/kubernetes_references/resource_field_selector.rb

@@ -0,0 +1,11 @@
+module KubernetesReferences
+  class ResourceFieldSelector < KubernetesReferences::API
+    attr_accessor :container_name
+    attr_accessor :divisor
+    attr_accessor :resource
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/resource_requirements.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class ResourceRequirements < KubernetesReferences::API
+    attr_accessor :limits
+    attr_accessor :requests
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/seccomp_profile.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class SeccompProfile < KubernetesReferences::API
+    attr_accessor :localhost_profile
+    attr_accessor :type
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/secret_env_source.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class SecretEnvSource < KubernetesReferences::API
+    attr_accessor :name
+    attr_accessor :optional
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/secret_key_selector.rb

@@ -0,0 +1,11 @@
+module KubernetesReferences
+  class SecretKeySelector < KubernetesReferences::API
+    attr_accessor :key
+    attr_accessor :name
+    attr_accessor :optional
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/security_context.rb

@@ -0,0 +1,19 @@
+module KubernetesReferences
+  class SecurityContext < KubernetesReferences::API
+    attr_accessor :allow_privilege_escalation
+    attr_accessor :capabilities
+    attr_accessor :privileged
+    attr_accessor :proc_mount
+    attr_accessor :read_only_root_filesystem
+    attr_accessor :run_as_group
+    attr_accessor :run_as_non_root
+    attr_accessor :run_as_user
+    attr_accessor :selinux_options
+    attr_accessor :seccomp_profile
+    attr_accessor :windows_options
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/selinux_options.rb

@@ -0,0 +1,12 @@
+module KubernetesReferences
+  class SELinuxOptions < KubernetesReferences::API
+    attr_accessor :level
+    attr_accessor :role
+    attr_accessor :type
+    attr_accessor :user
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/tcp_socket_action.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class TCPSocketAction < KubernetesReferences::API
+    attr_accessor :host
+    attr_accessor :port
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module KubernetesReferences
+  VERSION = "0.1.0"
+end

data/lib/kubernetes_references/volume_device.rb

@@ -0,0 +1,10 @@
+module KubernetesReferences
+  class VolumeDevice < KubernetesReferences::API
+    attr_accessor :device_path
+    attr_accessor :name
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/volume_mount.rb

@@ -0,0 +1,14 @@
+module KubernetesReferences
+  class VolumeMount < KubernetesReferences::API
+    attr_accessor :mount_path
+    attr_accessor :mount_propagation
+    attr_accessor :name
+    attr_accessor :read_only
+    attr_accessor :sub_path
+    attr_accessor :sub_path_expr
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references/windows_security_context_options.rb

@@ -0,0 +1,12 @@
+module KubernetesReferences
+  class WindowsSecurityContextOptions < KubernetesReferences::API
+    attr_accessor :gmsa_credential_spec
+    attr_accessor :gmsa_credential_spec_name
+    attr_accessor :host_process
+    attr_accessor :run_as_user_name
+
+    def initialize(obj)
+      _set!(obj)
+    end
+  end
+end

data/lib/kubernetes_references.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require "kubernetes_references/errors"
+require "kubernetes_references/api"
+require "kubernetes_references/capabilities"
+require "kubernetes_references/config_map_env_source"
+require "kubernetes_references/config_map_key_selector"
+require "kubernetes_references/container_port"
+require "kubernetes_references/container"
+require "kubernetes_references/env_from_source"
+require "kubernetes_references/env_var_source"
+require "kubernetes_references/env_var"
+require "kubernetes_references/exec_action"
+require "kubernetes_references/grpc_action"
+require "kubernetes_references/http_get_action"
+require "kubernetes_references/http_header"
+require "kubernetes_references/lifecycle_handler"
+require "kubernetes_references/lifecycle"
+require "kubernetes_references/object_field_selector"
+require "kubernetes_references/probe"
+require "kubernetes_references/quantity"
+require "kubernetes_references/resource_field_selector"
+require "kubernetes_references/resource_requirements"
+require "kubernetes_references/seccomp_profile"
+require "kubernetes_references/secret_env_source"
+require "kubernetes_references/secret_key_selector"
+require "kubernetes_references/security_context"
+require "kubernetes_references/selinux_options"
+require "kubernetes_references/tcp_socket_action"
+require "kubernetes_references/volume_device"
+require "kubernetes_references/volume_mount"
+require "kubernetes_references/windows_security_context_options"
+
+module KubernetesReferences
+  VERSION = 0.1
+  KUBE_API_VERSION = "v1.23"
+
+  class Error < StandardError; end
+  # Your code goes here...
+end
+
+KubeCapabilities = KubernetesReferences::Capabilities
+KubeConfigMapEnvSource = KubernetesReferences::ConfigMapEnvSource
+KubeContainerPort = KubernetesReferences::ContainerPort
+KubeContainer = KubernetesReferences::Container
+KubeEnvFromSource = KubernetesReferences::EnvFromSource
+KubeEnvVarSource = KubernetesReferences::EnvVarSource
+KubeEnvVar = KubernetesReferences::EnvVar
+KubeExecAction = KubernetesReferences::ExecAction
+KubeGRPCAction = KubernetesReferences::GRPCAction
+KubeHTTPGetAction = KubernetesReferences::HTTPGetAction
+KubeHTTPHeader = KubernetesReferences::HTTPHeader
+KubeLifecycleHandler = KubernetesReferences::LifecycleHandler
+KubeLifecycle = KubernetesReferences::Lifecycle
+KubeObjectFieldSelector = KubernetesReferences::ObjectFieldSelector
+KubeProbe = KubernetesReferences::Probe
+KubeQuantity = KubernetesReferences::Quantity
+KubeResourceFieldSelector = KubernetesReferences::ResourceFieldSelector
+KubeResourceRequirements = KubernetesReferences::ResourceRequirements
+KubeSeccompProfile = KubernetesReferences::SeccompProfile
+KubeSecretEnvSource = KubernetesReferences::SecretEnvSource
+KubeSecretKeySelector = KubernetesReferences::SecretKeySelector
+KubeSecurityContext = KubernetesReferences::SecurityContext
+KubeSELinuxOptions = KubernetesReferences::SELinuxOptions
+KubeTCPSocketAction = KubernetesReferences::TCPSocketAction
+KubeVolumeDevice = KubernetesReferences::VolumeDevice
+KubeVolumeMount = KubernetesReferences::VolumeMount
+KubeWindowsSecurityContextOptions = KubernetesReferences::WindowsSecurityContextOptions

data/sig/capabilities.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::Capabilities < KubernetesReferences::API
+  attr_accessor add: Array[String]
+  attr_accessor drop: Array[String]
+
+  def initialize: (untyped obj) -> void
+end

data/sig/config_map_env_source.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::ConfigMapEnvSource < KubernetesReferences::API
+  attr_accessor name: String
+  attr_accessor optional: bool
+
+  def initialize: (untyped obj) -> void
+end

data/sig/config_map_key_selector.rbs

@@ -0,0 +1,7 @@
+class KubernetesReferences::ConfigMapKeySelector < KubernetesReferences::API
+  attr_accessor key: String
+  attr_accessor name: String
+  attr_accessor optional: bool
+
+  def initialize: (untyped obj) -> void
+end

data/sig/container.rbs

@@ -0,0 +1,26 @@
+class KubernetesReferences::Container < KubernetesReferences::API
+  attr_accessor args: Array[String]
+  attr_accessor command: Array[String]
+  attr_accessor env: Array[::KubernetesReferences::EnvVar]
+  attr_accessor env_from: Array[::KubernetesReferences::EnvFromSource]
+  attr_accessor image: String
+  attr_accessor image_pull_policy: String
+  attr_accessor lifecycle: ::KubernetesReferences::Lifecycle
+  attr_accessor liveness_probe: ::KubernetesReferences::Probe
+  attr_accessor name: String
+  attr_accessor ports: Array[::KubernetesReferences::ContainerPort]
+  attr_accessor readiness_probe: ::KubernetesReferences::Probe
+  attr_accessor resources: ::KubernetesReferences::ResourceRequirements
+  attr_accessor security_context: ::KubernetesReferences::SecurityContext
+  attr_accessor startup_probe: ::KubernetesReferences::Probe
+  attr_accessor stdin: bool
+  attr_accessor stdin_once: bool
+  attr_accessor termination_message_path: String
+  attr_accessor termination_message_policy: String
+  attr_accessor tty: bool
+  attr_accessor volume_devices: Array[::KubernetesReferences::VolumeDevice]
+  attr_accessor volume_mounts: Array[::KubernetesReferences::VolumeMount]
+  attr_accessor working_dir: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/container_port.rbs

@@ -0,0 +1,9 @@
+class KubernetesReferences::ContainerPort < KubernetesReferences::API
+  attr_accessor container_port: Integer
+  attr_accessor host_ip: String
+  attr_accessor host_port: Integer
+  attr_accessor name: String
+  attr_accessor protocol: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/env_from_source.rbs

@@ -0,0 +1,7 @@
+class KubernetesReferences::EnvFromSource < KubernetesReferences::API
+  attr_accessor config_map_ref: ::KubernetesReferences::ConfigMapEnvSource
+  attr_accessor prefix: String
+  attr_accessor secret_ref: ::KubernetesReferences::SecretEnvSource
+
+  def initialize: (untyped obj) -> void
+end

data/sig/env_var.rbs

@@ -0,0 +1,7 @@
+class KubernetesReferences::EnvVar < KubernetesReferences::API
+  attr_accessor name: String
+  attr_accessor value: String
+  attr_accessor value_from: ::KubernetesReferences::EnvVarSource
+
+  def initialize: (untyped obj) -> void
+end

data/sig/env_var_source.rbs

@@ -0,0 +1,8 @@
+class KubernetesReferences::EnvVarSource < KubernetesReferences::API
+  attr_accessor config_map_key_ref: ::KubernetesReferences::ConfigMapKeySelector
+  attr_accessor field_ref: ::KubernetesReferences::ObjectFieldSelector
+  attr_accessor resource_field_ref: ::KubernetesReferences::ResourceFieldSelector
+  attr_accessor secret_key_ref: ::KubernetesReferences::SecretKeySelector
+
+  def initialize: (untyped obj) -> void
+end

data/sig/errors.rbs

@@ -0,0 +1,6 @@
+module KubernetesReferences
+  class Error < StandardError
+  end
+  class InvalidObjectFieldError < Error
+  end
+end

data/sig/exec_action.rbs

@@ -0,0 +1,5 @@
+class KubernetesReferences::ExecAction < KubernetesReferences::API
+  attr_accessor command: Array[String]
+
+  def initialize: (untyped obj) -> void
+end

data/sig/grpc_action.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::GRPCAction < KubernetesReferences::API
+  attr_accessor port: Integer
+  attr_accessor service: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/http_get_action.rbs

@@ -0,0 +1,9 @@
+class KubernetesReferences::HTTPGetAction < KubernetesReferences::API
+  attr_accessor host: String
+  attr_accessor http_headers: Array[::KubernetesReferences::HTTPHeader]
+  attr_accessor path: String
+  attr_accessor port: Integer
+  attr_accessor scheme: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/http_header.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::HTTPHeader < KubernetesReferences::API
+  attr_accessor name: String
+  attr_accessor value: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/kubernetes_references.rbs

@@ -0,0 +1,7 @@
+module KubernetesReferences
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    class API
+        def _set!: (Hash[untyped, untyped]) -> untyped
+    end
+end

data/sig/lifecycle.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::Lifecycle < KubernetesReferences::API
+  attr_accessor post_start: ::KubernetesReferences::LifecycleHandler
+  attr_accessor pre_stop: ::KubernetesReferences::LifecycleHandler
+
+  def initialize: (untyped obj) -> void
+end

data/sig/lifecycle_handler.rbs

@@ -0,0 +1,7 @@
+class KubernetesReferences::LifecycleHandler < KubernetesReferences::API
+  attr_accessor exec: ::KubernetesReferences::ExecAction
+  attr_accessor http_get: ::KubernetesReferences::HTTPGetAction
+  attr_accessor tcp_socket: void
+
+  def initialize: (untyped obj) -> void
+end

data/sig/object_field_selector.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::ObjectFieldSelector < KubernetesReferences::API
+  attr_accessor api_version: String
+  attr_accessor field_path: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/probe.rbs

@@ -0,0 +1,14 @@
+class KubernetesReferences::Probe < KubernetesReferences::API
+  attr_accessor exec: ::KubernetesReferences::ExecAction
+  attr_accessor failure_threshold: Integer
+  attr_accessor grpc: ::KubernetesReferences::GRPCAction
+  attr_accessor http_get: ::KubernetesReferences::HTTPGetAction
+  attr_accessor initial_delay_seconds: Integer
+  attr_accessor period_seconds: Integer
+  attr_accessor success_threshold: Integer
+  attr_accessor tcp_socket: ::KubernetesReferences::TCPSocketAction
+  attr_accessor termination_grace_period_seconds: Integer
+  attr_accessor timeout_seconds: Integer
+
+  def initialize: (untyped obj) -> void
+end

data/sig/quantity.rbs

@@ -0,0 +1,5 @@
+class KubernetesReferences::Quantity < KubernetesReferences::API
+  attr_accessor value: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/resource_field_selector.rbs

@@ -0,0 +1,7 @@
+class KubernetesReferences::ResourceFieldSelector < KubernetesReferences::API
+  attr_accessor container_name: String
+  attr_accessor divisor: ::KubernetesReferences::Quantity
+  attr_accessor resource: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/resource_requirements.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::ResourceRequirements < KubernetesReferences::API
+  attr_accessor limits: untyped
+  attr_accessor requests: untyped
+
+  def initialize: (untyped obj) -> void
+end

data/sig/seccomp_profile.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::SeccompProfile < KubernetesReferences::API
+  attr_accessor localhost_profile: String
+  attr_accessor type: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/secret_env_source.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::SecretEnvSource < KubernetesReferences::API
+  attr_accessor name: String
+  attr_accessor optional: bool
+
+  def initialize: (untyped obj) -> void
+end

data/sig/secret_key_selector.rbs

@@ -0,0 +1,7 @@
+class KubernetesReferences::SecretKeySelector < KubernetesReferences::API
+  attr_accessor key: String
+  attr_accessor name: String
+  attr_accessor optional: bool
+
+  def initialize: (untyped obj) -> void
+end

data/sig/security_context.rbs

@@ -0,0 +1,15 @@
+class KubernetesReferences::SecurityContext < KubernetesReferences::API
+  attr_accessor allow_privilege_escalation: bool
+  attr_accessor capabilities: ::KubernetesReferences::Capabilities
+  attr_accessor privileged: bool
+  attr_accessor proc_mount: String
+  attr_accessor read_only_root_filesystem: bool
+  attr_accessor run_as_group: Integer
+  attr_accessor run_as_non_root: bool
+  attr_accessor run_as_user: Integer
+  attr_accessor selinux_options: ::KubernetesReferences::SELinuxOptions
+  attr_accessor seccomp_profile: ::KubernetesReferences::SeccompProfile
+  attr_accessor windows_options: ::KubernetesReferences::WindowsSecurityContextOptions
+
+  def initialize: (untyped obj) -> void
+end

data/sig/selinux_options.rbs

@@ -0,0 +1,8 @@
+class KubernetesReferences::SELinuxOptions < KubernetesReferences::API
+  attr_accessor level: String
+  attr_accessor role: String
+  attr_accessor type: String
+  attr_accessor user: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/tcp_socket_action.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::TCPSocketAction < KubernetesReferences::API
+  attr_accessor host: String
+  attr_accessor port: Integer
+
+  def initialize: (untyped obj) -> void
+end

data/sig/volume_device.rbs

@@ -0,0 +1,6 @@
+class KubernetesReferences::VolumeDevice < KubernetesReferences::API
+  attr_accessor device_path: String
+  attr_accessor name: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/volume_mount.rbs

@@ -0,0 +1,10 @@
+class KubernetesReferences::VolumeMount < KubernetesReferences::API
+  attr_accessor mount_path: String
+  attr_accessor mount_propagation: String
+  attr_accessor name: String
+  attr_accessor read_only: bool
+  attr_accessor sub_path: String
+  attr_accessor sub_path_expr: String
+
+  def initialize: (untyped obj) -> void
+end

data/sig/windows_security_context_options.rbs

@@ -0,0 +1,8 @@
+class KubernetesReferences::WindowsSecurityContextOptions < KubernetesReferences::API
+  attr_accessor gmsa_credential_spec: String
+  attr_accessor gmsa_credential_spec_name: String
+  attr_accessor host_process: bool
+  attr_accessor run_as_user_name: String
+
+  def initialize: (untyped obj) -> void
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: kubernetes_references
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kohlrabbit
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-30 00:00:00.000000000 Z
+dependencies: []
+description: "(wip) implementation of Kubernetes API objects in Ruby, with required
+  types and normalized conventions."
+email:
+- gautierfrancois+pgp@ik.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- kubernetes_references.gemspec
+- lib/kubernetes_references.rb
+- lib/kubernetes_references/api.rb
+- lib/kubernetes_references/capabilities.rb
+- lib/kubernetes_references/config_map_env_source.rb
+- lib/kubernetes_references/config_map_key_selector.rb
+- lib/kubernetes_references/container.rb
+- lib/kubernetes_references/container_port.rb
+- lib/kubernetes_references/env_from_source.rb
+- lib/kubernetes_references/env_var.rb
+- lib/kubernetes_references/env_var_source.rb
+- lib/kubernetes_references/errors.rb
+- lib/kubernetes_references/exec_action.rb
+- lib/kubernetes_references/grpc_action.rb
+- lib/kubernetes_references/http_get_action.rb
+- lib/kubernetes_references/http_header.rb
+- lib/kubernetes_references/lifecycle.rb
+- lib/kubernetes_references/lifecycle_handler.rb
+- lib/kubernetes_references/object_field_selector.rb
+- lib/kubernetes_references/probe.rb
+- lib/kubernetes_references/quantity.rb
+- lib/kubernetes_references/resource_field_selector.rb
+- lib/kubernetes_references/resource_requirements.rb
+- lib/kubernetes_references/seccomp_profile.rb
+- lib/kubernetes_references/secret_env_source.rb
+- lib/kubernetes_references/secret_key_selector.rb
+- lib/kubernetes_references/security_context.rb
+- lib/kubernetes_references/selinux_options.rb
+- lib/kubernetes_references/tcp_socket_action.rb
+- lib/kubernetes_references/version.rb
+- lib/kubernetes_references/volume_device.rb
+- lib/kubernetes_references/volume_mount.rb
+- lib/kubernetes_references/windows_security_context_options.rb
+- sig/capabilities.rbs
+- sig/config_map_env_source.rbs
+- sig/config_map_key_selector.rbs
+- sig/container.rbs
+- sig/container_port.rbs
+- sig/env_from_source.rbs
+- sig/env_var.rbs
+- sig/env_var_source.rbs
+- sig/errors.rbs
+- sig/exec_action.rbs
+- sig/grpc_action.rbs
+- sig/http_get_action.rbs
+- sig/http_header.rbs
+- sig/kubernetes_references.rbs
+- sig/lifecycle.rbs
+- sig/lifecycle_handler.rbs
+- sig/object_field_selector.rbs
+- sig/probe.rbs
+- sig/quantity.rbs
+- sig/resource_field_selector.rbs
+- sig/resource_requirements.rbs
+- sig/seccomp_profile.rbs
+- sig/secret_env_source.rbs
+- sig/secret_key_selector.rbs
+- sig/security_context.rbs
+- sig/selinux_options.rbs
+- sig/tcp_socket_action.rbs
+- sig/volume_device.rbs
+- sig/volume_mount.rbs
+- sig/windows_security_context_options.rbs
+homepage: https://github.com/Kohlrabbit/kubernetes-references
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Kohlrabbit/kubernetes-references
+  source_code_uri: https://github.com/Kohlrabbit/kubernetes-references
+  changelog_uri: https://github.com/Kohlrabbit/kubernetes-references.
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: "(wip) implementation of Kubernetes API objects in Ruby."
+test_files: []