This page describes how to install the Machine Agent and Network Agents in a Kubernetes cluster where the Cluster Agent Operator is installed.
The Cluster Agent Operator provides a custom resource definition called InfraViz
. You can use InfraViz
to simplify deploying the Machine and Network Agents as a daemonset
in a Kubernetes cluster. Additionally, you can deploy these agents by creating a daemonset YAML
which does not require the Cluster Agent Operator. For more information, see these examples.
To deploy the Analytics Agent as a daemonset
in a Kubernetes cluster, see Install Agent-Side Components in Kubernetes.
Windows Containers are not supported for this deployment. |
Before you begin, verify that you have:
Install the Cluster Agent. From this Alpine Linux example:
Download the Cluster Agent bundle.
Unzip the Cluster Agent bundle.
Deploy the Cluster Agent Operator using the CLI specifying the correct Kubernetes and OpenShift version (if applicable):
unzip appdynamics-cluster-agent-alpine-linux-<version>.zip kubectl create namespace appdynamics |
|
You can also install Cluster Agent Operator from OpenShift OperatorHub in your OpenShift cluster. |
Create a Cluster Agent secret using the Machine Agent access key to connect to the Controller. If a cluster-agent-secret
does not exist, you must create one, see Install the Cluster Agent with the Kubernetes CLI.
kubectl -n appdynamics create secret generic cluster-agent-secret --from-literal=controller-key=<access-key> |
Run the following command to import your CA certificate from custom-ssl.pem file:
keytool -import -alias rootCA -file custom-ssl.pem -keystore cacerts.jks -storepass <your-password> |
Create keystore file secret.
kubectl -n appdynamics create secret generic <cacertinfraviz> --from-file=cacerts.jks |
Create Keystore password secret
kubectl -n appdynamics create secret generic <kspassinfraviz> --from-literal=keystore-password="<your-password>" |
Here, cacertinfraviz
is the keystore filename and kspassinfraviz
is the keystore password of Infrastructure Visibility.
The the keystore file and password that you specify here should be included in the
|
Update the infraviz.yaml
file to set the controllerUrl
, and account
values based on the information from the Controller's License page.
To enable Server Visibility, set enableServerViz
to true
(shown in the infraviz.yaml
configuration example).
To deploy a Machine Agent without Server Visibility enabled, set enableServerViz
to false
.
apiVersion: v1 kind: ServiceAccount metadata: name: appdynamics-infraviz namespace: appdynamics --- apiVersion: cluster.appdynamics.com/v1alpha1 kind: InfraViz metadata: name: appdynamics-infraviz namespace: appdynamics spec: controllerUrl: "https://mycontroller.saas.appdynamics.com" image: "docker.io/appdynamics/machine-agent:latest" account: "<your-account-name>" globalAccount: "<your-global-account-name>" enableContainerHostId: true enableServerViz: true resources: limits: cpu: 500m memory: "1G" requests: cpu: 200m memory: "800M" |
The infraviz.yaml
configuration file example deploys a daemonset
that runs a single pod per node in the cluster. Each pod runs a single container from where the Machine Agent, or Server Visibility Agent runs.
To enable the Network Visibility Agent to run in a second container in the same pod, add the netVizImage
and netVizPort
keys and values as shown in this configuration file example:
apiVersion: v1 kind: ServiceAccount metadata: name: appdynamics-infraviz namespace: appdynamics --- apiVersion: cluster.appdynamics.com/v1alpha1 kind: InfraViz metadata: name: appdynamics-infraviz namespace: appdynamics spec: controllerUrl: "https://mycontroller.saas.appdynamics.com" image: "docker.io/appdynamics/machine-agent:latest" account: "<your-account-name>" enableContainerHostId: true enableServerViz: true netVizImage: appdynamics/machine-agent-netviz:latest netVizPort: 3892 resources: limits: cpu: 500m memory: "1G" requests: cpu: 200m memory: "800M" |
Use kubectl
to deploy infraviz.yaml
|
|
Confirm that the appdynamics-infraviz
pod is running, and the Machine Agent, Server Visibility Agent, and Network Agent containers are ready:
kubectl -n appdynamics get pods NAME READY STATUS RESTARTS AGE appdynamics-infraviz-shkhj 2/2 Running 0 18s |
To verify that the agents are registering with the Controller, review the logs and confirm that the agents display in the Agents Dashboard of the Controller Administration UI. In the Controller, if Server Visibility is enabled, the nodes are visible under Controller > Servers.
kubectl -n appdynamics logs appdynamics-infraviz-shkhj -c appd-infra-agent ... Started Machine Agent Successfully |
InfraViz
Configuration SettingsTo configure Infrastructure Visibility, you can modify these parameters in the infraviz.yaml
file included with the download package. After changing the file, delete and re-create the InfraViz
deployment to ensure the changes are applied.
Parameter | Description | Required/Optional | Default | |
---|---|---|---|---|
account |
| Required | N/A | |
appName | Name of the cluster displayed on the Controller UI as your cluster name. This configuration groups the nodes of the cluster based on the master , worker , infra , worker-infra roles and displays them on the Metric Browser. | Optional | N/A | |
args | List of command arguments | Optional | N/A | |
controllerUrl | URL of the | Required | N/A | |
enableContainerd | Enable containerd visibility on Machine Agent. Specify either | Optional | false | |
enableContainerHostId | Flag that determines how container names are derived; specify either true or false . | Required | true | |
enableMasters | By default, only Worker nodes are monitored. When set to true , Server Visibility is provided for Master nodes. For managed Kubernetes providers, the flag has no effect because the Master plane is not accessible. | Optional | false | |
enableServerViz | Enable Server Visibility | Required
| false | |
enableDockerViz | Enable Docker Visibility | Required | false | |
env | List environment variables | Optional | N/A | |
eventServiceUrl | Event Service Endpoint | Optional | N/A | |
globalAccount | Global account name | Optional | N/A | |
image | Retrieves the most recent version of the Machine Agent image. | Optional | appdynamics/machine-agent:latest | |
imagePullPolicy | The image pull policy for the InfraViz pod. | Optional |
| |
imagePullSecret | Name of the pull secret image | Optional | N/A | |
logLevel | Level of logging verbosity. Valid options are: info or debug . | Optional | info | |
metricsLimit | Maximum number of metrics that the Machine Agent sends to the Controller. | Optional | N/A | |
netVizImage | Retrieves the most recent version of Network Agent image. | Optional | appdynamics/machine-agent-netviz:latest | |
netVizPort | When > 0, the Network Agent is deployed in a sidecar with the Machine Agent. By default, the Network Visibility Agent works with port 3892 . | Optional | 3892 | |
netVizSecurityContext | You can include the following parameters under securityContext:
This sets the appropriate file permission on the agent artifacts. This value is applied to all the instrumented resources. Add this parameter, if you require to override the default value of | Optional | N/A | |
This sets the appropriate file permission on the agent artifacts. This value is applied to all the instrumented resources. Add this parameter, if you require to override the default value of | Optional | N/A | ||
If you do not set this parameter, the helm uses the default value as true.
| Optional | N/A | ||
| Optional | ["NET_ADMIN","NET_RAW"]
| ||
If you do not set this parameter, the helm uses the default value as true.
| Optional | N/A | ||
| Optional | N/A | ||
| Optional | N/A | ||
If the value is true, the Kubelet validates the image at runtime to ensure that the container fails to start when run as root. If this parameter is not specified or if the value is false, there is no validation.
| Optional | N/A | ||
| Optional | N/A | ||
| Optional | N/A | ||
| Optional | N/A | ||
nodeSelector | OS specific label that identifies nodes for scheduling of the daemonset pods. | Optional | linux | |
| The list of volumeMounts. | Optional |
| |
| Name of the priority class that determines priority when a pod needs to be evicted. | Optional | N/A | |
propertyBag | String with any other Machine Agent parameters | Optional | N/A | |
proxyUrl | URL of the proxy server (protocol://domain:port ) | Optional | N/A | |
proxyUser | Proxy user credentials (user@password ) | Optional | N/A | |
resources | Definitions of resources and limits for the Machine Agent | Optional | N/A | |
resourcesNetViz | Set resources for the Network Visibility (NetViz) container | Optional | Request
Limit
| |
runAsUser | The UID (User ID) to run the entry point of the container process. If you do not specify the UID, this defaults to the user id specified in the image.
If you require to run on any other UID, change the UID for runAsUser without changing the group ID.
| Optional |
| |
runAsGroup | The GID (Group ID) to run the entry point of the container process. If you do not specify the ID, this uses the UID specified in the image,
| Optional | GID: 1001 Username: appdynamics | |
| You can include the following parameters under securityContext:
This sets the appropriate file permission on the agent artifacts. This value is applied to all the instrumented resources. Add this parameter, if you require to override the default value of | Optional | NA | |
This sets the appropriate file permission on the agent artifacts. This value is applied to all the instrumented resources. Add this parameter, if you require to override the default value of | Optional | NA | ||
If you do not set this parameter, the helm uses the default value as true.
| Optional | true | ||
| Optional | NA | ||
If you do not set this parameter, the helm uses the default value as true.
| Optional | true | ||
| Optional | NA | ||
| Optional | NA | ||
If the value is true, the Kubelet validates the image at runtime to ensure that the container fails to start when run as root. If this parameter is not specified or if the value is false, there is no validation.
| Optional | NA | ||
| Optional | NA | ||
| Optional | NA | ||
| Optional | NA | ||
stdoutLogging | Determines if logs are saved to a file or redirected to the Console. | Optional | false | |
tolerations | List of tolerations based on the taints that are associated with nodes. | Optional | N/A | |
uniqueHostId | Unique host ID in | Optional | spec.nodeName |