kubernetes_references 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0a5f4f32d9ba9c816e5a12a2789cc492a2fcd84713ebbfbf92c4ca3e975d86
-  data.tar.gz: 84067462e1752805bc906006bc041805f8369327756a0543d58800dca0e34eff
+  metadata.gz: 140f77c60537f81161b442747444d742ad4f04d9cdf1f2cce952d7a39caca37f
+  data.tar.gz: a0bfb97506691ab7826f251fad574e9e2e8e654a689ea99e5b42a2291ddbb7dd
 SHA512:
-  metadata.gz: 79ebbefc87acf74ba4035bbc52f00ee95911ab7ba31573bdb1227871cd609ed7f35ba5c17caab41b38a8898ee710a6f03797878e480a5111012e9414cee59328
-  data.tar.gz: e69dcd1e11ecc685e185ec30562a5e34fba7c9506365c78dc6af96b829be346820318290f73073ddd3fa22bb755b603c4a61fa7797cbc4857c9b902c3aad43c9
+  metadata.gz: a6bad835c6c839bbedffe4078873e9606bb0dd2829d32c3261c05825482fa6b4a8ded42206ffcb71d71442afd6a737a1a181361483d111e5af081a0aee2b58a1
+  data.tar.gz: 64a50e2c8f35f0a40cddcaaf7c9d080e878b25f0672d7307cadb1f922b5bd3ac4ca78b43a16122de39c1976999a372b4e032f38ee722156e9595085f27b82f5a

data/Gemfile

@@ -10,3 +10,5 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "standard", "~> 1.3"
+
+gem "steep"

data/Gemfile.lock

@@ -0,0 +1,101 @@
+PATH
+  remote: .
+  specs:
+    kubernetes_references (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    concurrent-ruby (1.2.2)
+    csv (3.2.6)
+    ffi (1.15.5)
+    fileutils (1.7.1)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.0.0)
+    listen (3.8.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    logger (1.5.3)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (3.1.0)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.2.2)
+    standard (1.28.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50.2)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.0.1)
+    standard-custom (1.0.0)
+      lint_roller (~> 1.0)
+    standard-performance (1.0.1)
+      lint_roller (~> 1.0)
+      rubocop-performance (~> 1.16.0)
+    steep (1.4.0)
+      activesupport (>= 5.1)
+      concurrent-ruby (>= 1.2.2)
+      csv (>= 3.0.9)
+      fileutils (>= 1.1.0)
+      json (>= 2.1.0)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      logger (>= 1.3.0)
+      parser (>= 3.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.8.0)
+      securerandom (>= 0.1)
+      strscan (>= 1.0.0)
+      terminal-table (>= 2, < 4)
+    strscan (3.0.6)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  kubernetes_references!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  standard (~> 1.3)
+  steep
+
+BUNDLED WITH
+   2.4.12

data/README.md

@@ -1,9 +1,25 @@
 # KubernetesReferences
 
+[![Gem Version](https://badge.fury.io/rb/kubernetes_references.svg)](https://badge.fury.io/rb/kubernetes_references)
+
 **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.
 
+## What is it
+
+* a dictionary of native Kubernetes objects
+* a precise definition of object types
+* a native library without external dependencies
+
+
+## What it is not
+
+* a wrapper around kubectl explain
+* a Kubernetes client
+* a tool officially managed by the Kubernetes team
+
+
 ## Naming and conventions
 
 The files in this gem are named in snake_case and the classes are in camelCase.
@@ -34,7 +50,7 @@ container = KubernetesReferences::Container.new(
 )
 ```
 
-Tired of writing "KubernetesReferences::" ? Shortcuts are present with the `Kube` prefix:
+Tired of writing "KubernetesReferences::" ? Classes are also callable with the `Kube` prefix:
 
 ```ruby
 require "kubernetes_references"
@@ -51,6 +67,22 @@ container = KubeContainer.new(
 
 Please check the test files for more examples of how to use this gem.
 
+## Compatibility with Kubernetes API
+
+Since Ruby uses snake_case attributes instead of the camelCase used by Go (and therefore by Kubernetes), each object definition (let's call them templates) has a `#schema` method that returns a (native) Ruby hash with the right keys.
+
+
+**Example**
+
+```
+irb(main):001:0> container = KubeContainer.new(image_pull_policy: "Always")
+=> #<KubernetesReferences::Container:0x0000000100f4ce18 @image_pull_policy="Always">
+irb(main):002:0> container.schema
+=> {:imagePullPolicy=>"Always"}
+```
+
+when calling the "`#schema`" method, all sub-models on which the called object depends are also rendered with the correct keys. You can basically use the `to_json` method on `schema` to generate ready-to-use Kubernetes `json` manifests.
+
 ## Types
 
 All objects have type definitions as rbs files, in the "sig" folder. To check types, the project uses Steep.
@@ -73,7 +105,7 @@ module KubernetesReferences
     attr_accessor :my_field
     attr_accessor :another_field
 
-    # obj must be hash withfields:
+    # obj must be hash with fields:
     # {
     #   my_field: "my-value",
     #   another_field: 1
@@ -88,9 +120,13 @@ 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
+module KubernetesReferences
+  class MyObjectClass < KubernetesReferences::API
+    attr_accessor my_field: String
+    attr_accessor another_field: Integer
+
+    def initialize: (untyped obj) -> void
+  end
 end
 ```
 
@@ -100,35 +136,191 @@ This method avoids the need for additional requires such as OpenStruct or Struct
 
 The Kubernetes api is extremely large and evolves regularly. For the moment, the following objects are supported:
 
+### Workloads APIs
+
+- [x] Container v1 core
+- [x] CronJob v1 batch
+- [x] DaemonSet v1 apps
+- [x] Deployment v1 apps
+- [x] Job v1 batch
+- [x] Pod v1 core
+- [] ReplicaSet v1 apps
+- [] ReplicationController v1 core
+- [] StatefulSet v1 apps
+
+### Service APIs
+
+- [] Endpoints v1 core
+- [] EndpointSlice v1 discovery.k8s.io
+- [] Ingress v1 networking.k8s.io
+- [] IngressClass v1 networking.k8s.io
+- [] Service v1 core
+
+### Config and storage APIs
+
+- [] ConfigMap v1 core
+- [] CSIDriver v1 storage.k8s.io
+- [] CSINode v1 storage.k8s.io
+- [] Secret v1 core
+- [] PersistentVolumeClaim v1 core
+- [] StorageClass v1 storage.k8s.io
+- [] CSIStorageCapacity v1beta1 storage.k8s.io
+- [] Volume v1 core
+- [] VolumeAttachment v1 storage.k8s.io
+
+### Metadata APIs
+
+- [] ControllerRevision v1 apps
+- [] CustomResourceDefinition v1 apiextensions.k8s.io
+- [] Event v1 events.k8s.io
+- [] LimitRange v1 core
+- [] HorizontalPodAutoscaler v1 autoscaling
+- [] MutatingWebhookConfiguration v1 admissionregistration.k8s.io
+- [] ValidatingWebhookConfiguration v1 admissionregistration.k8s.io
+- [] PodTemplate v1 core
+- [] PodDisruptionBudget v1 policy
+- [] PriorityClass v1 scheduling.k8s.io
+- [] PodSecurityPolicy v1beta policy
+
+### Cluster APIs
+
+- [] APIService v1 apiregistration.k8s.io
+- [] Binding v1 core
+- [] CertificateSigningRequest v1 certificats.k8s.io
+- [] ClusterRole v1 rbac.authorization.k8s.io
+- [] ClusterRoleBinding v1 rbac.authorization.k8s.io
+- [] ComponentStatus v1 core
+- [] FlowSchema v1beta1 flowcontrol.apiserver.k8s.io
+- [] Lease v1 coordination.k8s.io
+- [] LocalSubjectAccessReview v1 authorization.k8s.io
+- [] Namespace v1 core
+- [] Node v1 core
+- [] PersistentVolume v1 core
+- [] PriorityLevelConfiguration v1beta1 flowcontrol.apiserver.k8s.io
+- [] ResourceQuota v1 core
+- [] Role v1 rbac.authorization.k8s.io
+- [] RoleBinding v1 rbac.authorization.k8s.io
+- [] RuntimeClass v1 nodes.k8s.io
+- [] SelfSubjectAccessReview v1 authorization.k8s.io
+- [] SelfSubjectRulesReview v1 authorization.k8s.io
+- [] ServiceAccount v1 core
+- [] StorageVersion v1alpha1 internal.apiserver.k8s.io
+- [] SubjectAccessReview v1 authorization.k8s.io
+- [] TokenRequest v1 authentication.k8s.io
+- [] TokenReview v1 authentication.k8s.io
+- [] NetworkPolicy v1 networking.k8s.io
 ```
-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
+Affinity
+AWSElasticBlockStoreVolumeSource
+AzureDiskVolumeSource
+AzureFileVolumeSource
+Capabilities
+CephFSVolumeSource
+CinderVolumeSource
+ConfigMapEnvSource
+ConfigMapKeySelector
+ConfigMapProjection
+ConfigMapVolumeSource
+Container
+ContainerPort
+ContainerState
+ContainerStateRunning
+ContainerStateTerminated
+ContainerStateWaiting
+ContainerStatus
+CronJob
+CronJobSpec
+CronJobStatus
+CSIVolumeSource
+DownwardAPIProjection
+DownwardAPIVolumeFile
+DownwardAPIVolumeSource
+EmptyDirVolumeSource
+EnvFromSource
+EnvVar
+EnvVarSource
+EphemeralContainer
+EphemeralVolumeSource
+ExecAction
+FCVolumeSource
+FieldsV1
+FlexVolumeSource
+FlockerVolumeSource
+GCEPersistentDiskVolumeSource
+GitRepoVolumeSource
+GlusterfsVolumeSource
+GRPCAction
+HostAlias
+HostPathVolumeSource
+HTTPGetAction
+HTTPHeader
+InvalidObjectFieldError
+ISCSIVolumeSource
+JobSpec
+JobTemplateSpec
+KeyToPath
+KubernetesReferences::Quantity
+LabelSelector
+LabelSelectorRequirement
+Lifecycle
+LifecycleHandler
+LocalObjectReference
+ManagedFieldsEntry
+NFSVolumeSource
+NodeAffinity
+NodeSelector
+NodeSelectorRequirement
+NodeSelectorTerm
+ObjectFieldSelector
+ObjectMeta
+ObjectReference
+OwnerReference
+PersistentVolumeClaimSpec
+PersistentVolumeClaimTemplate
+PersistentVolumeClaimVolumeSource
+PhotonPersistentDiskVolumeSource
+PodAffinity
+PodAffinityTerm
+PodAntiAffinity
+PodDNSConfig
+PodDNSConfigOption
+PodOS
+PodReadinessGate
+PodSecurityContext
+PodSpec
+PodTemplateSpec
+PortworxVolumeSource
+PreferredSchedulingTerm
+Probe
+ProjectedVolumeSource
+Quantity
+QuobyteVolumeSource
+RBDVolumeSource
+ResourceFieldSelector
+ResourceRequirements
+ScaleIOVolumeSource
+SeccompProfile
+SecretEnvSource
+SecretKeySelector
+SecretProjection
+SecretVolumeSource
+SecurityContext
+SELinuxOptions
+ServiceAccountTokenProjection
+StorageOSVolumeSource
+Sysctl
+TCPSocketAction
+TestKubernetesReferences
+Toleration
+TopologySpreadConstraint
+TypedLocalObjectReference
+Volume
+VolumeDevice
+VolumeMount
+VolumeProjection
+VsphereVirtualDiskVolumeSource
+WeightedPodAffinityTerm
+WindowsSecurityContextOptions
 ```
 
 ## Tests

data/Steepfile

@@ -28,5 +28,7 @@
 
 target :kuberbetes do
     signature "sig"
+    signature "sig/**/*.rbs"
+    library "yaml"
     check "lib/**/*.rb"
 end

data/lib/kubernetes_references/{exec_action.rb → action/exec_action.rb}

@@ -1,9 +1,16 @@
 module KubernetesReferences
   class ExecAction < KubernetesReferences::API
+    # @dynamic command, command=
     attr_accessor :command
 
     def initialize(obj)
       _set!(obj)
     end
+
+    def _schema
+      {
+        command: @command
+      }
+    end
   end
 end

data/lib/kubernetes_references/{grpc_action.rb → action/grpc_action.rb}

@@ -1,10 +1,18 @@
 module KubernetesReferences
   class GRPCAction < KubernetesReferences::API
+    # @dynamic port, port=, service, service=
     attr_accessor :port
     attr_accessor :service
 
     def initialize(obj)
       _set!(obj)
     end
+
+    def _schema
+      {
+        port: @port,
+        service: @service
+      }
+    end
   end
 end

data/lib/kubernetes_references/action/http_get_action.rb

@@ -0,0 +1,24 @@
+module KubernetesReferences
+  class HTTPGetAction < KubernetesReferences::API
+    # @dynamic host, host=, http_headers, http_headers=, path, path=, port, port=, scheme, scheme=
+    attr_accessor :host
+    attr_accessor :http_headers
+    attr_accessor :path
+    attr_accessor :port
+    attr_accessor :scheme
+
+    def initialize(obj)
+      _set!(obj)
+    end
+
+    def _schema
+      {
+        host: @host,
+        httpHeaders: @http_headers.each{|r| r.schema},
+        path: @path,
+        port: @port,
+        scheme: @scheme
+      }
+    end
+  end
+end

data/lib/kubernetes_references/{tcp_socket_action.rb → action/tcp_socket_action.rb}

@@ -1,10 +1,18 @@
 module KubernetesReferences
   class TCPSocketAction < KubernetesReferences::API
+    # @dynamic host, host=, port, port=
     attr_accessor :host
     attr_accessor :port
 
     def initialize(obj)
       _set!(obj)
     end
+
+    def _schema
+      {
+        host: @host,
+        port: @port
+      }
+    end
   end
 end

data/lib/kubernetes_references/affinity.rb

@@ -0,0 +1,22 @@
+module KubernetesReferences
+  class Affinity < KubernetesReferences::API
+    # @dynamic node_affinity, node_affinity=
+    attr_accessor :node_affinity
+    # @dynamic pod_affinity, pod_affinity=
+    attr_accessor :pod_affinity
+    # @dynamic pod_anti_affinity, pod_anti_affinity=
+    attr_accessor :pod_anti_affinity
+
+    def initialize(obj)
+      _set!(obj)
+    end
+
+    def _schema
+      {
+        nodeAffinity: @node_affinity.schema,
+        podAffinity: @pod_affinity.schema,
+        podAntiAffinity: @pod_anti_affinity.schema
+      }
+    end
+  end
+end

data/lib/kubernetes_references/api.rb

@@ -1,8 +1,16 @@
+require "yaml"
+require "json"
+require 'json/add/symbol'
 require "kubernetes_references/errors"
 
 module KubernetesReferences
   class API
-    def to_json
+    def to_hash
+      schema
+    end
+
+    def schema
+      _schema.select{|k, v| v}
     end
 
     def _set!(obj)

data/lib/kubernetes_references/capabilities.rb

@@ -1,10 +1,18 @@
 module KubernetesReferences
   class Capabilities < KubernetesReferences::API
+    # @dynamic add, add=, drop, drop=
     attr_accessor :add
     attr_accessor :drop
 
     def initialize(obj)
       _set!(obj)
     end
+
+    def _schema
+      {
+        add: @add,
+        drop: @drop
+      }
+    end
   end
 end

data/lib/kubernetes_references/{config_map_env_source.rb → config_map/config_map_env_source.rb}

@@ -1,10 +1,18 @@
 module KubernetesReferences
   class ConfigMapEnvSource < KubernetesReferences::API
+    # @dynamic name, name=, optional, optional=
     attr_accessor :name
     attr_accessor :optional
 
     def initialize(obj)
       _set!(obj)
     end
+
+    def _schema
+      {
+        name: @name,
+        optional: @optional
+      }
+    end
   end
 end

data/lib/kubernetes_references/{config_map_key_selector.rb → config_map/config_map_key_selector.rb}

@@ -1,5 +1,6 @@
 module KubernetesReferences
   class ConfigMapKeySelector < KubernetesReferences::API
+    # @dynamic key, key=, name, name=, optional, optional=
     attr_accessor :key
     attr_accessor :name
     attr_accessor :optional
@@ -7,5 +8,13 @@ module KubernetesReferences
     def initialize(obj)
       _set!(obj)
     end
+
+    def _schema
+      {
+        key: @key,
+        name: @name,
+        optional: @optional
+      }
+    end
   end
 end

data/lib/kubernetes_references/config_map/config_map_projection.rb

@@ -0,0 +1,20 @@
+module KubernetesReferences
+  class ConfigMapProjection < KubernetesReferences::API
+    # @dynamic items, items=, name, name=, optional, optional=
+    attr_accessor :items
+    attr_accessor :name
+    attr_accessor :optional
+
+    def initialize(obj)
+      _set!(obj)
+    end
+
+    def _schema
+      {
+        items: @items.map{|r| r.schema},
+        name: @name,
+        optional: @optional
+      }
+    end
+  end
+end