Installing AutoTrace webhook

You can install the Instana AutoTrace webhook in an online or offline (air-gapped) environment. For more information, see the following sections:

Installing in an online environment
- Installing on IBM Cloud Paks
Installing in an air-gapped environment
Verifying webhook installation

Before you start, make sure that you check the supported runtimes and prerequisites for the AutoTrace webhook. For more information, see Before you install.

Installing in an online environment

To install AutoTrace webhook in an online environment, run the following command with administrator privileges for your cluster:

helm install --create-namespace --namespace instana-autotrace-webhook instana-autotrace-webhook \
  --repo https://agents.instana.io/helm instana-autotrace-webhook \
  --set webhook.imagePullCredentials.password=<download_key>

Replace <download_key> in the script with a valid Instana agent key or download key.

If you are installing AutoTrace webhook on Red Hat OpenShift, you must add the following Helm argument:

--set openshift.enabled=true

For more webhook configuration options, see Configuring AutoTrace webhook.

The script installs the AutoTrace webhook in your cluster.

After you install the AutoTrace webhook, verify that the installation is successful and the webhook works. For more information, see Verifying webhook installation.

Installing on IBM Cloud Paks

To install AutoTrace webhook on IBM Cloud Pak, you must exclude the Zen deployment from the webhook instrumentation by disabling Ruby instrumentation.

To disable Ruby instrumentation, add the following Helm argument:

--set autotrace.ruby.enabled=false

To instrument applications that use Ruby, you can consider other options, such as ignoring namespaces, opt in or out, or ignoring resources.

For detailed instructions on how to install the Instana Autotrace webhook on IBM Cloud Paks and the exclusion options, see How to configure Instana AutoTrace webhook in a Cloud Pak Environment.

Installing in an air-gapped environment

To install AutoTrace webhook in air-gapped environments, you must provide the instana-autotrace-webhook Helm chart, the instana-autotrace-webhook container image, and the instrumentation container image in your environment.

To download the latest release of the Helm chart to your current working directory, run the following command:
```
helm pull instana-autotrace-webhook --repo https://agents.instana.io/helm instana-autotrace-webhook
```
To change the destination directory of this command, use the option -d <DESTINATION_PATH>. Replace <DESTINATION_PATH> with your required destination directory.

To download the latest instana-autotrace-webhook image, run the following command:

docker pull containers.instana.io/instana/release/agent/instana-autotrace-webhook:latest

To download the latest instrumentation image, run the following command:
```
docker pull icr.io/instana/instrumentation:latest
```
Make sure that the two container images are available in your Container Registry.

To install the Instana AutoTrace webhook, run the following command:

Make sure that the Helm chart archive is available on the system that runs the helm install command.

helm install --create-namespace \
--namespace instana-autotrace-webhook \
--set webhook.image=<INSTANA_AUTOTRACE_WEBHOOK_IMAGE_PATH> \
--set autotrace.instrumentation.image=<INSTRUMENTATION_IMAGE_PATH> \
instana-autotrace-webhook <PATH_TO_HELM_CHART_ARCHIVE>

For more webhook configuration options, see Configuring AutoTrace webhook.

The command installs the AutoTrace webhook in your air-gapped system.

After you install the AutoTrace webhook, verify that the installation is successful and the webhook works. For more information, see Verifying webhook installation.

Container Registry authentication

The instrumentation image in the Container Registry is used as an initContainer in all application pods. If your Container Registry requires the imagePullSecret resource, it must be available in all application namespaces.

Verifying webhook installation

To verify that the webhook is operational, complete the following steps:

To verify that the instana-autotrace-webhook in the instana-autotrace-webhook namespace is running as expected, run the following command:

kubectl get pods -n instana-autotrace-webhook

Sample result:

NAME                                         READY   STATUS    RESTARTS   AGE
instana-autotrace-webhook-7c5d5bf6df-82w7c   1/1     Running   0          12m

Use the Instana AutoTrace webhook. If the Instana AutoTrace webhook is running, deploy a Node.js pod. Instana AutoTrace is automatically enabled in the Node.js pod. In the log for the pod, you can see a label that indicates that the Instana AutoTrace was applied to the Node.js pod:
```
kubectl get pod test-nodejs -n test-apps -o=jsonpath='{.metadata.labels.instana-autotrace-applied}'
true
```

If you installed the Instana host agent by using the instana/agent Helm chart, the Node.js process appears in your Instana dashboard. For more information, see Installing the Host Agent on Kubernetes.

However, if you do not see the instana-autotrace-applied labels appear on your containers, see Troubleshooting AutoTrace webhook.