Portainer Templates logo

Portainer Templates

Microsoft OMS Agent Microsoft OMS Agent

Swarm

Ops

Microsoft Operations Management Suite Linux agent.

Configuration

Type
Swarm
Platform
linux
Image
microsoft/oms
Ports
25225:2522525224:25224/udp
Volumes
/var/run/docker.sock : /var/run/docker.sock
Env vars
WSID=${AZURE_WORKSPACE_ID}KEY=${AZURE_PRIMARY_KEY}AZURE_WORKSPACE_ID=''AZURE_PRIMARY_KEY=''
Source
Repo

Template by portainer·Source

Standalone Install

Select an install method, to see config/commands for deploying Microsoft OMS Agent

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Microsoft OMS Agent, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The swarm stack file this template deploys, straight from its repo:

version: '3'

services:
  oms:
    image: microsoft/oms
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    environment:
      WSID: ${AZURE_WORKSPACE_ID}
      KEY: ${AZURE_PRIMARY_KEY}
    deploy:
      mode: global
      restart_policy:
        condition: on-failure
    ports:
      - "25225:25225"
      - "25224:25224/udp"

Or deploy it directly from the source:

git clone https://github.com/portainer/templates
cd templates
docker stack deploy -c stacks/microsoft-oms/docker-stack.yml microsoft-oms-agent

More install options in our documentation.

Serve Microsoft OMS Agent on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying microsoft-oms-agent.example.com to http://oms:25225

Add this to your Caddyfile

microsoft-oms-agent.example.com {
	reverse_proxy http://oms:25225
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:25225 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :25225
  • Stop the other service, or pick a different host port. In 25225:25225 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:25225. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, oms can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 25225

Can't reach the Docker socket

oms talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull microsoft/oms

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Required settings are blank

AZURE_WORKSPACE_ID, AZURE_PRIMARY_KEY have no default value, and oms may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Swarm stack

Microsoft OMS Agent is a Swarm stack. Swarm is Docker's own way of running apps across more than one machine, so Portainer can spread it over a cluster and move it elsewhere if a server drops out.

The app image

An image is the app packed up ready to go, everything Microsoft OMS Agent needs bundled into one download. This template pulls microsoft/oms, which Docker fetches once and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Microsoft OMS Agent's comes from Docker Hub, published by microsoft.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Ports

A port is the door the app answers on. A mapping like 25225:25225 means it's reachable on port 25225 of your server, where the left number is yours to change and the right one belongs to the app. It opens:

  • 25225:25225
  • 25224:25224 over UDP

Volumes

A volume is where Microsoft OMS Agent keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Microsoft OMS Agent takes 4 of them, and 2 need a value before it'll start properly:

  • WSID, pulled from your own environment
  • KEY, pulled from your own environment
  • AZURE_WORKSPACE_ID, needs a value. Azure Workspace ID
  • AZURE_PRIMARY_KEY, needs a value. Azure primary key

Networking

Nothing custom is set, so Microsoft OMS Agent sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container oms. That's what you'll spot in the containers list and use in commands like docker logs oms.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Microsoft OMS Agent up. Add the template list to Portainer once, then deploying Microsoft OMS Agent is a click rather than a wall of config.