Confused about internal services

Traefik Traefik v3 (latest)
,
1

Hello,
when setting up a new Traefik instance (dashboard access), I've always just pasted in what worked the first time and haven't given it much thought (i.e. the following router).

traefik-dashboard:
      entryPoints: ["https"]
      rule: "Host(`traefik.domain.com`)"
      tls: {}
      service: api@internal

Now I'm wondering, though, there are two internal services that confuse me - the api@internal and dashboard@internal. My thought process is that the API service would be used for the HTTP API and the dashboard one to display the dashboard. When I change out the api@internal for dashboard@internal, I get the application but no data. The AJAX requests it's making are directed to the current URL with the API endpoint appended, but the API is no longer being served at /api.

So, let's say I wanted to have the dashboard at traefik.domain.com and the API at api.traefik.domain.com (usage -> api.traefik.domain.com/entrypoints). How would one achieve that?

Note that I never actually used the API and I don't think I ever will. This is more of a hypothetical question as I want to understand Traefik beyond an "I'm able to add a router" knowledge.

Thank you

2

You are probably the first person going down that path :wink:

Usually api and dashboard go together, as in doc:


# Dynamic Configuration
labels:
  - "traefik.http.routers.dashboard.rule=Host(`traefik.example.com`) && (PathPrefix(`/api`) || PathPrefix(`/dashboard`))"
  - "traefik.http.routers.dashboard.service=api@internal"
  - "traefik.http.routers.dashboard.middlewares=auth"
  - "traefik.http.middlewares.auth.basicauth.users=test:$$apr1$$H6uskkkW$$IgXLP6ewTrSuBkTrqE8wj/,test2:$$apr1$$d9hr9HBB$$4HxwgUir3HP4EsggP/QNo0"

There is no way to even set a different path for /dashboard, so I doubt there will be a way to tell it to use a different host for api requests.

3

Alright, I’m glad I didn’t miss anything. I was just wondering why they’re split and I only ever see people use the api not the dashboard service.

4

You can by using middlewares to redirect and perform path manipulation:

http:
  routers:
    traefik-api:
      rule: Host(`api.example.com`)
      entryPoints:
        - websecure
      middlewares:
        - allow-dashboard-cors
        - strip-api
        - add-api
      service: api@internal
    traefik-dashboard-redirect-api:
      rule: Host(`dashboard.example.com`) && PathPrefix(`/api/`)
      entryPoints:
        - websecure
      middlewares:
        - redirect-dashboard-to-api
      service: noop@internal
    traefik-dashboard:
      rule: Host(`dashboard.example.com`)
      entryPoints:
        - websecure
      middlewares:
        - auth
        - strip-dashboard
        - add-dashboard
      service: api@internal

  middlewares:
    auth:
      basicAuth:
        users:
          - "hafio:$2y$05$U6NESdpShx529Ao1bAJI/.x42WGE5ZFNBYp2PICrEGsDAC2d86kFK"
    allow-dashboard-cors:
      headers:
        accessControlAllowOriginList:
        - https://dashboard.example.com
    redirect-dashboard-to-api:
      redirectRegex:
        regex: "^https://dashboard\\.example\\.com/api/(.*)"
        replacement: "https://api.example.com/$1"
        permanent: true
    add-api:
      addPrefix:
        prefix: "/api"
    add-dashboard:
      addPrefix:
        prefix: "/dashboard"
    strip-api:
      stripPrefix:
        prefixes: "/api"
    strip-dashboard:
      stripPrefix:
        prefixes: "/dashboard"

dashboard.example.com/api redirects to api.example.com - i did not do the reverse since the entry point is usually dashboard.example.com