helm

LUCIT-Systems-and-Development · Oct 21, 2024 · 5c4dabb · 5c4dabb
1 parent f2aec85
commit 5c4dabb
Show file tree

Hide file tree

Showing 17 changed files with 89 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -27,6 +27,7 @@ To run modules of the *UNICORN Binance DepthCache Cluster* you need a [valid lic
 ### Helm Chart
 
 - Get a Kubernetes Cluster of your choice and connect `kubectl`. 
+- Install Helm: https://helm.sh/docs/intro/install/
 - Install dependencies:
     ``` 
     kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml

diff --git a/dev/helm/release.sh b/dev/helm/release.sh
@@ -1,5 +1,3 @@
-cd ./dev/helm/
-helm package ./lucit-ubdcc/
+cd ./docs/helm
+helm package ../../dev/helm/lucit-ubdcc/
 helm repo index . --url https://unicorn-binance-depth-cache-cluster.docs.lucit.tech/helm
-cp index.yaml ../../docs/helm/
-cp *.tgz ../../docs/helm/
diff --git a/dev/sphinx/source/readme.md b/dev/sphinx/source/readme.md
@@ -11,7 +11,7 @@
 [![Gitter](https://img.shields.io/badge/community-gitter-41ab8c)](https://gitter.im/unicorn-trading-suite/unicorn-binance-depthcache-cluster?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Get Free Professional Support](https://img.shields.io/badge/chat-lucit%20support-004166)](https://www.lucit.tech/get-support.html)
 
-# UNICORN Binance DepthCache Cluster
+# UNICORN DepthCache Cluster for Binance
 
 A Kubernetes application from LUCIT to manage multiple and redundant UNICORN Binance Local Depth Cache Instances on a 
 Kubernetes Cluster for high-frequency access to Binance's DepthCache data (order books). 
@@ -22,6 +22,20 @@ Kubernetes Cluster for high-frequency access to Binance's DepthCache data (order
 
 To run modules of the *UNICORN Binance DepthCache Cluster* you need a [valid license](https://shop.lucit.services/software/unicorn-depthcache-cluster-for-binance)!
 
+## Installation
+
+### Helm Chart
+
+- Get a Kubernetes Cluster of your choice and connect `kubectl`. 
+- Install dependencies:
+    ``` 
+    kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml
+    ```
+- Install the UNICORN DepthCache Cluster for Binance  
+    ``` 
+    helm install lucit-ubdcc https://unicorn-binance-depth-cache-cluster.docs.lucit.tech/helm
+    ```
+
 ## How to report Bugs or suggest Improvements?
 [List of planned features](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depthcache-cluster/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) - click ![thumbs-up](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-binance-suite/master/images/misc/thumbup.png) if you need one of them or suggest a new feature!
 

diff --git a/docs/_sources/readme.md.txt b/docs/_sources/readme.md.txt
@@ -11,7 +11,7 @@
 [![Gitter](https://img.shields.io/badge/community-gitter-41ab8c)](https://gitter.im/unicorn-trading-suite/unicorn-binance-depthcache-cluster?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Get Free Professional Support](https://img.shields.io/badge/chat-lucit%20support-004166)](https://www.lucit.tech/get-support.html)
 
-# UNICORN Binance DepthCache Cluster
+# UNICORN DepthCache Cluster for Binance
 
 A Kubernetes application from LUCIT to manage multiple and redundant UNICORN Binance Local Depth Cache Instances on a 
 Kubernetes Cluster for high-frequency access to Binance's DepthCache data (order books). 
@@ -22,6 +22,20 @@ Kubernetes Cluster for high-frequency access to Binance's DepthCache data (order
 
 To run modules of the *UNICORN Binance DepthCache Cluster* you need a [valid license](https://shop.lucit.services/software/unicorn-depthcache-cluster-for-binance)!
 
+## Installation
+
+### Helm Chart
+
+- Get a Kubernetes Cluster of your choice and connect `kubectl`. 
+- Install dependencies:
+    ``` 
+    kubectl apply -f https://github.com/kubernetes-sigs/metrics-server/releases/latest/download/components.yaml
+    ```
+- Install the UNICORN DepthCache Cluster for Binance  
+    ``` 
+    helm install lucit-ubdcc https://unicorn-binance-depth-cache-cluster.docs.lucit.tech/helm
+    ```
+
 ## How to report Bugs or suggest Improvements?
 [List of planned features](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depthcache-cluster/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) - click ![thumbs-up](https://raw.githubusercontent.com/lucit-systems-and-development/unicorn-binance-suite/master/images/misc/thumbup.png) if you need one of them or suggest a new feature!
 

diff --git a/docs/changelog.html b/docs/changelog.html
@@ -326,7 +326,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Oct 21 2024 at 16:25 (CET).
+    Last updated on Oct 21 2024 at 16:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depth-cache-cluster/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/code_of_conduct.html b/docs/code_of_conduct.html
@@ -393,7 +393,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Oct 21 2024 at 16:25 (CET).
+    Last updated on Oct 21 2024 at 16:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depth-cache-cluster/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/contributing.html b/docs/contributing.html
@@ -332,7 +332,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Oct 21 2024 at 16:25 (CET).
+    Last updated on Oct 21 2024 at 16:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depth-cache-cluster/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -246,7 +246,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Oct 21 2024 at 16:25 (CET).
+    Last updated on Oct 21 2024 at 16:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depth-cache-cluster/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/helm/index.yaml b/docs/helm/index.yaml
@@ -3,14 +3,14 @@ entries:
   lucit-ubdcc:
   - apiVersion: v2
     appVersion: 0.1.0
-    created: "2024-10-21T16:40:37.257922251+02:00"
+    created: "2024-10-21T16:46:34.836537423+02:00"
     description: 'A Kubernetes application from LUCIT to manage multiple and redundant
       UNICORN Binance Local Depth Cache  Instances on a Kubernetes Cluster for high-frequency
       access to Binance''s DepthCache data (order books). '
-    digest: b84d2a5cc7fb782eaa5b7d9d806cbc3e28072cb7e10bcae9bdaa465c4a78c9b9
+    digest: 2b82b319615c7378b14af5281a70824606b39cd1216ea2b9d1e360113a9ddadc
     name: lucit-ubdcc
     type: application
     urls:
     - https://unicorn-binance-depth-cache-cluster.docs.lucit.tech/helm/lucit-ubdcc-0.0.1.tgz
     version: 0.0.1
-generated: "2024-10-21T16:40:37.257363994+02:00"
+generated: "2024-10-21T16:46:34.835920847+02:00"
diff --git a/docs/helm/lucit-ubdcc-0.0.1.tgz b/docs/helm/lucit-ubdcc-0.0.1.tgz
diff --git a/docs/index.html b/docs/index.html
@@ -16,7 +16,7 @@
 
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="UNICORN Binance DepthCache Cluster" href="readme.html" /><link rel="shortcut icon" type="image/png" href="_static/lucit.png" />
+    <link rel="next" title="UNICORN DepthCache Cluster for Binance" href="readme.html" /><link rel="shortcut icon" type="image/png" href="_static/lucit.png" />
     <script async defer src="https://buttons.github.io/buttons.js"></script>
 
     <script
@@ -71,7 +71,7 @@ <h3><a href="#">Table of Contents</a></h3>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="readme.html"
-                          title="next chapter">UNICORN Binance DepthCache Cluster</a></p>
+                          title="next chapter">UNICORN DepthCache Cluster for Binance</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -127,7 +127,7 @@ <h3>Navigation</h3>
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
         <li class="right" >
-          <a href="readme.html" title="UNICORN Binance DepthCache Cluster"
+          <a href="readme.html" title="UNICORN DepthCache Cluster for Binance"
              accesskey="N">next</a> |</li>
 
 
@@ -171,6 +171,10 @@ <h1>Welcome to unicorn-binance-depth-cache-cluster’s documentation!<a class="h
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="readme.html">Readme</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#get-a-unicorn-binance-depthcache-cluster-license">Get a UNICORN Binance DepthCache Cluster License</a></li>
+<li class="toctree-l2"><a class="reference internal" href="readme.html#installation">Installation</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="readme.html#helm-chart">Helm Chart</a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#how-to-report-bugs-or-suggest-improvements">How to report Bugs or suggest Improvements?</a></li>
 <li class="toctree-l2"><a class="reference internal" href="readme.html#contributing">Contributing</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="readme.html#contributors">Contributors</a></li>
@@ -259,7 +263,7 @@ <h3><a href="#">Table of Contents</a></h3>
   <div>
     <h4>Next topic</h4>
     <p class="topless"><a href="readme.html"
-                          title="next chapter">UNICORN Binance DepthCache Cluster</a></p>
+                          title="next chapter">UNICORN DepthCache Cluster for Binance</a></p>
   </div>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
@@ -315,7 +319,7 @@ <h3>Navigation</h3>
           <a href="genindex.html" title="General Index"
              >index</a></li>
         <li class="right" >
-          <a href="readme.html" title="UNICORN Binance DepthCache Cluster"
+          <a href="readme.html" title="UNICORN DepthCache Cluster for Binance"
              >next</a> |</li>
 
 
@@ -350,7 +354,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Oct 21 2024 at 16:25 (CET).
+    Last updated on Oct 21 2024 at 16:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depth-cache-cluster/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/license.html b/docs/license.html
@@ -393,7 +393,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2022-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Oct 21 2024 at 16:25 (CET).
+    Last updated on Oct 21 2024 at 16:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-binance-depth-cache-cluster/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.7.

diff --git a/docs/objects.inv b/docs/objects.inv