1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
|
/*
* Copyright (c) 2022. Nydus Developers. All rights reserved.
*
* SPDX-License-Identifier: Apache-2.0
*/
package system
import (
"encoding/json"
"fmt"
"io"
"net"
"net/http"
"os"
"path"
"path/filepath"
"regexp"
"strconv"
"strings"
"time"
"github.com/containerd/containerd/log"
"github.com/gorilla/mux"
"github.com/pkg/errors"
"github.com/containerd/nydus-snapshotter/pkg/daemon"
"github.com/containerd/nydus-snapshotter/pkg/daemon/types"
"github.com/containerd/nydus-snapshotter/pkg/errdefs"
"github.com/containerd/nydus-snapshotter/pkg/filesystem"
"github.com/containerd/nydus-snapshotter/pkg/manager"
metrics "github.com/containerd/nydus-snapshotter/pkg/metrics/tool"
"github.com/containerd/nydus-snapshotter/pkg/prefetch"
)
const (
// NOTE: Below service endpoints are still experimental.
endpointDaemons string = "/api/v1/daemons"
// Retrieve daemons' persisted states in boltdb. Because the db file is always locked,
// it's very helpful to check daemon's record in database.
endpointDaemonRecords string = "/api/v1/daemons/records"
endpointDaemonsUpgrade string = "/api/v1/daemons/upgrade"
endpointPrefetch string = "/api/v1/prefetch"
)
const defaultErrorCode string = "Unknown"
// Nydus-snapshotter might manage dozens of running nydus daemons, each daemon may have multiple
// file system instances attached. For easy maintenance, the system controller can interact with
// all the daemons in a consistent and automatic way.
// 1. Get all daemons status and information
// 2. Trigger all daemons to restart and reload configuration
// 3. Rolling update
// 4. Daemons failures record as metrics
type Controller struct {
fs *filesystem.Filesystem
managers []*manager.Manager
// httpSever *http.Server
addr *net.UnixAddr
router *mux.Router
}
type upgradeRequest struct {
NydusdPath string `json:"nydusd_path"`
Version string `json:"version"`
Policy string `json:"policy"`
}
type errorMessage struct {
Code string `json:"code"`
Message string `json:"message"`
}
func newErrorMessage(message string) errorMessage {
return errorMessage{Code: defaultErrorCode, Message: message}
}
func (m *errorMessage) encode() string {
msg, err := json.Marshal(&m)
if err != nil {
log.L.Errorf("Failed to encode error message, %s", err)
return ""
}
return string(msg)
}
func jsonResponse(w http.ResponseWriter, payload interface{}) {
respBody, err := json.Marshal(&payload)
if err != nil {
log.L.Errorf("marshal error, %s", err)
m := newErrorMessage(err.Error())
http.Error(w, m.encode(), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusOK)
w.Header().Set("Content-Type", "application/json")
if _, err := w.Write(respBody); err != nil {
log.L.Errorf("write body %s", err)
}
}
type daemonInfo struct {
ID string `json:"id"`
Pid int `json:"pid"`
APISock string `json:"api_socket"`
SupervisorPath string `json:"supervisor_path"`
Reference int `json:"reference"`
HostMountpoint string `json:"mountpoint"`
StartupCPUUtilization float64 `json:"startup_cpu_utilization"`
MemoryRSS float64 `json:"memory_rss_kb"`
ReadData float32 `json:"read_data_kb"`
Instances map[string]rafsInstanceInfo `json:"instances"`
}
type rafsInstanceInfo struct {
SnapshotID string `json:"snapshot_id"`
SnapshotDir string `json:"snapshot_dir"`
Mountpoint string `json:"mountpoint"`
ImageID string `json:"image_id"`
}
func NewSystemController(fs *filesystem.Filesystem, managers []*manager.Manager, sock string) (*Controller, error) {
if err := os.MkdirAll(filepath.Dir(sock), os.ModePerm); err != nil {
return nil, err
}
if err := os.Remove(sock); err != nil {
if !os.IsNotExist(err) {
return nil, err
}
}
addr, err := net.ResolveUnixAddr("unix", sock)
if err != nil {
return nil, errors.Wrapf(err, "resolve address %s", sock)
}
sc := Controller{
fs: fs,
managers: managers,
addr: addr,
router: mux.NewRouter(),
}
sc.registerRouter()
return &sc, nil
}
func (sc *Controller) Run() error {
log.L.Infof("Start system controller API server on %s", sc.addr)
listener, err := net.ListenUnix("unix", sc.addr)
if err != nil {
return errors.Wrapf(err, "listen to socket %s ", sc.addr)
}
err = http.Serve(listener, sc.router)
if err != nil {
return errors.Wrapf(err, "system management serving")
}
return nil
}
func (sc *Controller) registerRouter() {
sc.router.HandleFunc(endpointDaemons, sc.describeDaemons()).Methods(http.MethodGet)
sc.router.HandleFunc(endpointDaemonsUpgrade, sc.upgradeDaemons()).Methods(http.MethodPut)
sc.router.HandleFunc(endpointDaemonRecords, sc.getDaemonRecords()).Methods(http.MethodGet)
sc.router.HandleFunc(endpointPrefetch, sc.setPrefetchConfiguration()).Methods(http.MethodPut)
}
func (sc *Controller) setPrefetchConfiguration() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
body, err := io.ReadAll(r.Body)
if err != nil {
log.L.Errorf("Failed to read prefetch list: %v", err)
return
}
if err = prefetch.Pm.SetPrefetchFiles(body); err != nil {
log.L.Errorf("Failed to parse request body: %v", err)
return
}
}
}
func (sc *Controller) describeDaemons() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
info := make([]daemonInfo, 0, 10)
for _, manager := range sc.managers {
daemons := manager.ListDaemons()
for _, d := range daemons {
instances := make(map[string]rafsInstanceInfo)
for _, i := range d.RafsCache.List() {
instances[i.SnapshotID] = rafsInstanceInfo{
SnapshotID: i.SnapshotID,
SnapshotDir: i.SnapshotDir,
Mountpoint: i.GetMountpoint(),
ImageID: i.ImageID,
}
}
memRSS, err := metrics.GetProcessMemoryRSSKiloBytes(d.Pid())
if err != nil {
log.L.Warnf("Failed to get daemon %s RSS memory", d.ID())
}
var readData float32
fsMetrics, err := d.GetFsMetrics("")
if err != nil {
log.L.Warnf("Failed to get file system metrics")
} else {
readData = float32(fsMetrics.DataRead) / 1024
}
i := daemonInfo{
ID: d.ID(),
Pid: d.Pid(),
HostMountpoint: d.HostMountpoint(),
Reference: int(d.GetRef()),
Instances: instances,
StartupCPUUtilization: d.StartupCPUUtilization,
MemoryRSS: memRSS,
ReadData: readData,
}
info = append(info, i)
}
}
jsonResponse(w, &info)
}
}
// TODO: Implement me!
func (sc *Controller) getDaemonRecords() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
m := newErrorMessage("not implemented")
http.Error(w, m.encode(), http.StatusNotImplemented)
}
}
// PUT /api/v1/nydusd/upgrade
// body: {"nydusd_path": "/path/to/new/nydusd", "version": "v2.2.1", "policy": "rolling"}
// Possible policy: rolling, immediate
// Live upgrade procedure:
// 1. Check if new version of nydusd executive is existed.
// 2. Validate its version matching `version` in this request.
// 3. Upgrade one nydusd:
// a. Lock the whole manager daemons cache, no daemon can be inserted of deleted from manager
// b. Start a new nydusd with `--upgrade` flag, wait until it reaches INTI state
// c. Validate the new nydusd's version returned by API /daemon
// d. Send resources like FD and daemon running states to the new nydusd by API /takeover
// e. Wait until new nydusd reaches state READY
// f. Command the old nydusd to exit
// g. Send API /start to the new nydusd making it take over the whole file system service
//
// 4. Upgrade next nydusd like step 3.
// 5. If upgrading a certain nydusd fails, abort!
// 6. Delete the old nydusd executive
func (sc *Controller) upgradeDaemons() func(w http.ResponseWriter, r *http.Request) {
return func(w http.ResponseWriter, r *http.Request) {
var c upgradeRequest
var err error
var statusCode int
defer func() {
if err != nil {
m := newErrorMessage(err.Error())
http.Error(w, m.encode(), statusCode)
}
}()
err = json.NewDecoder(r.Body).Decode(&c)
if err != nil {
log.L.Errorf("request %v, decode error %s", r, err)
statusCode = http.StatusBadRequest
return
}
for _, manager := range sc.managers {
manager.Lock()
defer manager.Unlock()
daemons := manager.ListDaemons()
// TODO: Keep the nydusd executive path in Daemon state and persis it since nydusd
// can run on both versions.
// Create a dedicated directory storing nydusd of various versions?
// TODO: daemon client has a method to query daemon version and information.
for _, d := range daemons {
err = sc.upgradeNydusDaemon(d, c, manager)
if err != nil {
log.L.Errorf("Upgrade daemon %s failed, %s", d.ID(), err)
statusCode = http.StatusInternalServerError
return
}
}
// TODO: why renaming?
err = os.Rename(c.NydusdPath, manager.NydusdBinaryPath)
if err != nil {
log.L.Errorf("Rename nydusd binary from %s to %s failed, %v",
c.NydusdPath, manager.NydusdBinaryPath, err)
statusCode = http.StatusInternalServerError
return
}
}
}
}
// Provide minimal parameters since most of it can be recovered by nydusd states.
// Create a new daemon in Manger to take over the service.
func (sc *Controller) upgradeNydusDaemon(d *daemon.Daemon, c upgradeRequest, manager *manager.Manager) error {
log.L.Infof("Upgrading nydusd %s, request %v", d.ID(), c)
fs := sc.fs
var new daemon.Daemon
new.States = d.States
new.Supervisor = d.Supervisor
new.CloneRafsInstances(d)
s := path.Base(d.GetAPISock())
next, err := buildNextAPISocket(s)
if err != nil {
return err
}
upgradingSocket := path.Join(path.Dir(d.GetAPISock()), next)
new.States.APISocket = upgradingSocket
cmd, err := manager.BuildDaemonCommand(&new, c.NydusdPath, true)
if err != nil {
return err
}
su := manager.SupervisorSet.GetSupervisor(d.ID())
if err := su.SendStatesTimeout(time.Second * 10); err != nil {
return errors.Wrap(err, "Send states")
}
if err := cmd.Start(); err != nil {
return errors.Wrap(err, "start process")
}
if err := new.WaitUntilState(types.DaemonStateInit); err != nil {
return errors.Wrap(err, "wait until init state")
}
if err := new.TakeOver(); err != nil {
return errors.Wrap(err, "take over resources")
}
if err := new.WaitUntilState(types.DaemonStateReady); err != nil {
return errors.Wrap(err, "wait unit ready state")
}
if err := manager.UnsubscribeDaemonEvent(d); err != nil {
return errors.Wrap(err, "unsubscribe daemon event")
}
// Let the older daemon exit without umount
if err := d.Exit(); err != nil {
return errors.Wrap(err, "old daemon exits")
}
fs.TryRetainSharedDaemon(&new)
if err := new.Start(); err != nil {
return errors.Wrap(err, "start file system service")
}
if err := manager.SubscribeDaemonEvent(&new); err != nil {
return &json.InvalidUnmarshalError{}
}
log.L.Infof("Started service of upgraded daemon on socket %s", new.GetAPISock())
if err := manager.UpdateDaemonLocked(&new); err != nil {
return err
}
log.L.Infof("Upgraded daemon success on socket %s", new.GetAPISock())
return nil
}
// Name next api socket path based on currently api socket path listened on.
// The principle is to add a suffix number to api[0-9]+.sock
func buildNextAPISocket(cur string) (string, error) {
n := strings.Split(cur, ".")
if len(n) != 2 {
return "", errdefs.ErrInvalidArgument
}
r := regexp.MustCompile(`[0-9]+`)
m := r.Find([]byte(n[0]))
var num int
if m == nil {
num = 1
} else {
var err error
num, err = strconv.Atoi(string(m))
if err != nil {
return "", err
}
num++
}
nextSocket := fmt.Sprintf("api%d.sock", num)
return nextSocket, nil
}
|