Skip to content

Commit a5d949d

Browse files
xquanluudavehorton
authored andcommitted
wip
1 parent 4e39c48 commit a5d949d

File tree

4 files changed

+211
-134
lines changed

4 files changed

+211
-134
lines changed

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,50 @@ Configuration is provided via environment variables:
2929
|JAMBONES_REGBOT_DEFAULT_EXPIRES_INTERVAL| default expire value for outbound registration in seconds (default 3600) |no|
3030
|JAMBONES_REGBOT_MIN_EXPIRES_INTERVAL| minimum expire value for outbound registration in seconds (default 30) |no|
3131

32+
## CLI Management
33+
34+
The SBC provides a CLI tool for runtime management of feature servers. Use the CLI to drain/undrain feature servers during maintenance or scaling operations.
35+
36+
### Installation
37+
```bash
38+
npm install
39+
```
40+
41+
### Usage
42+
```bash
43+
# Show all commands
44+
npm run cli
45+
46+
# Drain a feature server (remove from active pool)
47+
npm run cli fs drain 192.168.1.10
48+
49+
# Undrain a feature server (add back to active pool)
50+
npm run cli fs undrain 192.168.1.10
51+
52+
# List currently drained servers
53+
npm run cli fs drained
54+
55+
# List all available feature servers
56+
npm run cli fs active
57+
58+
# Show all servers with status
59+
npm run cli fs list
60+
```
61+
62+
### Examples
63+
```bash
64+
# During maintenance - drain server before updates
65+
npm run cli fs drain 10.0.1.5
66+
67+
# After maintenance - bring server back online
68+
npm run cli fs undrain 10.0.1.5
69+
70+
# Check which servers are available for draining
71+
npm run cli fs active
72+
```
73+
74+
The CLI connects via Unix socket (`/tmp/sbc-sip-sidecar.sock`) and requires admin access to the server.
75+
3276
## Registrar database
3377

3478
A redis database is used to hold active registrations. When a register request arrives and is authenticated, the following values are parsed from the request:

0 commit comments

Comments
 (0)