Browse code

api/docs: remove KernelMemory option from old API versions

This option is no longer supported by runc, and is deprecated in the kernel.
We removed support for this feature from all API versions, so it's better
to also amend the docs for older API versions.

[kernel v5.4]: https://github.com/torvalds/linux/commit/0158115f702b0ba208ab0

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>

Sebastiaan van Stijn authored on 2025/09/16 20:26:13
Showing 14 changed files
... ...
@@ -310,7 +310,6 @@ Create a container
310 310
              "Memory": 0,
311 311
              "MemorySwap": 0,
312 312
              "MemoryReservation": 0,
313
-             "KernelMemory": 0,
314 313
              "CpuPercent": 80,
315 314
              "CpuShares": 512,
316 315
              "CpuPeriod": 100000,
... ...
@@ -438,7 +437,6 @@ Create a container
438 438
     -   **MemorySwap** - Total memory limit (memory + swap); set `-1` to enable unlimited swap.
439 439
           You must use this with `memory` and make the swap value larger than `memory`.
440 440
     -   **MemoryReservation** - Memory soft limit in bytes.
441
-    -   **KernelMemory** - Kernel memory limit in bytes.
442 441
     -   **CpuPercent** - An integer value containing the usable percentage of the available CPUs. (Windows daemon only)
443 442
     -   **CpuShares** - An integer value containing the container's CPU Shares
444 443
           (ie. the relative weight vs other containers).
... ...
@@ -627,7 +625,6 @@ Return low-level information on the container `id`
627 627
 			"Memory": 0,
628 628
 			"MemorySwap": 0,
629 629
 			"MemoryReservation": 0,
630
-			"KernelMemory": 0,
631 630
 			"OomKillDisable": false,
632 631
 			"OomScoreAdj": 500,
633 632
 			"NetworkMode": "bridge",
... ...
@@ -1197,7 +1194,6 @@ Update configuration of one or more containers.
1197 1197
          "Memory": 314572800,
1198 1198
          "MemorySwap": 514288000,
1199 1199
          "MemoryReservation": 209715200,
1200
-         "KernelMemory": 52428800,
1201 1200
          "RestartPolicy": {
1202 1201
            "MaximumRetryCount": 4,
1203 1202
            "Name": "on-failure"
... ...
@@ -432,10 +432,6 @@ definitions:
432 432
         description: "Disk limit (in bytes)."
433 433
         type: "integer"
434 434
         format: "int64"
435
-      KernelMemory:
436
-        description: "Kernel memory limit in bytes."
437
-        type: "integer"
438
-        format: "int64"
439 435
       MemoryReservation:
440 436
         description: "Memory soft limit in bytes."
441 437
         type: "integer"
... ...
@@ -2717,7 +2713,6 @@ paths:
2717 2717
                 Memory: 0
2718 2718
                 MemorySwap: 0
2719 2719
                 MemoryReservation: 0
2720
-                KernelMemory: 0
2721 2720
                 NanoCpus: 500000
2722 2721
                 CpuPercent: 80
2723 2722
                 CpuShares: 512
... ...
@@ -3017,7 +3012,6 @@ paths:
3017 3017
                 Memory: 0
3018 3018
                 MemorySwap: 0
3019 3019
                 MemoryReservation: 0
3020
-                KernelMemory: 0
3021 3020
                 OomKillDisable: false
3022 3021
                 OomScoreAdj: 500
3023 3022
                 NetworkMode: "bridge"
... ...
@@ -3698,7 +3692,6 @@ paths:
3698 3698
               Memory: 314572800
3699 3699
               MemorySwap: 514288000
3700 3700
               MemoryReservation: 209715200
3701
-              KernelMemory: 52428800
3702 3701
               RestartPolicy:
3703 3702
                 MaximumRetryCount: 4
3704 3703
                 Name: "on-failure"
... ...
@@ -5105,7 +5098,6 @@ paths:
5105 5105
               IndexServerAddress: "https://index.docker.io/v1/"
5106 5106
               InitPath: "/usr/bin/docker"
5107 5107
               InitSha1: ""
5108
-              KernelMemory: true
5109 5108
               KernelVersion: "3.12.0-1-amd64"
5110 5109
               Labels:
5111 5110
                 - "storage=ssd"
... ...
@@ -432,10 +432,6 @@ definitions:
432 432
         description: "Disk limit (in bytes)."
433 433
         type: "integer"
434 434
         format: "int64"
435
-      KernelMemory:
436
-        description: "Kernel memory limit in bytes."
437
-        type: "integer"
438
-        format: "int64"
439 435
       MemoryReservation:
440 436
         description: "Memory soft limit in bytes."
441 437
         type: "integer"
... ...
@@ -2721,7 +2717,6 @@ paths:
2721 2721
                 Memory: 0
2722 2722
                 MemorySwap: 0
2723 2723
                 MemoryReservation: 0
2724
-                KernelMemory: 0
2725 2724
                 NanoCpus: 500000
2726 2725
                 CpuPercent: 80
2727 2726
                 CpuShares: 512
... ...
@@ -434,10 +434,6 @@ definitions:
434 434
         description: "Disk limit (in bytes)."
435 435
         type: "integer"
436 436
         format: "int64"
437
-      KernelMemory:
438
-        description: "Kernel memory limit in bytes."
439
-        type: "integer"
440
-        format: "int64"
441 437
       MemoryReservation:
442 438
         description: "Memory soft limit in bytes."
443 439
         type: "integer"
... ...
@@ -2780,7 +2776,6 @@ paths:
2780 2780
                 Memory: 0
2781 2781
                 MemorySwap: 0
2782 2782
                 MemoryReservation: 0
2783
-                KernelMemory: 0
2784 2783
                 NanoCpus: 500000
2785 2784
                 CpuPercent: 80
2786 2785
                 CpuShares: 512
... ...
@@ -3080,7 +3075,6 @@ paths:
3080 3080
                 Memory: 0
3081 3081
                 MemorySwap: 0
3082 3082
                 MemoryReservation: 0
3083
-                KernelMemory: 0
3084 3083
                 OomKillDisable: false
3085 3084
                 OomScoreAdj: 500
3086 3085
                 NetworkMode: "bridge"
... ...
@@ -440,10 +440,6 @@ definitions:
440 440
         description: "Disk limit (in bytes)."
441 441
         type: "integer"
442 442
         format: "int64"
443
-      KernelMemory:
444
-        description: "Kernel memory limit in bytes."
445
-        type: "integer"
446
-        format: "int64"
447 443
       MemoryReservation:
448 444
         description: "Memory soft limit in bytes."
449 445
         type: "integer"
... ...
@@ -2869,7 +2865,6 @@ paths:
2869 2869
                 Memory: 0
2870 2870
                 MemorySwap: 0
2871 2871
                 MemoryReservation: 0
2872
-                KernelMemory: 0
2873 2872
                 NanoCpus: 500000
2874 2873
                 CpuPercent: 80
2875 2874
                 CpuShares: 512
... ...
@@ -3169,7 +3164,6 @@ paths:
3169 3169
                 Memory: 0
3170 3170
                 MemorySwap: 0
3171 3171
                 MemoryReservation: 0
3172
-                KernelMemory: 0
3173 3172
                 OomKillDisable: false
3174 3173
                 OomScoreAdj: 500
3175 3174
                 NetworkMode: "bridge"
... ...
@@ -3860,7 +3854,6 @@ paths:
3860 3860
               Memory: 314572800
3861 3861
               MemorySwap: 514288000
3862 3862
               MemoryReservation: 209715200
3863
-              KernelMemory: 52428800
3864 3863
               RestartPolicy:
3865 3864
                 MaximumRetryCount: 4
3866 3865
                 Name: "on-failure"
... ...
@@ -5292,7 +5285,6 @@ paths:
5292 5292
               IndexServerAddress: "https://index.docker.io/v1/"
5293 5293
               InitPath: "/usr/bin/docker"
5294 5294
               InitSha1: ""
5295
-              KernelMemory: true
5296 5295
               KernelVersion: "3.12.0-1-amd64"
5297 5296
               Labels:
5298 5297
                 - "storage=ssd"
... ...
@@ -443,10 +443,6 @@ definitions:
443 443
         description: "Disk limit (in bytes)."
444 444
         type: "integer"
445 445
         format: "int64"
446
-      KernelMemory:
447
-        description: "Kernel memory limit in bytes."
448
-        type: "integer"
449
-        format: "int64"
450 446
       MemoryReservation:
451 447
         description: "Memory soft limit in bytes."
452 448
         type: "integer"
... ...
@@ -2902,7 +2898,6 @@ paths:
2902 2902
                 Memory: 0
2903 2903
                 MemorySwap: 0
2904 2904
                 MemoryReservation: 0
2905
-                KernelMemory: 0
2906 2905
                 NanoCpus: 500000
2907 2906
                 CpuPercent: 80
2908 2907
                 CpuShares: 512
... ...
@@ -3202,7 +3197,6 @@ paths:
3202 3202
                 Memory: 0
3203 3203
                 MemorySwap: 0
3204 3204
                 MemoryReservation: 0
3205
-                KernelMemory: 0
3206 3205
                 OomKillDisable: false
3207 3206
                 OomScoreAdj: 500
3208 3207
                 NetworkMode: "bridge"
... ...
@@ -3893,7 +3887,6 @@ paths:
3893 3893
               Memory: 314572800
3894 3894
               MemorySwap: 514288000
3895 3895
               MemoryReservation: 209715200
3896
-              KernelMemory: 52428800
3897 3896
               RestartPolicy:
3898 3897
                 MaximumRetryCount: 4
3899 3898
                 Name: "on-failure"
... ...
@@ -5325,7 +5318,6 @@ paths:
5325 5325
               IndexServerAddress: "https://index.docker.io/v1/"
5326 5326
               InitPath: "/usr/bin/docker"
5327 5327
               InitSha1: ""
5328
-              KernelMemory: true
5329 5328
               KernelVersion: "3.12.0-1-amd64"
5330 5329
               Labels:
5331 5330
                 - "storage=ssd"
... ...
@@ -445,10 +445,6 @@ definitions:
445 445
         description: "Disk limit (in bytes)."
446 446
         type: "integer"
447 447
         format: "int64"
448
-      KernelMemory:
449
-        description: "Kernel memory limit in bytes."
450
-        type: "integer"
451
-        format: "int64"
452 448
       MemoryReservation:
453 449
         description: "Memory soft limit in bytes."
454 450
         type: "integer"
... ...
@@ -3115,7 +3111,6 @@ paths:
3115 3115
                 Memory: 0
3116 3116
                 MemorySwap: 0
3117 3117
                 MemoryReservation: 0
3118
-                KernelMemory: 0
3119 3118
                 NanoCpus: 500000
3120 3119
                 CpuPercent: 80
3121 3120
                 CpuShares: 512
... ...
@@ -445,10 +445,6 @@ definitions:
445 445
         description: "Disk limit (in bytes)."
446 446
         type: "integer"
447 447
         format: "int64"
448
-      KernelMemory:
449
-        description: "Kernel memory limit in bytes."
450
-        type: "integer"
451
-        format: "int64"
452 448
       MemoryReservation:
453 449
         description: "Memory soft limit in bytes."
454 450
         type: "integer"
... ...
@@ -3188,7 +3184,6 @@ paths:
3188 3188
                 Memory: 0
3189 3189
                 MemorySwap: 0
3190 3190
                 MemoryReservation: 0
3191
-                KernelMemory: 0
3192 3191
                 NanoCpus: 500000
3193 3192
                 CpuPercent: 80
3194 3193
                 CpuShares: 512
... ...
@@ -449,10 +449,6 @@ definitions:
449 449
         description: "Disk limit (in bytes)."
450 450
         type: "integer"
451 451
         format: "int64"
452
-      KernelMemory:
453
-        description: "Kernel memory limit in bytes."
454
-        type: "integer"
455
-        format: "int64"
456 452
       MemoryReservation:
457 453
         description: "Memory soft limit in bytes."
458 454
         type: "integer"
... ...
@@ -3523,10 +3519,6 @@ definitions:
3523 3523
         description: "Indicates if the host has memory swap limit support enabled."
3524 3524
         type: "boolean"
3525 3525
         example: true
3526
-      KernelMemory:
3527
-        description: "Indicates if the host has kernel memory limit support enabled."
3528
-        type: "boolean"
3529
-        example: true
3530 3526
       CpuCfsPeriod:
3531 3527
         description: "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host."
3532 3528
         type: "boolean"
... ...
@@ -4400,7 +4392,6 @@ paths:
4400 4400
                 Memory: 0
4401 4401
                 MemorySwap: 0
4402 4402
                 MemoryReservation: 0
4403
-                KernelMemory: 0
4404 4403
                 NanoCpus: 500000
4405 4404
                 CpuPercent: 80
4406 4405
                 CpuShares: 512
... ...
@@ -4708,7 +4699,6 @@ paths:
4708 4708
                 Memory: 0
4709 4709
                 MemorySwap: 0
4710 4710
                 MemoryReservation: 0
4711
-                KernelMemory: 0
4712 4711
                 OomKillDisable: false
4713 4712
                 OomScoreAdj: 500
4714 4713
                 NetworkMode: "bridge"
... ...
@@ -5397,7 +5387,6 @@ paths:
5397 5397
               Memory: 314572800
5398 5398
               MemorySwap: 514288000
5399 5399
               MemoryReservation: 209715200
5400
-              KernelMemory: 52428800
5401 5400
               RestartPolicy:
5402 5401
                 MaximumRetryCount: 4
5403 5402
                 Name: "on-failure"
... ...
@@ -453,10 +453,6 @@ definitions:
453 453
         description: "Disk limit (in bytes)."
454 454
         type: "integer"
455 455
         format: "int64"
456
-      KernelMemory:
457
-        description: "Kernel memory limit in bytes."
458
-        type: "integer"
459
-        format: "int64"
460 456
       MemoryReservation:
461 457
         description: "Memory soft limit in bytes."
462 458
         type: "integer"
... ...
@@ -3527,10 +3523,6 @@ definitions:
3527 3527
         description: "Indicates if the host has memory swap limit support enabled."
3528 3528
         type: "boolean"
3529 3529
         example: true
3530
-      KernelMemory:
3531
-        description: "Indicates if the host has kernel memory limit support enabled."
3532
-        type: "boolean"
3533
-        example: true
3534 3530
       CpuCfsPeriod:
3535 3531
         description: "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host."
3536 3532
         type: "boolean"
... ...
@@ -4404,7 +4396,6 @@ paths:
4404 4404
                 Memory: 0
4405 4405
                 MemorySwap: 0
4406 4406
                 MemoryReservation: 0
4407
-                KernelMemory: 0
4408 4407
                 NanoCpus: 500000
4409 4408
                 CpuPercent: 80
4410 4409
                 CpuShares: 512
... ...
@@ -4712,7 +4703,6 @@ paths:
4712 4712
                 Memory: 0
4713 4713
                 MemorySwap: 0
4714 4714
                 MemoryReservation: 0
4715
-                KernelMemory: 0
4716 4715
                 OomKillDisable: false
4717 4716
                 OomScoreAdj: 500
4718 4717
                 NetworkMode: "bridge"
... ...
@@ -5401,7 +5391,6 @@ paths:
5401 5401
               Memory: 314572800
5402 5402
               MemorySwap: 514288000
5403 5403
               MemoryReservation: 209715200
5404
-              KernelMemory: 52428800
5405 5404
               RestartPolicy:
5406 5405
                 MaximumRetryCount: 4
5407 5406
                 Name: "on-failure"
... ...
@@ -455,10 +455,6 @@ definitions:
455 455
         description: "Disk limit (in bytes)."
456 456
         type: "integer"
457 457
         format: "int64"
458
-      KernelMemory:
459
-        description: "Kernel memory limit in bytes."
460
-        type: "integer"
461
-        format: "int64"
462 458
       MemoryReservation:
463 459
         description: "Memory soft limit in bytes."
464 460
         type: "integer"
... ...
@@ -3555,10 +3551,6 @@ definitions:
3555 3555
         description: "Indicates if the host has memory swap limit support enabled."
3556 3556
         type: "boolean"
3557 3557
         example: true
3558
-      KernelMemory:
3559
-        description: "Indicates if the host has kernel memory limit support enabled."
3560
-        type: "boolean"
3561
-        example: true
3562 3558
       CpuCfsPeriod:
3563 3559
         description: "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host."
3564 3560
         type: "boolean"
... ...
@@ -4432,7 +4424,6 @@ paths:
4432 4432
                 Memory: 0
4433 4433
                 MemorySwap: 0
4434 4434
                 MemoryReservation: 0
4435
-                KernelMemory: 0
4436 4435
                 NanoCpus: 500000
4437 4436
                 CpuPercent: 80
4438 4437
                 CpuShares: 512
... ...
@@ -4740,7 +4731,6 @@ paths:
4740 4740
                 Memory: 0
4741 4741
                 MemorySwap: 0
4742 4742
                 MemoryReservation: 0
4743
-                KernelMemory: 0
4744 4743
                 OomKillDisable: false
4745 4744
                 OomScoreAdj: 500
4746 4745
                 NetworkMode: "bridge"
... ...
@@ -5429,7 +5419,6 @@ paths:
5429 5429
               Memory: 314572800
5430 5430
               MemorySwap: 514288000
5431 5431
               MemoryReservation: 209715200
5432
-              KernelMemory: 52428800
5433 5432
               RestartPolicy:
5434 5433
                 MaximumRetryCount: 4
5435 5434
                 Name: "on-failure"
... ...
@@ -466,10 +466,6 @@ definitions:
466 466
         description: "Disk limit (in bytes)."
467 467
         type: "integer"
468 468
         format: "int64"
469
-      KernelMemory:
470
-        description: "Kernel memory limit in bytes."
471
-        type: "integer"
472
-        format: "int64"
473 469
       MemoryReservation:
474 470
         description: "Memory soft limit in bytes."
475 471
         type: "integer"
... ...
@@ -3559,10 +3555,6 @@ definitions:
3559 3559
         description: "Indicates if the host has memory swap limit support enabled."
3560 3560
         type: "boolean"
3561 3561
         example: true
3562
-      KernelMemory:
3563
-        description: "Indicates if the host has kernel memory limit support enabled."
3564
-        type: "boolean"
3565
-        example: true
3566 3562
       CpuCfsPeriod:
3567 3563
         description: "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host."
3568 3564
         type: "boolean"
... ...
@@ -4436,7 +4428,6 @@ paths:
4436 4436
                 Memory: 0
4437 4437
                 MemorySwap: 0
4438 4438
                 MemoryReservation: 0
4439
-                KernelMemory: 0
4440 4439
                 NanoCpus: 500000
4441 4440
                 CpuPercent: 80
4442 4441
                 CpuShares: 512
... ...
@@ -4744,7 +4735,6 @@ paths:
4744 4744
                 Memory: 0
4745 4745
                 MemorySwap: 0
4746 4746
                 MemoryReservation: 0
4747
-                KernelMemory: 0
4748 4747
                 OomKillDisable: false
4749 4748
                 OomScoreAdj: 500
4750 4749
                 NetworkMode: "bridge"
... ...
@@ -5438,7 +5428,6 @@ paths:
5438 5438
               Memory: 314572800
5439 5439
               MemorySwap: 514288000
5440 5440
               MemoryReservation: 209715200
5441
-              KernelMemory: 52428800
5442 5441
               RestartPolicy:
5443 5442
                 MaximumRetryCount: 4
5444 5443
                 Name: "on-failure"
... ...
@@ -467,10 +467,6 @@ definitions:
467 467
         description: "Disk limit (in bytes)."
468 468
         type: "integer"
469 469
         format: "int64"
470
-      KernelMemory:
471
-        description: "Kernel memory limit in bytes."
472
-        type: "integer"
473
-        format: "int64"
474 470
       MemoryReservation:
475 471
         description: "Memory soft limit in bytes."
476 472
         type: "integer"
... ...
@@ -3646,10 +3642,6 @@ definitions:
3646 3646
         description: "Indicates if the host has memory swap limit support enabled."
3647 3647
         type: "boolean"
3648 3648
         example: true
3649
-      KernelMemory:
3650
-        description: "Indicates if the host has kernel memory limit support enabled."
3651
-        type: "boolean"
3652
-        example: true
3653 3649
       CpuCfsPeriod:
3654 3650
         description: "Indicates if CPU CFS(Completely Fair Scheduler) period is supported by the host."
3655 3651
         type: "boolean"
... ...
@@ -4523,7 +4515,6 @@ paths:
4523 4523
                 Memory: 0
4524 4524
                 MemorySwap: 0
4525 4525
                 MemoryReservation: 0
4526
-                KernelMemory: 0
4527 4526
                 NanoCpus: 500000
4528 4527
                 CpuPercent: 80
4529 4528
                 CpuShares: 512
... ...
@@ -4841,7 +4832,6 @@ paths:
4841 4841
                 Memory: 0
4842 4842
                 MemorySwap: 0
4843 4843
                 MemoryReservation: 0
4844
-                KernelMemory: 0
4845 4844
                 OomKillDisable: false
4846 4845
                 OomScoreAdj: 500
4847 4846
                 NetworkMode: "bridge"
... ...
@@ -5548,7 +5538,6 @@ paths:
5548 5548
               Memory: 314572800
5549 5549
               MemorySwap: 514288000
5550 5550
               MemoryReservation: 209715200
5551
-              KernelMemory: 52428800
5552 5551
               RestartPolicy:
5553 5552
                 MaximumRetryCount: 4
5554 5553
                 Name: "on-failure"
... ...
@@ -530,11 +530,6 @@ definitions:
530 530
         description: "Disk limit (in bytes)."
531 531
         type: "integer"
532 532
         format: "int64"
533
-      KernelMemory:
534
-        description: "Kernel memory limit in bytes."
535
-        type: "integer"
536
-        format: "int64"
537
-        example: 209715200
538 533
       MemoryReservation:
539 534
         description: "Memory soft limit in bytes."
540 535
         type: "integer"
... ...
@@ -4894,10 +4889,6 @@ definitions:
4894 4894
         description: "Indicates if the host has memory swap limit support enabled."
4895 4895
         type: "boolean"
4896 4896
         example: true
4897
-      KernelMemory:
4898
-        description: "Indicates if the host has kernel memory limit support enabled."
4899
-        type: "boolean"
4900
-        example: true
4901 4897
       CpuCfsPeriod:
4902 4898
         description: |
4903 4899
           Indicates if CPU CFS(Completely Fair Scheduler) period is supported by
... ...
@@ -5828,7 +5819,6 @@ paths:
5828 5828
                 Memory: 0
5829 5829
                 MemorySwap: 0
5830 5830
                 MemoryReservation: 0
5831
-                KernelMemory: 0
5832 5831
                 NanoCpus: 500000
5833 5832
                 CpuPercent: 80
5834 5833
                 CpuShares: 512
... ...
@@ -6102,7 +6092,6 @@ paths:
6102 6102
                 Memory: 0
6103 6103
                 MemorySwap: 0
6104 6104
                 MemoryReservation: 0
6105
-                KernelMemory: 0
6106 6105
                 OomKillDisable: false
6107 6106
                 OomScoreAdj: 500
6108 6107
                 NetworkMode: "bridge"
... ...
@@ -6840,7 +6829,6 @@ paths:
6840 6840
               Memory: 314572800
6841 6841
               MemorySwap: 514288000
6842 6842
               MemoryReservation: 209715200
6843
-              KernelMemory: 52428800
6844 6843
               RestartPolicy:
6845 6844
                 MaximumRetryCount: 4
6846 6845
                 Name: "on-failure"