Slightly confused with docker setup

[arminus]

I'm a longtime user of performa and cronicle and I'm very excited about xyOps !

There's one thing which confuses me a bit: When I set it up as a docker container, it adds the container itself as server (or satellite?) automatically. But obviously, I need to add the docker host as server (satellite) if I want to run bare metal events on it. After that I end up with 2 entries basically for the same server in the Active Servers list.

What now gets a bit confusing is the naming of these 2. i.e. I need to come up with a different name for the docker host/bare metal satellite/server to be able to target it for the events.

This "adding itself" doesn't seem to happen when I start the main server bare metal and I'm not sure if it even makes sense with the docker deployment?

[jhuckaby]

Hi there, and welcome to xyOps!

I'm so sorry for the confusion. The Quick-Start Docker setup instructions include an optional flag that causes xyOps to launch its own internal satellite instance inside the same container:

-e XYOPS_xysat_local="true"

This was done because it gets new users "up and running" very quickly, so they can start running jobs without going through the somewhat complicated process of adding a remote server.

You can totally feel free to remove this if you have added your own servers! In fact, the docs do say that you should remove it for production use:

The XYOPS_xysat_local environment variable causes xyOps to launch xySat in the background, in the same container. This is so you can start running jobs right away -- it is great for testing and home labs, but not recommended for production setups.

https://docs.xyops.io/#Docs/hosting/quick-start

Hope this helps, and thank you for trying out xyOps!

❤️

[arminus]

Thanks for the quick reply, I obviously missed that in the docs.

[jhuckaby]

No worries at all! Cheers!

[ovizii]

This is weird, I also used XYOPS_xysat_local: "true" but the result is one server and two conductors as opposed to the other person who ended up with two servers. Any explanation for this behaviour? I am just getting started with xyOps, so I don't mind wiping the full setup and starting from scratch as I am still testing.

[jhuckaby]

I removed that entry, and now I see 1 conductor and one server

Oh? That's odd... I wonder if it maybe self-corrected the masters.json file after the next restart? Or your disk got wiped? I am not entirely sure what's going on there. Changing the conductor server hostname is "undefined behavior" at the moment, and I will work on improving the UX there.

I was more wondering about how the other person saw two servers while I don't.

OP installed xyOps Satellite on the host server, and didn't expect to see the "extra" satellite in the list, which gets auto-installed inside the conductor's container with the default XYOPS_xysat_local variable.

[ovizii]

Well, just to be clear, I had removed the wrong entry from the masters.json before doing a docker compose down followed by docker compose up -d.

{
        "masters": [
                "xyops"
        ]
}

This is my compose, which means, I should also see two servers, right?

services:

# https://docs.xyops.io

  xyops01:
    image: ghcr.io/pixlcore/xyops:latest
    container_name: xyops
    hostname: xyops

    init: true
    restart: unless-stopped

    environment:
      XYOPS_xysat_local: "true"
      TZ: Europe/Berlin

    volumes:
      - ./xy-data:/opt/xyops/data
      - ./xyops-conf:/opt/xyops/conf
      - /var/run/docker.sock:/var/run/docker.sock

    ports:
      - "5522:5522"
      - "5523:5523"

    cpus: 1
    mem_limit: 1G

[jhuckaby]

Hmm, not sure. I don't see anything odd with your compose file.

xyOps lives and dies by the masters.json file, and it probably got really confused when the conductor hostname changed. Currently that's "undefined behavior", meaning the code really doesn't handle that situation very well at all, and probably broke itself in weird and unexpected ways.

I have a TODO item to improve the UX around hostname changes. Very sorry you ran into this 😞

[nickdollimount]

Well, just to be clear, I had removed the wrong entry from the masters.json before doing a docker compose down followed by docker compose up -d.

{
        "masters": [
                "xyops"
        ]
}

This is my compose, which means, I should also see two servers, right?

services:

# https://docs.xyops.io

  xyops01:
    image: ghcr.io/pixlcore/xyops:latest
    container_name: xyops
    hostname: xyops

    init: true
    restart: unless-stopped

    environment:
      XYOPS_xysat_local: "true"
      TZ: Europe/Berlin

    volumes:
      - ./xy-data:/opt/xyops/data
      - ./xyops-conf:/opt/xyops/conf
      - /var/run/docker.sock:/var/run/docker.sock

    ports:
      - "5522:5522"
      - "5523:5523"

    cpus: 1
    mem_limit: 1G

Just at a glance, without looking at the original post, I would expect this to provide a single server and a single conductor. The XYOPS_xysat_local: "true" tells it to also install xySat (server [satellite], the piece that executes jobs) alongside xyOps (conductor).

[ovizii]

Not quite sure, still trying to figure out the meaning of the used terms in xyOps. I am unsure where satellites fit in.

On the servers page I read:

Servers are worker nodes that execute jobs and collect metrics. Each runs the xySat agent, maintains a connection to a conductor, and reports host details and monitoring data.

On the conductors page:

Conductors are the main xyOps scheduler servers that coordinate job launches, data ingestion, storage, and the UI. A cluster can run multiple conductors for redundancy; one is primary at any moment.