Installing Z APM Connect DG for Proof of Concept evaluation

Edit online

For Proof of Concept evaluation, you can install Z APM Connect Distributed Gateway (Z APM Connect DG) into a distributed machine either by using the Kubernetes one-machine sandbox configuration or by using the provided Docker images.

  • Option 1: Installing Kubernetes One-Machine Sandbox (recommended)

    This approach uses the simplest configuration to deploy the Distributed Gateway in a Kubernetes Cluster. Although it is not recommended for a production environment, it allows for scalability by adding more cluster nodes and adjusting the number of replicas of each pod. You can begin with this configuration and later scale up for a proper production environment. For detailed instructions on installation and configuration, see Installing Kubernetes One-Machine Sandbox.

  • Option 2: Installing on a distributed Linux® environment with Docker standalone

    The Z APM Connect DG Docker images are provided for installing on a single machine using Docker. To configure Z APM Connect DG, you need to use the ./zapmctl script along with command line arguments. This option is most suitable for a sandbox environment or proof of concept. However, it has limited scalability and may not fulfill the requirements for a production environment. For detailed instructions on installation and configuration, see Installing Z APM Connect DG with Docker standalone.

Before you begin

Edit online

Required configuration information for the Instana solution

The Z APM Connect Distributed Gateway sends data to Instana through the serverless ingestion endpoint. The best way to find the necessary credentials to enable the product are through the AWS Lambda agent configuration tab, which can be found as follows:

  • INSTANA_ENDPOINT_URL and INSTANA_AGENT_KEY are required, which can be found from the following steps with a user that has Agent download and agent key visibility and Configuration of agents permissions in Instana:

    1. Sign in to Instana and click ...More > Agents > Install Agents > AWS.

    2. From the Technology list, select AWS Lambda.

For on-premises Instana servers, when TLS is used to secure the connection between the Instana server and Z APM Connect Distributed Gateway:

  • If the server's certificate is self-signed or signed by a private CA, a PEM encoded version of that CA certificate is required.

  • If certificates are used, permissions of certificate must allow global read access. This can be achieved with the following command:

    chmod 444 cert-file-name.pem

  • If you are using Kubernetes One-Machine Sandbox configuration, and the Instana server uses a certificate signed by a private CA, an Instana secret is needed that contains the pem file which contains the CA as well as any intermediate signing certificates.

Run the following command to create the Instana secret:

kubectl create secret generic <secret name> --from-file=<cert name>

For example:

kubectl create secret generic instana-auth --from-file=cert.pem

Note: Ensure that the certificate name provided here is used consistently in the configuration file values.yaml or instana-exporter.yaml later on, i.e. the value for the certName parameter or ZAPM_INSTANA_CERT_NAME, respectively.