mirror of
https://github.com/haproxy/haproxy.git
synced 2026-07-16 23:10:59 -04:00
DOC: server: document 'set server name' CLI command
Some checks are pending
Contrib / admin/halog/ (push) Waiting to run
Contrib / dev/flags/ (push) Waiting to run
Contrib / dev/haring/ (push) Waiting to run
Contrib / dev/hpack/ (push) Waiting to run
Contrib / dev/poll/ (push) Waiting to run
FreeBSD / clang (push) Waiting to run
VTest / Generate Build Matrix (push) Waiting to run
VTest / (push) Blocked by required conditions
Windows / Windows, gcc, all features (push) Waiting to run
Some checks are pending
Contrib / admin/halog/ (push) Waiting to run
Contrib / dev/flags/ (push) Waiting to run
Contrib / dev/haring/ (push) Waiting to run
Contrib / dev/hpack/ (push) Waiting to run
Contrib / dev/poll/ (push) Waiting to run
FreeBSD / clang (push) Waiting to run
VTest / Generate Build Matrix (push) Waiting to run
VTest / (push) Blocked by required conditions
Windows / Windows, gcc, all features (push) Waiting to run
Document the new 'set server <b>/<s> name <newname>' CLI command in management.txt. The documentation states the two preconditions that gate the operation (server must be in maintenance, server's name must not be statically referenced via use-server / track / ARGT_SRV), notes that the command is not gated by a per-backend opt-in directive (parity with 'add server' / 'del server'), and mentions the EVENT_HDL_SUB_SERVER_NAME event published on successful rename so Lua and other event consumers know to subscribe to it.
This commit is contained in:
parent
4949b0a9a7
commit
af9bb8507d
1 changed files with 40 additions and 0 deletions
|
|
@ -2700,6 +2700,46 @@ set server <backend>/<server> ssl [ on | off ] (deprecated)
|
|||
This command is deprecated, create a new server dynamically with or without
|
||||
SSL instead, using the "add server" command.
|
||||
|
||||
set server <backend>/<server> name <newname>
|
||||
Change the name of a server at runtime.
|
||||
|
||||
Two preconditions are enforced:
|
||||
- the server must be administratively in maintenance mode (set first
|
||||
via "set server <b>/<s> state maint" or "disable server <b>/<s>");
|
||||
- the server's name must not be statically referenced by a
|
||||
"use-server" rule, a "track" directive, or a sample-fetch argument
|
||||
of type ARGT_SRV. Such references are recorded at configuration
|
||||
load time and renaming the target would leave the running state
|
||||
inconsistent with the configuration text.
|
||||
|
||||
Like "add server" and "del server", this command is not gated by a
|
||||
per-backend opt-in directive: availability is determined entirely by
|
||||
the server's runtime properties.
|
||||
|
||||
The new name must be syntactically valid (non-empty, must pass
|
||||
invalid_char(), i.e. only [A-Za-z0-9_:.-]) and must be unique among
|
||||
all servers in the backend. The change is effective immediately for
|
||||
all runtime operations, stats, and logs, but is not persisted to the
|
||||
configuration file and will be lost on reload. Some features that
|
||||
rely on static server names (such as stick-tables or external
|
||||
monitoring) may not recognize the new name until restart.
|
||||
|
||||
A successful rename publishes an EVENT_HDL_SUB_SERVER_NAME event
|
||||
carrying the old and new names, which Lua scripts and other event
|
||||
consumers can subscribe to.
|
||||
|
||||
There is no strict requirement that no sessions are active before
|
||||
renaming. However, if there are active sessions, log entries for
|
||||
those sessions may use either the old or new name, depending on when
|
||||
the rename occurs relative to logging. This may result in split or
|
||||
inconsistent logs for in-flight requests. If strict log consistency
|
||||
is required, it is the user's responsibility to ensure all sessions
|
||||
have finished before renaming (e.g. by draining via maintenance mode
|
||||
and waiting for all connections to close).
|
||||
|
||||
Example:
|
||||
set server myapp/s1 name blue
|
||||
|
||||
set severity-output [ none | number | string ]
|
||||
Change the severity output format of the stats socket connected to for the
|
||||
duration of the current session.
|
||||
|
|
|
|||
Loading…
Reference in a new issue