transcrobes
transcrobes is a Kubernetes Helm Chart to install Transcrobes.
TL;DR;
$ git clone https://github.com/transcrobes/charts
$ cd charts
$ helm upgrade --install my-release ./transcrobes --set transcrobes.bingSubscriptionKey=my_bing_key --set transcrobes.nodeHosts={node1.example.com} --set transcrobes.haHost=transcrobes.example.com
Introduction
This chart bootstraps a Transcrobes deployment on a Kubernetes cluster using the Helm package manager.
Prerequisites
Installation
- A publicly accessible Kubernetes 1.22+ (may work on other versions but is currently untested)
- helm (3.7.0+)
- ingress-nginx installed and able to serve any namespace
- cert-manager installed with cluster issuers for
letsencrypt-prod
andletsencrypt-staging
(can be overridden) - kilo installed and encrypting traffic between all nodes (optional, but highly recommended for insecure clouds)
Working installation
- A publicly available FQDN pointing to your Kubernetes cluster. In the following examples this is
transcrobes.example.com
. Currently onlyHostNetwork
andNodePort
are implemented but loadbalancer IPs will be supported soon. - A valid Microsoft Azure Cognitive services API token. Microsoft currently provides 2M characters (translations, dictionary lookups, etc.) free per month. This requires a valid credit card to set up but the default configuration will stop translating at 2M characters rather than start charging you. More details here.
Installing the Chart
The command deploys transcrobes on the Kubernetes cluster in the default configuration. The configuration section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Uninstalling the Chart
To uninstall/delete the my-release
deployment:
$ helm delete my-release
The command removes all the Kubernetes components associated with the chart and deletes the release.
Configuration
The following table lists the configurable parameters of the transcrobes chart and their default values.
Parameter | Description | Default |
---|---|---|
transcrobes.enabled |
If true, create transcrobes | true |
FIXME: see values.yaml for detailed descriptions |