Starting Z APM Connect Distributed Gateway

Edit online

You can start Z APM Connect Distributed Gateway (Z APM Connect DG) either by using Helm or using the manual yaml deployments, depending on how you populated the deployment files.

Important: If you're using fix pack 2 or earlier, follow the instructions in Starting Z APM Connect Distributed Gateway

  • Option 1: Starting with Helm

  • Option 2: Starting with .yaml deployment files

Starting with Helm

To start with Helm, navigate to the directory where the Helm chart is located (./production/helm-deployment). It should be named ioz-helm-chart-6.1.1-7.tgz. Run the following command to install your deployment.

helm install --namespace <desired project or namespace> -f <values yaml> <name> <chart location>

For example:

helm install --namespace ibm-zapm -f values.yaml zapm ./ioz-helm-chart-6.1.1-7.tgz

Note: You need to run all Helm commands with sudo or root privileges.

The Helm installer runs several self-tests to validate the configuration, and after a few moments the application should be ready to use.

If the test continues to report pending state for more than a minute, this likely means OpenShift is having trouble pulling the required image. Ensure that the image registry hostname is correct and that OpenShift is correctly authenticating with the registry.

If Helm reports that any tests failed, the logs of the failed test's pod will explain what went wrong. To view and extract the console logs from a particular pod, run the following command:

kubectl logs <pod name>

After you correct any errors, you need to uninstall Z APM Connect DG and re-install the application to try again. For more information about uninstalling, see Uninstalling Z APM Connect DG.

If any values need to be changed in the deployment, update the values.yaml file and then upgrade the deployment. For more information, see Updating provided .yaml deployment Files.

Starting with .yaml deployment files

To start by using the manual .yaml deployments, navigate to the deployments directory and run the following command to install your deployment.

kubectl apply -f ./

After applying the changes, you can check the status of the components by running the following command.

kubectl get pods

Results

It may take a few minutes for everything to start fully. When the pod status is changed from Starting to Running, Z APM Connect DG is started. If any pod reports that it is unhealthy or crashing, running the kubectl inspect podName command can give further details on why the pod is not starting properly.