Koala Agent
About the agent
To display data in the web app, KoalaOps retrieves information from your Kubernetes clusters using a lightweight agent. This agent operates as a persistent service on a single pod, maintaining communication with our backend. The agent only retrieves information, but does not apply actions directly.
The agent is granted permissions in your cluster using Kubernetes’ RBAC model, and you may modify them if needed.
If you’ve already installed the agent on your cluster as part of your cluster connection process, there’s no need to do so again and you can skip the instructions below.
Requirements
Before installing the agent:
- Make sure you have
kubectlandhelminstalled. - Have a k8s cluster and make sure you’re connected/authenticated to it.
- Register the cluster (see how)
- Authenticate your terminal with your cluster over your cloud provider. See details below.
Before installing the agent, you’ll need to authenticate to your cluster using your cloud provider’s command line tool if you haven’t already.
Cluster Authentication Instructions
Cluster Authentication Instructions
If you have experience with k8s, this should be very familiar. You can read more in Google’s documentation for GKE.
Make sure you have gcloud installed and that you’ve also installed the gke-gcloud-auth-plugin. To install the plugin after gcloud is installed, run:
Sign in to the gcloud CLI using your credentials. This opens a web browser to complete the authentication process to Google Cloud:
Use gcloud to retrieve the Kubernetes credentials for a specific cluster:
Verify that you are authenticated by running any kubectl command, for example:
You can use the small utility kubectx to make managing and switching cluster contexts easier.
If you have experience with k8s, this should be very familiar. You can read more in Google’s documentation for GKE.
Make sure you have gcloud installed and that you’ve also installed the gke-gcloud-auth-plugin. To install the plugin after gcloud is installed, run:
Sign in to the gcloud CLI using your credentials. This opens a web browser to complete the authentication process to Google Cloud:
Use gcloud to retrieve the Kubernetes credentials for a specific cluster:
Verify that you are authenticated by running any kubectl command, for example:
You can use the small utility kubectx to make managing and switching cluster contexts easier.
To access AWS services with the AWS CLI, you need an AWS account and IAM credentials. Ensure you have the following prerequisites in place:
Authenticate the CLI with your AWS credentials or through SSO:
Next you’ll need to set your AWS profile name.
To determine your AWS profile name, run the following command:
Using the profile name, define your AWS Profile:
Installing the agent
Go the the Clusters -> List page in the KoalaOps UI.
Find the cluster you want to install, and click the ‘INSTALL AGENT’ button.
Copy the helm install command which is pre-populated with the unique API key for the cluster, and run in your terminal. If needed you can customize the namespace in which the agent will run.
Make sure the cluster is connected by looking at the cluster list in the web app. Before the agent is first installed, it will say “Waiting for first check in”; when connected it will say “online”. It might take a few minutes for the agent to appear as “online” in the UI.