kubernetes_schemas 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 25a9924eb3ad5716b1fa9295e05bbfc06209ba296b92e6c2f46828a153b5e0d4
+  data.tar.gz: fb1a7df55ad49c7f53def88edebf68d4b7bf23cd16a7d255f809135facb37eed
+SHA512:
+  metadata.gz: ccac79277a0ecaa938c9dfb772eb8bfa656c80b5ce27c18efa7677af7016da2a5b7b08ce99f64e839d1633e1b260ee07c2d3263bb5b8ef923bd22ad73f902bf4
+  data.tar.gz: 4807e0aa0c53e0727432cd2cac7022f9804a4f3bf8aa5b5baae48891fd22d73bbab7b4147ac73784b66cf15102f95131c0c3f5400025444d43e86534bacd0610

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in kubernetes_schemas.gemspec
+gemspec

data/README.md

@@ -0,0 +1,35 @@
+# KubernetesSchemas
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kubernetes_schemas`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kubernetes_schemas'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kubernetes_schemas
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fxposter/kubernetes_schemas.

data/Rakefile

@@ -0,0 +1,28 @@
+require "bundler/gem_tasks"
+task :default => :spec
+
+task :schemas do
+  require "kubernetes_schemas/kubernetes_versions"
+  require "tmpdir"
+  require "json"
+  require "fileutils"
+
+  KubernetesSchemas::KUBERNETES_VERSIONS.each do |kubernetes_version, kind_docker_image|
+    openapi_path = "#{Dir.tmpdir}/kubernetes-openapi-#{kubernetes_version}"
+    jsonschema_dir = "./schemas/#{kubernetes_version}"
+
+    system("kind", "delete", "cluster", "--name", "schemas-#{kubernetes_version}")
+    FileUtils.rm_rf(jsonschema_dir)
+
+    system("kind", "create", "cluster", "--name", "schemas-#{kubernetes_version}", "--image", kind_docker_image) or raise "could not create kind cluster for version #{kubernetes_version}"
+    system("kubectl", "--context", "kind-schemas-#{kubernetes_version}", "get", "--raw", "/openapi/v2", :out => "#{Dir.tmpdir}/kubernetes-openapi-#{kubernetes_version}") or raise "could not get OpenAPI schemas from kubernetes apiserver"
+    system("openapi2jsonschema", "--kubernetes", "--stand-alone", "--output", jsonschema_dir, openapi_path) or raise "failed to run openapi2jsonschema"
+
+    Dir.each_child(jsonschema_dir) do|filename|
+      path = File.join(jsonschema_dir, filename)
+      File.unlink(path) unless JSON.parse(File.read(path))['x-kubernetes-group-version-kind']
+    end
+  ensure
+    system("kind", "delete", "cluster", "--name", "schemas-#{kubernetes_version}")
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "kubernetes_schemas"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/kubernetes_schemas.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "kubernetes_schemas/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "kubernetes_schemas"
+  spec.version       = KubernetesSchemas::VERSION
+  spec.authors       = ["Pavel Forkert"]
+  spec.email         = ["fxposter@gmail.com"]
+
+  spec.summary       = %q{Validate your kubernetes resources against specific version of kubernetes api}
+  spec.description   = %q{Validate your kubernetes resources against specific version of kubernetes api}
+  spec.homepage      = "https://github.com/fxposter/kubernetes_schemas"
+
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "json-schema"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/kubernetes_schemas/kubernetes_versions.rb

@@ -0,0 +1,3 @@
+module KubernetesSchemas
+  KUBERNETES_VERSIONS = { "1.22" => "kindest/node:v1.22.9@sha256:8135260b959dfe320206eb36b3aeda9cffcb262f4b44cda6b33f7bb73f453105" }
+end

data/lib/kubernetes_schemas/version.rb

@@ -0,0 +1,3 @@
+module KubernetesSchemas
+  VERSION = "0.1.0"
+end

data/lib/kubernetes_schemas.rb

@@ -0,0 +1,33 @@
+require "kubernetes_schemas/version"
+require "json-schema"
+
+module KubernetesSchemas
+  def self.load(kubernetes_version)
+    path = File.expand_path("../../schemas/#{kubernetes_version}", __FILE__)
+    Dir.each_child(path).with_object({}) { |filename, hash|
+      definition = JSON.parse(File.read(File.join(path, filename)))
+      if definition["x-kubernetes-group-version-kind"]
+        definition["$schema"] = "http://json-schema.org/draft-04/schema#"
+        definition["x-kubernetes-group-version-kind"].each do |meta|
+          hash["#{meta["group"]}/#{meta["version"]}/#{meta["kind"]}"] = definition
+        end
+      end
+    }
+  end
+
+  class Validator
+    def initialize(schemas)
+      @schemas = schemas
+    end
+
+    def validate(resource)
+      if schema = @schemas["#{resource["apiVersion"]}/#{resource["kind"]}"]
+        validator = JSON::Validator.new(schema, resource, :record_errors => true)
+        validator.validate
+        validator.validation_errors.map(&:message)
+      else
+        []
+      end
+    end
+  end
+end

data/schemas/1.22/apigroup.json

@@ -0,0 +1,119 @@
+{
+  "description": "APIGroup contains the name, the supported versions, and the preferred version of a group.",
+  "type": "object",
+  "required": [
+    "name",
+    "versions"
+  ],
+  "properties": {
+    "apiVersion": {
+      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "kind": {
+      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+      "type": [
+        "string",
+        "null"
+      ],
+      "enum": [
+        "APIGroup"
+      ]
+    },
+    "name": {
+      "description": "name is the name of the group.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "preferredVersion": {
+      "description": "GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensibility.",
+      "type": [
+        "object",
+        "null"
+      ],
+      "required": [
+        "groupVersion",
+        "version"
+      ],
+      "properties": {
+        "groupVersion": {
+          "description": "groupVersion specifies the API group and version in the form \"group/version\"",
+          "type": "string"
+        },
+        "version": {
+          "description": "version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion.",
+          "type": "string"
+        }
+      }
+    },
+    "serverAddressByClientCIDRs": {
+      "description": "a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.",
+      "type": [
+        "array",
+        "null"
+      ],
+      "items": {
+        "description": "ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.",
+        "type": [
+          "object",
+          "null"
+        ],
+        "required": [
+          "clientCIDR",
+          "serverAddress"
+        ],
+        "properties": {
+          "clientCIDR": {
+            "description": "The CIDR with which clients can match their IP to figure out the server address that they should use.",
+            "type": "string"
+          },
+          "serverAddress": {
+            "description": "Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.",
+            "type": "string"
+          }
+        }
+      }
+    },
+    "versions": {
+      "description": "versions are the versions supported in this group.",
+      "type": [
+        "array",
+        "null"
+      ],
+      "items": {
+        "description": "GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensibility.",
+        "type": [
+          "object",
+          "null"
+        ],
+        "required": [
+          "groupVersion",
+          "version"
+        ],
+        "properties": {
+          "groupVersion": {
+            "description": "groupVersion specifies the API group and version in the form \"group/version\"",
+            "type": "string"
+          },
+          "version": {
+            "description": "version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion.",
+            "type": "string"
+          }
+        }
+      }
+    }
+  },
+  "x-kubernetes-group-version-kind": [
+    {
+      "group": "",
+      "kind": "APIGroup",
+      "version": "v1"
+    }
+  ],
+  "$schema": "http://json-schema.org/schema#"
+}

data/schemas/1.22/apigrouplist.json

@@ -0,0 +1,156 @@
+{
+  "description": "APIGroupList is a list of APIGroup, to allow clients to discover the API at /apis.",
+  "type": "object",
+  "required": [
+    "groups"
+  ],
+  "properties": {
+    "apiVersion": {
+      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "groups": {
+      "description": "groups is a list of APIGroup.",
+      "type": [
+        "array",
+        "null"
+      ],
+      "items": {
+        "description": "APIGroup contains the name, the supported versions, and the preferred version of a group.",
+        "type": [
+          "object",
+          "null"
+        ],
+        "required": [
+          "name",
+          "versions"
+        ],
+        "properties": {
+          "apiVersion": {
+            "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "kind": {
+            "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+            "type": [
+              "string",
+              "null"
+            ],
+            "enum": [
+              "APIGroup"
+            ]
+          },
+          "name": {
+            "description": "name is the name of the group.",
+            "type": "string"
+          },
+          "preferredVersion": {
+            "description": "GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensibility.",
+            "type": [
+              "object",
+              "null"
+            ],
+            "required": [
+              "groupVersion",
+              "version"
+            ],
+            "properties": {
+              "groupVersion": {
+                "description": "groupVersion specifies the API group and version in the form \"group/version\"",
+                "type": "string"
+              },
+              "version": {
+                "description": "version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion.",
+                "type": "string"
+              }
+            }
+          },
+          "serverAddressByClientCIDRs": {
+            "description": "a map of client CIDR to server address that is serving this group. This is to help clients reach servers in the most network-efficient way possible. Clients can use the appropriate server address as per the CIDR that they match. In case of multiple matches, clients should use the longest matching CIDR. The server returns only those CIDRs that it thinks that the client can match. For example: the master will return an internal IP CIDR only, if the client reaches the server using an internal IP. Server looks at X-Forwarded-For header or X-Real-Ip header or request.RemoteAddr (in that order) to get the client IP.",
+            "type": [
+              "array",
+              "null"
+            ],
+            "items": {
+              "description": "ServerAddressByClientCIDR helps the client to determine the server address that they should use, depending on the clientCIDR that they match.",
+              "type": [
+                "object",
+                "null"
+              ],
+              "required": [
+                "clientCIDR",
+                "serverAddress"
+              ],
+              "properties": {
+                "clientCIDR": {
+                  "description": "The CIDR with which clients can match their IP to figure out the server address that they should use.",
+                  "type": "string"
+                },
+                "serverAddress": {
+                  "description": "Address of this server, suitable for a client that matches the above CIDR. This can be a hostname, hostname:port, IP or IP:port.",
+                  "type": "string"
+                }
+              }
+            }
+          },
+          "versions": {
+            "description": "versions are the versions supported in this group.",
+            "type": "array",
+            "items": {
+              "description": "GroupVersion contains the \"group/version\" and \"version\" string of a version. It is made a struct to keep extensibility.",
+              "type": [
+                "object",
+                "null"
+              ],
+              "required": [
+                "groupVersion",
+                "version"
+              ],
+              "properties": {
+                "groupVersion": {
+                  "description": "groupVersion specifies the API group and version in the form \"group/version\"",
+                  "type": "string"
+                },
+                "version": {
+                  "description": "version specifies the version in the form of \"version\". This is to save the clients the trouble of splitting the GroupVersion.",
+                  "type": "string"
+                }
+              }
+            }
+          }
+        },
+        "x-kubernetes-group-version-kind": [
+          {
+            "group": "",
+            "kind": "APIGroup",
+            "version": "v1"
+          }
+        ]
+      }
+    },
+    "kind": {
+      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+      "type": [
+        "string",
+        "null"
+      ],
+      "enum": [
+        "APIGroupList"
+      ]
+    }
+  },
+  "x-kubernetes-group-version-kind": [
+    {
+      "group": "",
+      "kind": "APIGroupList",
+      "version": "v1"
+    }
+  ],
+  "$schema": "http://json-schema.org/schema#"
+}

data/schemas/1.22/apiresourcelist.json

@@ -0,0 +1,138 @@
+{
+  "description": "APIResourceList is a list of APIResource, it is used to expose the name of the resources supported in a specific group and version, and if the resource is namespaced.",
+  "type": "object",
+  "required": [
+    "groupVersion",
+    "resources"
+  ],
+  "properties": {
+    "apiVersion": {
+      "description": "APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "groupVersion": {
+      "description": "groupVersion is the group and version this APIResourceList is for.",
+      "type": [
+        "string",
+        "null"
+      ]
+    },
+    "kind": {
+      "description": "Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
+      "type": [
+        "string",
+        "null"
+      ],
+      "enum": [
+        "APIResourceList"
+      ]
+    },
+    "resources": {
+      "description": "resources contains the name of the resources and if they are namespaced.",
+      "type": [
+        "array",
+        "null"
+      ],
+      "items": {
+        "description": "APIResource specifies the name of a resource and whether it is namespaced.",
+        "type": [
+          "object",
+          "null"
+        ],
+        "required": [
+          "name",
+          "singularName",
+          "namespaced",
+          "kind",
+          "verbs"
+        ],
+        "properties": {
+          "categories": {
+            "description": "categories is a list of the grouped resources this resource belongs to (e.g. 'all')",
+            "type": [
+              "array",
+              "null"
+            ],
+            "items": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "group": {
+            "description": "group is the preferred group of the resource.  Empty implies the group of the containing resource list. For subresources, this may have a different value, for example: Scale\".",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "kind": {
+            "description": "kind is the kind for the resource (e.g. 'Foo' is the kind for a resource 'foo')",
+            "type": "string"
+          },
+          "name": {
+            "description": "name is the plural name of the resource.",
+            "type": "string"
+          },
+          "namespaced": {
+            "description": "namespaced indicates if a resource is namespaced or not.",
+            "type": "boolean"
+          },
+          "shortNames": {
+            "description": "shortNames is a list of suggested short names of the resource.",
+            "type": [
+              "array",
+              "null"
+            ],
+            "items": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "singularName": {
+            "description": "singularName is the singular name of the resource.  This allows clients to handle plural and singular opaquely. The singularName is more correct for reporting status on a single item and both singular and plural are allowed from the kubectl CLI interface.",
+            "type": "string"
+          },
+          "storageVersionHash": {
+            "description": "The hash value of the storage version, the version this resource is converted to when written to the data store. Value must be treated as opaque by clients. Only equality comparison on the value is valid. This is an alpha feature and may change or be removed in the future. The field is populated by the apiserver only if the StorageVersionHash feature gate is enabled. This field will remain optional even if it graduates.",
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "verbs": {
+            "description": "verbs is a list of supported kube verbs (this includes get, list, watch, create, update, patch, delete, deletecollection, and proxy)",
+            "type": "array",
+            "items": {
+              "type": [
+                "string",
+                "null"
+              ]
+            }
+          },
+          "version": {
+            "description": "version is the preferred version of the resource.  Empty implies the version of the containing resource list For subresources, this may have a different value, for example: v1 (while inside a v1beta1 version of the core resource's group)\".",
+            "type": [
+              "string",
+              "null"
+            ]
+          }
+        }
+      }
+    }
+  },
+  "x-kubernetes-group-version-kind": [
+    {
+      "group": "",
+      "kind": "APIResourceList",
+      "version": "v1"
+    }
+  ],
+  "$schema": "http://json-schema.org/schema#"
+}