Description
Kubernetes Operator for the Instana APM Agent
Instana is a fully automated Application Performance Monitoring (APM) tool for microservices.
This is the Kubernetes Operator for installing the Instana APM Agent on Kubernetes or OpenShift.
Configuration and Installation
First, install this operator from OperatorHub.io, OpenShift Container Platform, or OKD.
Second, create the target namespace where the Instana agent should be installed. The agent does not need to run in the same namespace as the operator. Most users create a new namespace instana-agent for running the agents.
Third, create a custom resource with the agent configuration in the target namespace. The operator will pick up the custom resource and install the Instana agent accordingly.
The following is a minimal template of the custom resource:apiVersion: instana.io/v1alpha1
kind: InstanaAgent
metadata:
name: instana-agent
namespace: instana-agent
spec:
agent.zone.name: '{{ (optional) name of the zone of the host }}'
agent.key: '{{ put your Instana agent key here }}'
agent.endpoint.host: '{{ the monitoring ingress endpoint }}'
agent.endpoint.port: '{{ the monitoring ingress endpoint port, wrapped in quotes }}'
config.files:
configuration.yaml: |
# You can leave this empty, or use this to configure your instana agent.
# See https://docs.instana.io/quick_start/agent_setup/container/kubernetes/
Save the template in a file instana-agent.yaml and edit the following values:
If your target namespace is not instana-agent, replace the namespace: accordingly.
agent.key must be set with your Instana agent key.
agent.endpoint must be set with the monitoring ingress endpoint, generally either saas-us-west-2.instana.io or saas-eu-west-1.instana.io.
agent.endpoint.port must be set with the monitoring ingress port, generally "443" (wrapped in quotes).
agent.zone.name should be set with the name of the Kubernetes cluster that is be displayed in Instana.
For advanced configuration, you can edit the contents of the configuration.yaml file. View documentation here: https://docs.instana.io/quickstart/agentsetup/container/kubernetes/.
Apply the custom resource with kubectl apply -f instana-agent.yaml. After some time, you should see instana-agent Pods being created on each node of your cluster, and your cluster should show on the infrastructure map on your Instana Web interface.
Uninstalling
In order to uninstall the Instana agent, simply remove the custom resource with kubectl delete -f instana-agent.yaml.
Source Code
The Instana agent operator is an open source project hosted on https://github.com/instana/instana-agent-operator.
