clowder-common-ruby 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df343749ccc7b2f46d4f57bdf9f37403e3fbde5c095f1b070a62893b87bfc54
-  data.tar.gz: fd0b57272084dd80902122422b7c9504a26ea323a090260aa3ec51e69e79ef9e
+  metadata.gz: 7bf6bcdd7c43518ed4db79932add12728549082a70e1ea8097ab1ad87387a675
+  data.tar.gz: 07754c69c7b5b9b3986e08e4561f4f1f9e50741d57b1666d440f711ce2f7cf67
 SHA512:
-  metadata.gz: 2f4867fd5e6ecb7715c195d4feee0b9562f29a356c53d2e58a6de28edc39ada91abe8d30d9b69f47e620ef38e71db0f449b93789b2505f2535af6878dc0f5937
-  data.tar.gz: a82749ce7c604eca97f8976674ada6071d5b82f589dac8287ea7a5035837e3bb0e007b8a7a01783bf28fd33acefeb33c080da145b86a428ad697ce44c3af52fd
+  metadata.gz: dc7ba0b865914770bb59466ad7848431554d885376b30934479145bfbb0ea6ed8cbb0b6b66fb36a3c5cf9516992b972d7eda35717c1c791faa93cb094fd97604
+  data.tar.gz: a97d287c804602bb180414aaab8b5406f68bb264c90a5f3751f9dd3ffa6a3adb0cfc2d68c61e568b6505172795ba7417925d5f56b5e3e3e7e1b620c805c58670

data/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,63 @@
+clowder-common-ruby
+=================
+
+Simple client access library for the config for the Clowder operator.
+
+Based on schema.json, the corresponding Ruby Classes are generated in types.rb.
+
+Usage
+-----
+
+The `clowder` library provides basic values like expected web port, metrics port,
+database credentials etc.
+
+Usage:
+
+```
+require 'clowder-common-ruby'
+
+@config ||= {}.tap do |options|
+    # uses ENV['ACG_CONFIG'] or you can provide the path as a method param
+    
+  if ClowderCommonRuby::Config.clowder_enabled?     
+    config = ClowderCommonRuby::Config.load 
+    options["webPorts"]         = config.webPort
+    options["databaseHostname"] = config.database.hostname
+    options["kafkaTopics"]      = config.kafka_topics
+    # ...
+  else 
+    options["webPorts"] = 3000
+    options["databaseHostname"] = ENV['DATABASE_HOST']
+  end
+end
+```
+
+The ``clowder`` library also comes with several other helpers
+
+* ``config.kafka_topics`` - returns a map of KafkaTopics using the requestedName
+  as the key and the topic object as the value.
+* ``config.kafka_servers`` - returns a list of Kafka Broker URLs.
+* ``config.object_buckets`` - returns a list of ObjectBuckets using the requestedName
+  as the key and the bucket object as the value.
+* ``config.dependency_endpoints`` - returns a nested map using \[appName\]\[deploymentName\]
+  for the public services of requested applications.
+* ``config.private_dependency_endpoints`` - returns a nested map using \[appName\]\[deploymentName\]
+  for the private services of requested applications.
+
+
+See [test.json](test.json) for all available values
+
+### Kafka Topics
+
+Topics are structured as a hash `<requested_name> => <name>` 
+where requested_name is equal to the key topicName in your ClowdApp Custom Resource Definition(CRD)'s yaml
+
+If your kafka is deployed in `local` or `app-interface` mode (see [doc](https://clowder-operator.readthedocs.io/en/latest/providers/kafka.html))
+the `name` is equal to the `requested_name`.
+
+Testing
+-------
+
+export `ACG_CONFIG="test.json"; ruby lib/clowder-common-ruby/test.rb
+
+It inspects and prints the config file with loaded values or shows an error it the env. variable not configured correctly  

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = "--options #{File.expand_path(".rspec_ci", __dir__)}" if ENV['CI']
+end
+
+task :default => :spec

data/bin/json_schema_ruby

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+root_dir = File.expand_path("..", __dir__)
+$LOAD_PATH << File.join(root_dir, "bin")
+
+require 'optparse'
+
+cmd_name = File.basename($PROGRAM_NAME)
+out = nil
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{cmd_name} [options]"
+
+  opts.on('-o', '--output-file ARG', 'Class definition file') do |value|
+    out = value
+  end
+
+  begin
+    opts.parse!(ARGV)
+  rescue OptionParser::ParseError => e
+    $stderr.puts cmd_name + ": " + e.message
+    $stderr.puts
+    $stderr.puts opts.to_s
+    exit 1
+  end
+end
+
+require 'ruby_class_converter'
+
+converter = RubyClassConverter.new
+converter.load_config(ARGV[0])
+converter.create_types(out)

data/bin/ruby_class_converter.rb

@@ -0,0 +1,103 @@
+require "ostruct"
+require "json"
+require "stringio"
+
+class RubyClassConverter
+  attr_reader :config
+
+  def initialize
+    @config = OpenStruct.new
+  end
+
+  def load_config(filename)
+    return if filename.nil? || !File.exist?(filename)
+
+    schema = File.read(filename)
+    @config = JSON.parse(schema, object_class: OpenStruct)
+    @definitions = @config.definitions
+  end
+
+  def create_types(filename)
+    File.open(filename, 'w') do |f|
+      f << "# This file is automatically generated by bin/json_schema_ruby\n"
+      f << "require 'ostruct'\n\n"
+      f << "module ClowderCommonRuby"
+      @definitions.each_pair do |k, v|
+        f << create_classes(k, v)
+      end
+      f << "end\n"
+    end
+  end
+
+  def create_classes(key, value)
+    stream = StringIO.new
+
+    stream << "\n  class #{key} < OpenStruct\n"
+    stream << create_attributes(value)
+    stream << create_hash_initialize_function(value)
+    stream << "  end\n"
+
+    stream.string
+  end
+
+  def create_attributes(value)
+    properties = value.properties
+    value.required.each do |r|
+      raise "#{r} is required" if properties.send(r).nil?
+    end
+
+    attributes = StringIO.new
+    properties.each_pair do |k, v|
+      attributes << "    attr_accessor :#{k}\n" if v.send(:type) == "array" || v.send('$ref')
+    end
+    attributes << "\n"
+
+    attributes.string
+  end
+
+  def create_attribute_keys(value)
+    properties = value.properties
+    attribute_keys = StringIO.new
+    attribute_keys << "\n    def valid_keys\n"
+    attribute_keys << "      [].tap do |keys|\n"
+    properties.each_pair do |k, v|
+      attribute_keys << "        keys << :#{k}\n"
+    end
+    attribute_keys << "      end\n"
+    attribute_keys << "    end\n"
+
+    attribute_keys.string
+  end
+
+  def create_hash_initialize_function(value)
+    init_function = StringIO.new
+    init_function << "    def initialize(attributes)\n"
+    init_function << "      super\n"
+    init_function << "      raise 'The input argument (attributes) must be a hash' if (!attributes || !attributes.is_a?(Hash))\n"
+    init_function << "\n"
+    init_function << "      attributes = attributes.each_with_object({}) do |(k, v), h|\n"
+    init_function << "        raise \"The input [\#{k}] is invalid\" unless valid_keys.include?(k.to_sym)\n"
+    init_function << "        h[k.to_sym] = v\n"
+    init_function << "      end\n"
+    init_function << "\n"
+    value.properties.each_pair do |k, v|
+      if v.send(:type) == "array"
+        klass = v.items.send("$ref").rpartition('/').last
+        init_function << "      @#{k} = []\n"
+        init_function << "      attributes.fetch(:#{k.to_sym}, []).each do |attr|\n"
+        init_function << "        @#{k} << #{klass}.new(attr)\n"
+        init_function << "      end\n"
+      elsif v.send('$ref')
+        klass = v.send('$ref').rpartition('/').last
+        init_function << "      @#{k} = #{klass}.new(attributes.fetch(:#{k.to_sym}, {}))\n"
+      end
+    end
+    init_function << "    end\n"
+    init_function << create_attribute_keys(value)
+    init_function.string
+  end
+
+  def snakecase(str)
+    str.to_s.gsub(/(?<!^)[A-Z]/) { "_#{$&}" }.downcase
+  end
+end

data/bin/schema.json

@@ -0,0 +1,401 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "$ref": "#/definitions/AppConfig",
+    "$id": "https://cloud.redhat.com/schemas/clowder-appconfig",
+    "title": "AppConfig",
+    "definitions": {
+        "AppConfig": {
+            "type": "object",
+            "description": "ClowdApp deployment configuration for Clowder enabled apps.",
+            "properties": {
+                "privatePort": {
+                    "description": "Defines the private port that the app should be configured to listen on for API traffic.",
+                    "type": "integer"
+                },
+                "publicPort": {
+                    "description": "Defines the public port that the app should be configured to listen on for API traffic.",
+                    "type": "integer"
+                },
+                "webPort": {
+                    "description": "Deprecated: Use 'publicPort' instead.",
+                    "type": "integer"
+                },
+                "metricsPort": {
+                    "description": "Defines the metrics port that the app should be configured to listen on for metric traffic.",
+                    "type": "integer"
+                },
+                "metricsPath": {
+                    "description": "Defines the path to the metrics server that the app should be configured to listen on for metric traffic.",
+                    "type": "string"
+                },
+                "logging": {
+                    "$ref": "#/definitions/LoggingConfig"
+                },
+                "kafka": {
+                    "$ref": "#/definitions/KafkaConfig"
+                },
+                "database": {
+                    "$ref": "#/definitions/DatabaseConfig"
+                },
+                "objectStore": {
+                    "$ref": "#/definitions/ObjectStoreConfig"
+                },
+                "inMemoryDb": {
+                    "$ref": "#/definitions/InMemoryDBConfig"
+                },
+                "featureFlags": {
+                    "$ref": "#/definitions/FeatureFlagsConfig"
+                },
+                "endpoints": {
+                    "id": "endpoints",
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/DependencyEndpoint"
+                    }
+                },
+                "privateEndpoints": {
+                    "id": "privateEndpoints",
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/PrivateDependencyEndpoint"
+                    }
+                }
+
+            },
+            "required": [
+                "metricsPort",
+                "metricsPath",
+                "logging"
+            ]
+        },
+        "LoggingConfig": {
+            "title": "LoggingConfig",
+            "type": "object",
+            "description": "Logging Configuration",
+            "properties": {
+                "type": {
+                    "description": "Defines the type of logging configuration",
+                    "type": "string"
+                },
+                "cloudwatch": {
+                    "$ref": "#/definitions/CloudWatchConfig"
+                }
+            },
+            "required": [
+                "type"
+            ]
+        },
+        "CloudWatchConfig": {
+            "title": "CloudWatchConfig",
+            "type": "object",
+            "description": "Cloud Watch configuration",
+            "properties": {
+                "accessKeyId": {
+                    "description": "Defines the access key that the app should use for configuring CloudWatch.",
+                    "type": "string"
+                },
+                "secretAccessKey": {
+                    "description": "Defines the secret key that the app should use for configuring CloudWatch.",
+                    "type": "string"
+                },
+                "region": {
+                    "description": "Defines the region that the app should use for configuring CloudWatch.",
+                    "type": "string"
+                },
+                "logGroup": {
+                    "description": "Defines the logGroup that the app should use for configuring CloudWatch.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "accessKeyId",
+                "secretAccessKey",
+                "region",
+                "logGroup"
+            ]
+        },
+        "KafkaConfig": {
+            "id": "kafkaConfig",
+            "type": "object",
+            "description": "Kafka Configuration",
+            "properties": {
+                "brokers": {
+                    "description": "Defines the brokers the app should connect to for Kafka services.",
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/BrokerConfig"
+                    }
+                },
+                "topics": {
+                    "type": "array",
+                    "description": "Defines a list of the topic configurations available to the application.",
+                    "items": {
+                        "$ref": "#/definitions/TopicConfig"
+                    }
+                }
+            },
+            "required": [
+                "brokers",
+                "topics"
+            ]
+        },
+        "BrokerConfig": {
+            "id": "brokerConfig",
+            "type": "object",
+            "description": "Broker Configuration",
+            "properties": {
+                "hostname": {
+                    "type": "string"
+                },
+                "port": {
+                    "type": "integer"
+                }
+            },
+            "required": [
+                "hostname"
+            ]
+        },
+        "TopicConfig": {
+            "id": "topicConfig",
+            "type": "object",
+            "description": "Topic Configuration",
+            "properties": {
+                "requestedName": {
+                    "description": "The name that the app requested in the ClowdApp definition.",
+                    "type": "string"
+                },
+                "name": {
+                    "description": "The name of the actual topic on the Kafka server.",
+                    "type": "string"
+                },
+                "consumerGroup": {
+                    "description": "Defines the consumer group that should be used for the topic.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "name",
+                "requestedName"
+            ]
+        },
+        "DatabaseConfig": {
+            "id": "database",
+            "title": "DatabaseConfig",
+            "type": "object",
+            "description": "Database Configuration",
+            "properties": {
+                "name": {
+                    "description": "Defines the database name.",
+                    "type": "string"
+                },
+                "username": {
+                    "description": "Defines a username with standard access to the database.",
+                    "type": "string"
+                },
+                "password": {
+                    "description": "Defines the password for the standard user.",
+                    "type": "string"
+                },
+                "hostname": {
+                    "description": "Defines the hostname of the database configured for the ClowdApp.",
+                    "type": "string"
+                },
+                "port": {
+                    "description": "Defines the port of the database configured for the ClowdApp.",
+                    "type": "integer"
+                },
+                "adminUsername": {
+                    "description": "Defines the pgAdmin username.",
+                    "type": "string"
+                },
+                "adminPassword": {
+                    "description": "Defines the pgAdmin password.",
+                    "type": "string"
+                },
+                "rdsCa": {
+                    "description": "Defines the CA used to access the database.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "name",
+                "username",
+                "password",
+                "hostname",
+                "port",
+                "adminUsername",
+                "adminPassword"
+            ]
+        },
+        "ObjectStoreBucket": {
+            "id": "objectStoreBucket",
+            "type": "object",
+            "description": "Object Storage Bucket",
+            "properties": {
+                "accessKey": {
+                    "description": "Defines the access key for specificed bucket.",
+                    "type": "string"
+                },
+                "secretKey": {
+                    "description": "Defines the secret key for the specified bucket.",
+                    "type": "string"
+                },
+                "requestedName": {
+                    "description": "The name that was requested for the bucket in the ClowdApp.",
+                    "type": "string"
+                },
+                "name": {
+                    "description": "The actual name of the bucket being accessed.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "name",
+                "requestedName"
+            ]
+        },
+        "ObjectStoreConfig": {
+            "id": "objectStoreConfig",
+            "type": "object",
+            "description": "Object Storage Configuration",
+            "properties": {
+                "buckets": {
+                    "type": "array",
+                    "items": {
+                        "$ref": "#/definitions/ObjectStoreBucket"
+                    }
+                },
+                "accessKey": {
+                    "description": "Defines the access key for the Object Storage server configuration.",
+                    "type": "string"
+                },
+                "secretKey": {
+                    "description": "Defines the secret key for the Object Storage server configuration.",
+                    "type": "string"
+                },
+                "hostname": {
+                    "description": "Defines the hostname for the Object Storage server configuration.",
+                    "type": "string"
+                },
+                "port": {
+                    "description": "Defines the port for the Object Storage server configuration.",
+                    "type": "integer"
+                },
+                "tls": {
+                    "description": "Details if the Object Server uses TLS.",
+                    "type": "boolean"
+                }
+            },
+            "required": [
+                "hostname",
+                "port",
+                "tls"
+            ]
+        },
+        "FeatureFlagsConfig": {
+            "id": "featureFlagsConfig",
+            "type": "object",
+            "description": "Feature Flags Configuration",
+            "properties": {
+                "hostname": {
+                    "description": "Defines the hostname for the FeatureFlags server",
+                    "type": "string"
+                },
+                "port": {
+                    "description": "Defines the port for the FeatureFlags server",
+                    "type": "integer"
+                }
+            },
+            "required":[
+                "hostname",
+                "port"
+            ]
+        },
+        "InMemoryDBConfig": {
+            "id": "inMemoryDbConfig",
+            "type": "object",
+            "description": "In Memory DB Configuration",
+            "properties": {
+                "hostname": {
+                    "description": "Defines the hostname for the In Memory DB server configuration.",
+                    "type": "string"
+                },
+                "port": {
+                    "description": "Defines the port for the In Memory DB server configuration.",
+                    "type": "integer"
+                },
+                "username": {
+                    "description": "Defines the username for the In Memory DB server configuration.",
+                    "type": "string"
+                },
+                "password": {
+                    "description": "Defines the password for the In Memory DB server configuration.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "hostname",
+                "port"
+
+            ]
+        },
+        "DependencyEndpoint": {
+            "id": "dependency",
+            "type": "object",
+            "description": "Dependent service connection info",
+            "properties": {
+                "name": {
+                    "description": "The PodSpec name of the dependent service inside the ClowdApp.",
+                    "type": "string"
+                },
+                "hostname": {
+                    "description": "The hostname of the dependent service.",
+                    "type": "string"
+                },
+                "port": {
+                    "description": "The port of the dependent service.",
+                    "type": "integer"
+                },
+                "app": {
+                    "description": "The app name of the ClowdApp hosting the service.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "name",
+                "hostname",
+                "port",
+                "app"
+            ]
+        },
+        "PrivateDependencyEndpoint": {
+            "id": "privateDependency",
+            "type": "object",
+            "description": "Dependent service connection info",
+            "properties": {
+                "name": {
+                    "description": "The PodSpec name of the dependent service inside the ClowdApp.",
+                    "type": "string"
+                },
+                "hostname": {
+                    "description": "The hostname of the dependent service.",
+                    "type": "string"
+                },
+                "port": {
+                    "description": "The port of the dependent service.",
+                    "type": "integer"
+                },
+                "app": {
+                    "description": "The app name of the ClowdApp hosting the service.",
+                    "type": "string"
+                }
+            },
+            "required": [
+                "name",
+                "hostname",
+                "port",
+                "app"
+            ]
+        }
+    }
+}