Agent mode

Step-by-step instructions to setup KuboVisor local agent on your cluster.

➕ Add your cluster

Go to your clusters list, click on the « Add » button and select the « Agent » installation type.

Fill the cluster details and click on « Add cluster ».

After your cluster has been added, you will receive some credentials needed for the installation of the agent on your cluster.

If you close this window by mistake or want to install the agent later on, you can always get back your cluster credentials until you complete the agent installation.

🛠️ Install the agent

The following content assumes that:

  • you have kubectl and helm binaries installed

  • your current context is set to the correct cluster

  • you have enough privileges on your cluster to create resources

Replace YOUR_CLUSTER_NAME, YOUR_CLUSTER_ACCESS_KEY and YOUR_CLUSTER_SECRET_KEY with the values for your cluster.

# Check connection to your cluster
kubectl get nodes

# Add our Helm charts repository
helm repo add kubolabs https://download.kubolabs.io/charts

# Update local repositories
helm repo update

# Install KuboVisor local agent
helm install kubovisor-agent kubolabs/kubovisor --create-namespace \
  --namespace kubovisor \
  --set agent.permissions=read-only \
  --set cluster.name=YOUR_CLUSTER_NAME \
  --set cluster.accessKey=YOUR_CLUSTER_ACCESS_KEY \
  --set cluster.secretKey=YOUR_CLUSTER_SECRET_KEY

Helm chart values

ValueDefaultDescription

agent.permissions

read-only

Define the permission level to use.

agent.schedule

*/5 * * * * (every 5 minutes)

Define the running periodicity.

agent.historyLimit

1

Define the history limit of agent jobs.

cluster.name

local

Define the cluster name. You will most likely want to use the same name that you used when adding your cluster.

cluster.accessKey

Required

Define the cluster access key.

cluster.secretKey

Required

Define the cluster secret key.

serviceAccount.create

true

Define if a ServiceAccount should be created.

serviceAccount.name

ksa-kubovisor

Set the ServiceAccount name to use. If serviceAccount.create is set to false, this ServiceAccount must already exist.

serviceAccount.annotations

{}

Define the ServiceAccount annotations.

image.registry

gcr.io/kubolabs-public

Define container image registry to use.

image.name

kubovisor/agent

Define container image name to use.

image.tag

Value of Chart.appVersion

Define container image tag to use.

image.pullPolicy

IfNotPresent

Define container image pull policy to use.

image.pullSecrets

[]

Define container image registry pull secret to use.

resources.limits.cpu

500m

Define container CPU limits.

resources.limits.memory

512Mi

Define container memory limits.

resources.requests.cpu

100m

Define container CPU requests.

resources.requests.memory

320Mi

Define container memory requests.

labels

{}

Define custom labels to apply to resources.

annotations

{}

Define custom annotations to apply to resources.

nodeSelector

{}

Define custom node selectors.

tolerations

[]

Define custom tolerations.

affinity

{}

Define custom affinities.

🚀 Get to know your cluster

When data is available, you’ll see colored indicators regarding your cluster's state, health and security. Go ahead, click on them to display the details!

Elements shown in red are issues that should be addressed as soon as possible.

While elements shown in orange are problems that should still be addressed, they don’t threaten your cluster nor your workloads.

If everything is green, congratulations! That means your cluster is in very good shape 😎 Try to keep it this way!

Last updated