Oracle Cloud Infrastructure Documentation

Deploy Synthetic Worker on Kubernetes

To deploy a Synthetic Worker on Kubernetes, you need to download and deploy the Synthetic Worker docker image.

Review the following prerequisites:
  1. Supported versions:
    • Kubernetes v1.25 or higher.
    • Helm Chart 3.
  2. Download the on premise vantage point's helm chart zip and unzip. Upload the worker docker image downloaded in Download Synthetic Worker to a private docker registry. For example: OCI Registry.
  3. To pull images from a private image repository, a pull secret is required.

    Depending on the Kubernetes distribution, you need to generate a pull secret. For information, see Pulling Images from Registry during Deployment.

    To deploy on OKE, Oracle recommends to use Use Dedicated Vantage Points instead.

To deploy the Synthetic Worker on Kubernetes:
  1. Open the navigation menu, and click Observability & Management. Under Application Performance Monitoring, click Synthetic Monitoring.
    The Synthetic Monitoring page is displayed.
  2. Under Resources, located in the left menu, click On-premise Vantage Points.
    The On-premise Vantage Points page is displayed.
  3. Under Get started, click Worker usage instruction and select Kubernetes.
  4. Select Download helm chart, and download the apm-synthetic-worker-helm file.
    To verify the file integrity, check if the value of the MD5 checksum column matches the output of the downloaded zip file.
  5. Provide the following required information
    1. Worker name: Enter the worker name.

      Provide a unique name. No spaces, only numbers, letters, hyphens or underscores.

    2. On-premise Vantage Point: Select the On-premise Vantage Point that the worker connects to.
    3. APM domain private data key: Select the APM domain private data key used to upload data to APM.

      If the Authorization type value is selected as a private data key, this value is also used to create a worker.

    4. APM synthetic api server: Enter the URL of the Synthetic API server where the on-premise vantage point will be created.
    5. Downloaded file path: Enter the path where the downloaded helm file is located.
    6. Repository URL: Enter the repository URL from which image will be pulled.
    7. Authorization type: Select the authorization type used for the worker creation.
    8. Pull secret name: Specify the image pull secret name created in default namespace.
    9. Authorization type: Select the authorization type used for the worker creation.
      • Private data key: This is used as the installation authorization key to create a worker. This is the preferred authorization type when installing a worker in an on-premise host.
    10. (Optional) Show proxy options: Set the proxy server configuration to access the target URL.

      The supported proxy options are: NONE and BASIC.

      BASIC: If it's selected, the following parameters need to be provided:
      • Proxy Host: The designated proxy server that is configured to route internet.
      • Proxy Port: The port number on which the proxy server is listening for the requests/responses.
      • (Optional) Proxy User: The username of the proxy server.
      • (Optional) Proxy Password: The username password of the proxy server.
      • (Optional) Proxy BypassList: The list of hostnames where the proxy is not required to connect to.

    The information provided on the Worker usage information generates the Helm commands shown under Kubernetes.

  6. Copy and run the generated commands to create the worker.
    Note

    • Run Helm command with --dry-run flag to verify helm command without creating any resources.
    • Run Helm command with --debug flag to debug helm command.
  7. Ensure all commands run successfully.
The synthetic worker is deployed.