diff --git a/README.md b/README.md index 9007048..aece2b2 100644 --- 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 index 07b9407..4d36dea 100755 --- 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/ \ No newline at end of file diff --git a/dev/sphinx/source/readme.md b/dev/sphinx/source/readme.md index 78ebcc4..9007048 100644 --- 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 index 78ebcc4..9007048 100644 --- 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 index a71e475..497a714 100644 --- a/docs/changelog.html +++ b/docs/changelog.html @@ -326,7 +326,7 @@

Navigation

Index of all LUCIT Software Documentation
© Copyright 2022-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
- Last updated on Oct 21 2024 at 16:25 (CET). + Last updated on Oct 21 2024 at 16:42 (CET). Found a bug?
Created using Sphinx 7.4.7. diff --git a/docs/code_of_conduct.html b/docs/code_of_conduct.html index 0b85ede..5692025 100644 --- a/docs/code_of_conduct.html +++ b/docs/code_of_conduct.html @@ -393,7 +393,7 @@

Navigation

Index of all LUCIT Software Documentation
© Copyright 2022-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
- Last updated on Oct 21 2024 at 16:25 (CET). + Last updated on Oct 21 2024 at 16:42 (CET). Found a bug?
Created using Sphinx 7.4.7. diff --git a/docs/contributing.html b/docs/contributing.html index 24552f9..9550712 100644 --- a/docs/contributing.html +++ b/docs/contributing.html @@ -332,7 +332,7 @@

Navigation

Index of all LUCIT Software Documentation
© Copyright 2022-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
- Last updated on Oct 21 2024 at 16:25 (CET). + Last updated on Oct 21 2024 at 16:42 (CET). Found a bug?
Created using Sphinx 7.4.7. diff --git a/docs/genindex.html b/docs/genindex.html index 8d33fae..a4ab2b2 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -246,7 +246,7 @@

Navigation

Index of all LUCIT Software Documentation
© Copyright 2022-2023, LUCIT Systems and Development. All Rights Reserved.. See License for more information.
- Last updated on Oct 21 2024 at 16:25 (CET). + Last updated on Oct 21 2024 at 16:42 (CET). Found a bug?
Created using Sphinx 7.4.7. diff --git a/docs/helm/index.yaml b/docs/helm/index.yaml index ee7afc4..35c93d1 100644 --- 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 index 2680213..ec58b0d 100644 Binary files a/docs/helm/lucit-ubdcc-0.0.1.tgz and b/docs/helm/lucit-ubdcc-0.0.1.tgz differ diff --git a/docs/index.html b/docs/index.html index 431f092..a566846 100644 --- a/docs/index.html +++ b/docs/index.html @@ -16,7 +16,7 @@ - +