This is a Helm chart - you need to have Helm installed. For details on how to do that, please visit their website Helm. Additionally you will need a registration key which you can get through our early access website [Merly] (https://www.merly.ai/early-access)
You will also need a space to run the helm chart. If you have a working Kubernetes cluster, you can skip these steps and proceed to the step "Adding the Merly Mentor Helm Repository".
For our local testing we used kind - kind is a tool for running local Kubernetes clusters using Docker container "nodes".
Kind does not require kubectl, but you will not be able to perform some of tasks with your cluster.
To install kubectl see the upstream kubectl installation docs.
You can install kind from a package manager, from source or release binaries
On macOS or Linux via Homebrew:
brew install kind
On macOS via MacPorts:
sudo port selfupdate && sudo port install kind
On Windows via Chocolatey
choco install kind
On Windoes via Winget
winget install Kubernetes.kind
Pre-built binaries are available on our releases page
To install, download the binary for your platform from “Assets”, then rename it to kind (or perhaps kind.exe on Windows) and place this into your $PATH at your preferred binary installation directory.
On Linux:
# For AMD64 / x86_64
[ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.30.0/kind-linux-amd64
# For ARM64
[ $(uname -m) = aarch64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.30.0/kind-linux-arm64
chmod +x ./kind
sudo mv ./kind /usr/local/bin/kind
On macOS:
# For Intel Macs
[ $(uname -m) = x86_64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.30.0/kind-darwin-amd64
# For M1 / ARM Macs
[ $(uname -m) = arm64 ] && curl -Lo ./kind https://kind.sigs.k8s.io/dl/v0.30.0/kind-darwin-arm64
chmod +x ./kind
mv ./kind /some-dir-in-your-PATH/kind
On Windows in PowerShell:
curl.exe -Lo kind-windows-amd64.exe https://kind.sigs.k8s.io/dl/v0.30.0/kind-windows-amd64
Move-Item .\kind-windows-amd64.exe c:\some-dir-in-your-PATH\kind.exe
Instructions can be found here
Creating a Kubernetes cluster is as simple as kind create cluster.
This will bootstrap a Kubernetes cluster using a pre-built node image.
To specify another image use the --image flag - kind create cluster --image=....
Using a different image allows you to change the Kubernetes version of the created cluster.
If you desire to build the node image yourself see the building images in the documentation.
By default, the cluster will be given the name kind. Use the --name flag to assign the cluster a different context name.
More usage can be discovered with kind create cluster --help
After creating a cluster, you can use kubectl to interact with it by using the configuration file generated by kind.
To see all the clusters you have created, you can use the get clusters command.
For example, let's say you create two clusters:
kind create cluster # Default cluster context name is `kind`.
...
kind create cluster --name kind-2
When you list your kind clusters, you will see something like the following:
kind get clusters
kind
kind-2
In order to interact with a specific cluster, you only need to specify the cluster name as a context in kubectl:
kubectl cluster-info --context kind-kind
kubectl cluster-info --context kind-kind-2
If you created a cluster with kind create cluster then deleting it is equally simple:
kind delete cluster
If the flag --name is not specified, kind will use the default cluster context name kind and delete that cluster.
Now that you have gained a handle on how to create and delete clusters we can proceed adding a helm chart to the cluster.
You can add the merly-mentor Helm repository
helm repo add merly-mentor https://charts.merly-mentor.ai
Then look for available charts
helm search repo merly-mentor
And finally install the chart with a release name mentor (but really could be anything you prefer):
helm install my-release merly-mentor/merly-mentor --set global.registrationKey="<replace-with-your-product-key>"
The alternative is to download or git clone the repositry and manually install the chart
helm install mentor ./ --set global.registrationKey="<replace-with-your-product-key>"
The only caveat is you need to be in the right folder charts/merly-mentor
To uninstall/delete the my-release deployment:
helm uninstall merly-mentor
The command removes all the Kubernetes components associated with the chart and deletes the release.
The code is offered as-is without any guarantees.