<img height="1" width="1" style="display:none;" alt="" src="https://px.ads.linkedin.com/collect/?pid=1110556&amp;fmt=gif">
Skip to content
    October 4, 2021

    Deploy the RESTMon Microservice in Minutes

    Within any enterprise, IT operations teams use a variety of solutions to monitor their technology ecosystem. These products are often business critical and cannot easily be replaced or migrated. Ultimately, it’s important that teams can analyze and correlate data from these different tools so they can produce the insights they need to improve decision making. To help address these requirements, Broadcom offers RESTMon.

    What is RESTMon?

    RESTMon is a lightweight, open, and extensible connector that uses REST APIs to integrate with third-party products and services and pull data into DX Operational Intelligence. You can find more information about RESTMon in this post.

    How to Deploy RESTMon in an OpenShift Cluster

    In this practitioner post, we will cover how to stand-up a RESTMon instance in minutes using Helm charts in an OpenShift or Kubernetes cluster. Keep in mind that RESTMon can also be deployed as a standalone Docker container.

    In a matter of minutes, you should be able to leverage your existing investments, produce insights, and reduce time to value. Follow these three steps:

    1. Start by downloading the RESTMon package from https://support.broadcom.com/enterprise-software and check the prerequisites. (Basically, Docker and Helm must be installed).
    2. Then make the RESTMon image available to the target cluster. You can achieve this by loading the Docker image in all worker nodes of the cluster:
      docker load < dx-restmon-2.1.tar.gz
      Or simply pushing the image to the registry of your cluster:
      docker tag <restmon_image_id> <your_registry>:<port>/dx-restmon
      docker push <your_registry>:<port>/dx-restmon
      In both cases, the image will be ready and available to be deployed.
    3. The final step is to launch the Helm command to deploy RESTMon. This command can take multiple parameters to configure the connector, such as port, persistent storage file system, tenant associated with the connector, and tokens for authentication.

    The full list of variables is described in RESTMon docs.

    All fields in bold are variables that you should adapt to your environment:

    helm install restmonapp restmon-2.1.tgz \

    --set restmon.settings.service_port=8787 \

    --set restmon.storage.nfs_path=/nfs/ca/dxi/restmon \

    --set restmon.storage.nfs_server=<nfs_server> \

    --set restmon.id=restmon \

    --set restmon.settings.tenant_id=<tenantId> \

    --set restmon.settings.oi_ingestion_tenant_token=<tenant_token> \

    --namespace restmon \

    --set restmon.settings.supportability_agentToken=<agent_token> \

    --set restmon.settings.supportability_instanceName=myrestmoninstance \

    --set restmon.settings.supportability_apiEndpont=https://axa.dxi-na1.saas.broadcom.com:443

    (Note the supportability metrics variables: They are important to report RESTMon status and performance)

    The result of this command is the deployment of several objects in your OpenShift project, such as a pod, a service, a deployment, and a replica set.

    After a couple of minutes, your RESTMon instance should be up and running. You can verify this by running the following command in your namespace:
    oc get pod

    And verify that the RESTMon pod is running. You can also check the logs using:

    oc logs <restmon_pod_name>

    To access the RESTMon UI, note the port assigned to your RESTMon service. For instance:

    oc get svc

    NAME               TYPE ...           PORT(S)        AGE

    dx-restmon-restmon LoadBalancer ...   8787:20123/TCP 16m

    Then connect from a browser using the NodePort, as shown below:

    Broadcom Enterprise Software Academy - Deploy the RESTMon Microservice in Minutes

    Voilà. You are now ready to connect to different sources via REST APIs. At the time of writing this post, we have 17 integrations available.

    You can also follow the video tutorial here.

    Benefits of Running RESTMon as a Microservice

    By running RESTMon as a microservice, you can realize a number of benefits:

    • You can roll out and manage several deployments of RESTMon in the same cluster.
    • You can now monitor RESTMon performance and health via DX dashboards.
    • You can realize improved availability of RESTMon microservices using Liveness and Readiness probes.
    • You can centrally monitor all RESTMon instances from a single DX Operational Intelligence tenant.

    To learn more about RESTMon, visit Broadcom Enterprise Software Academy.

    Tag(s): AIOps

    Nestor Falcon Gonzalez

    Nestor holds a Master's Degree in Telecommunication Engineering and has over 20 years of experience in Telco, Network and Infrastructure Operations in different roles: SWAT, pre-sales and Solution Architect. He focuses on helping customers on their network transformation, driving innovation and providing value for...

    Other resources you might be interested in

    icon
    Blog October 30, 2025

    This Halloween, the Scariest Monsters Are in Your Network

    See how network observability can help you identify and tame the zombies, vampires, and werewolves lurking in your network infrastructure.

    icon
    Blog October 29, 2025

    Your Root Cause Analysis is Flawed by Design

    Discover the critical flaw in your troubleshooting approaches. Employ network observability to extend your visibility across the entire service delivery path.

    icon
    Blog October 29, 2025

    Whose Fault Is It When the Cloud Fails? Does It Matter?

    In today's interconnected environments, it is vital to gain visibility into networks you don't own, including internet and cloud provider infrastructures.

    icon
    Blog October 29, 2025

    The Future of Network Configuration Management is Unified, Not Uncertain

    Read this post and discover how Broadcom is breathing new life into the trusted Voyence NCM, making it a core part of its unified observability platform.

    icon
    Office Hours October 23, 2025

    Rally Office Hours: October 9, 2025

    Discover Rally's new AI-powered Team Health Widget for flow metrics and drill-downs on feature charts. Plus, get updates on WIP limits and future enhancements.

    icon
    Course October 23, 2025

    AAI - Navigating the Interface and Refining Data Views

    This course introduces you to AAI’s interface and shows you how to navigate efficiently, work with tables, and refine large datasets using search and filter tools.

    icon
    Office Hours October 23, 2025

    Rally Office Hours: October 16, 2025

    Rally's new AI-driven feature automates artifact breakdown - transforming features into stories or stories into tasks - saving time and ensuring consistency.

    icon
    Blog October 22, 2025

    What’s New in Network Observability for Fall 2025

    Discover how the Fall 2025 release of Network Observability by Broadcom introduces powerful new capabilities, elevating your insights and automation.

    icon
    eBook October 22, 2025

    Modernizing Monitoring in a Converged IT-OT Landscape

    The energy sector is shifting, driven by rapid grid modernization and the convergence of IT and OT networks. Traditional monitoring tools fall short.