From fde9720e705b3cc5f90daf3cb0d0b4130f81c7cf Mon Sep 17 00:00:00 2001 From: Craig Russell Date: Tue, 16 Apr 2024 13:51:24 +0100 Subject: [PATCH] Update k8s-toolkit.md --- docs/k8s-toolkit.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/k8s-toolkit.md b/docs/k8s-toolkit.md index 8b13789..43ef677 100644 --- a/docs/k8s-toolkit.md +++ b/docs/k8s-toolkit.md @@ -1 +1,40 @@ +**Bioengine Deployment Guide Using Kubernetes** +--- + +### Introduction + +This document is designed for advanced users and developers interested in deploying the Bioengine on Kubernetes. We utilise Helm charts to streamline the deployment process on the cloud. + +### Resources + +**1. Helm Chart for Deployment** + +For deploying the Bioengine using Kubernetes, we provide a Helm chart. Detailed instructions and necessary files can be found in our GitHub repository: + +- **Bioimage-io Helm Charts:** [Hypha Helm Charts Repository](https://github.com/bioimage-io/hypha-helm-charts) + +**2. Deployment Examples** + +To assist with your deployment, we offer examples based on our own Bioengine deployments. These examples can serve as a reference to guide you through setting up the Bioengine in a Kubernetes environment. + +- **Bioimage-io Kubernetes Examples:** [Hypha Kubernetes Repository](https://github.com/bioimage-io/hypha-k8s) + +### Deployment Steps + +1. **Access the Helm Chart Repository:** + Visit the [Hypha Helm Charts Repository](https://github.com/bioimage-io/hypha-helm-charts) to download the necessary Helm charts for the deployment. + +2. **Review the Example Deployments:** + Explore the [Hypha Kubernetes Repository](https://github.com/bioimage-io/hypha-k8s) to understand how the Bioengine is deployed in real-world scenarios. + +3. **Follow the Installation Instructions:** + Detailed instructions are available in the Helm chart repository, which will guide you through the deployment process using Kubernetes and Helm. + +### Support + +Should you encounter any issues or require further assistance with the deployment process, please refer to the documentation in the provided repositories or submit an issue on the relevant GitHub repository page. + +--- + +This guide aims to provide all necessary information for deploying the Bioengine using Kubernetes and Helm, enhancing your experience with scalable and efficient cloud deployments.