Overview
Yotascale’s Kubernetes Integration requires the installation of an agent, which is essentially a Kubernetes POD, in each of your clusters that you want onboarded onto Yotascale. This document describes how to install the agent onto your cluster along with some pre-requisites that are required for it to function as required by Yotascale.
Follow the steps below for installing the agent onto each of your Kubernetes clusters.
Installing the Agent
Step 1: Download the Deployment Descriptor
Click on Manage Cloud Services from the Settings menu
Once on the Manage Cloud Services page, click on the Kubernetes Cluster Button
Click the Download button to save the Deployment Descriptor.
Step 2: Update the Environment Variables for your Cluster
The deployment descriptor lists multiple environment variables in the last few lines of the file. You would need to configure some of them according to your environment.
Environment Variable | Description | Value needs to be specified |
|---|---|---|
KUBERNETES_CLUSTER_ID | Give your cluster a unique name in order to identify clusters within Yotascale. | Yes |
PROMETHEUS_API_ENDPOINT | Point the agent to the Prometheus API by providing the URL. | Yes |
YOTASCALE_API_KEY | This Environment variable authenticates (and identifies) this agent against a Service Role that your administrators have subscribed to by default. This will be pre-populated in the deployment descriptor and does not need to be updated by the user. | No |
YOTASCALE_KUBERNETES_API_ENDPOINT | This is the URL of the Yotascale API that allows the agent to authenticate iteself with Yotascale, and send frequent heartbeats for monitoring. This URL will be pre-populated in the deployment descriptor. | No |
Step 3: Deploy Yotascale Agent on Kubernetes
Once you have updated the deployment descriptor, apply the updated file onto your cluster
kubectl apply -f yotascale-kubernetes-agent-deployment.yaml
Step 4: Verifying the Installation
Once you have applied the deployment descriptor to your cluster, you will see it appear in the List of Clusters widget in the Manage Cloud Services Page.
You can also look at the logs from the agent to ensure there are no error logs.
kubectl logs -l app=yotascale-kubernetes-agent -n yotascale