Instana is an APM solution built for microservices that enables IT Ops to build applications faster and deliver higher quality services by automating monitoring, tracing and root cause analysis. The solution is optimized for Kubernetes and OpenShift.
This repository contains the Kubernetes Operator to install and manage the Instana agent.
There are two ways to install the operator:
This documentation section describes configuration options you can set via the Instana Agent CRD and environment variables.
Please see the guidelines in CONTRIBUTING.md.
Prerequisites:
- Make (Makefile used as a utility CMD )
- Go (for the supported version, see the go.mod-file)
- Kubernetes
- Minikube
- Operator SDK
- Something like Docker or Podman
- Instana Agent key
Developing (and running) the Operator is easiest in two ways:
-
Start minikube (minikube docs)
[!NOTE] RHEL8 & KVM At least
RHEL 8
can have issues reaching the internet which can prevent auto-updates and connections. Try kvm2-driver with byminikube start --driver=kvm2
. Make sure to have sufficient CPUs and Memory defined before starting minikube.minikube config set driver kvm2 minikube config set cpus 4 minikube config set memory 16384
[!NOTE] Macs Macs using Podman have been successfully run with using
minikube start --driver=podman --container-runtime=cri-o
. More info here. Make sure to be able to reach outside podman. With default install, one can reach outside by:podman system connection default podman-machine-default-root
minikube start
-
Install the CRD by running
make install
at the root of the repository# Install command in root of the repository (installs custom resource to k8s) make install # List CRD to verify it appears in the list kubectl get crd
-
Create
instana-agent
namespace on the cluster:kubectl apply -f config/samples/instana_agent_namespace.yaml # List namespaces to verify it appears in the list kubectl get ns -n instana-agent
-
Run the
instana-agent-operator
Go application, either from your IDE, or from command-line:make run
.# Starts the operator using make with additional fmt vet gen functionality make run
-
Duplicate agent sample file in
config/samples/instana_v1_instanaagent.yaml
[!NOTE] for this demonstration the duplicate will be named as
instana_v1_instanaagent_demo.yaml
# Copy/Duplicate the sample file with a "demo" suffix cp config/samples/instana_v1_instanaagent.yaml config/samples/instana_v1_instanaagent_demo.yaml
-
Change the placeholder values in the duplicated file to your preferred values e.g. the Agent
key
,endpointHost
andendpointPort
[!TIP] In the configuration, there is a field
spec.zone.name
. Changing this to something more identifiable and personalised will help you find your infrastructure easier in the frontend-client. -
Deploy the custom resource earlier created using
kubectl apply -f config/samples/instana_v1_instanaagent_demo.yaml
Verify that the operator reacted to the application of the yaml file by looking into the logs of the running operator
-
Depending on your local configurations, the environment should appear IBM Instana infrastructure-page. Standard minikube configuration should appear there as
minikube
.
To stop, take the following actions:
# Remove the instance from your kubernetes instance
kubectl delete -f config/samples/instana_v1_instanaagent_demo.yaml
# Final cleanup e.g `kubectl delete -k config/crd`
make uninstall
# Will stop the service
minikube stop
# Will reset the whole set-up
minikube delete
The Instana Agent Operator can be developed and tested easily against a local Minikube cluster or any other configured Kubernetes cluster. Therefore, follow the below steps:
- Create a copy of the file
config/samples/instana_v1_instanaagent.yaml
, for the below steps we're assumingconfig/samples/instana_v1_instanaagent_demo.yaml
- In this file, put correct values for e.g. the Agent
key
,endpointHost
andendpointPort
. - Build the Operator image:
make docker-build
- For deploying on Minikube, there's a convenient target
make deploy-minikube
. For any other environment you would need to first push the Docker image to a valid repository usingmake docker-push
, then do the deployment usingmake deploy
to deploy the Operator to the cluster configured forkubectl
. - Deploy the custom resource earlier created using
kubectl apply -f config/samples/instana_v1_instanaagent_demo.yaml
Now you should have a successful running Operator. To remove the Operator again, run:
kubectl delete -f config/samples/instana_v1_instanaagent_demo.yaml
make undeploy
.