Skip to content

Commit 5debeaf

Browse files
wkingwking
committed
config-windows: Transition from Markdown to AsciiDoc
Signed-off-by: W. Trevor King <[email protected]>
1 parent 24ac5ee commit 5debeaf

File tree

4 files changed

+89
-64
lines changed

4 files changed

+89
-64
lines changed

‎config-windows.asc‎

Lines changed: 84 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,122 @@
1-
# Windows-specific Container Configuration
1+
[[config-windows]]
2+
Windows-specific Container Configuration
3+
----------------------------------------
24

3-
This document describes the schema for the [Windows-specific section](config.md#platform-specific-configuration) of the [container configuration](config.md).
45
The Windows container specification uses APIs provided by the Windows Host Compute Service (HCS) to fulfill the spec.
56

6-
## Resources
7+
Resources
8+
~~~~~~~~~
79

810
You can configure a container's resource limits via the OPTIONAL `resources` field of the Windows configuration.
911

10-
### Memory
12+
Memory
13+
^^^^^^
1114

1215
`memory` is an OPTIONAL configuration for the container's memory usage.
1316

1417
The following parameters can be specified:
1518

16-
* **`limit`** *(uint64, OPTIONAL)* - sets limit of memory usage in bytes.
17-
18-
* **`reservation`** *(uint64, OPTIONAL)* - sets the guaranteed minimum amount of memory for a container in bytes.
19-
20-
#### Example
21-
22-
```json
23-
"windows": {
24-
"resources": {
25-
"memory": {
26-
"limit": 2097152,
27-
"reservation": 524288
28-
}
29-
}
19+
`limit`::
20+
(uint64, OPTIONAL) - sets limit of memory usage in bytes.
21+
22+
`reservation`::
23+
(uint64, OPTIONAL) - sets the guaranteed minimum amount of memory for a container in bytes.
24+
25+
[[windows-resources-memory-example]]
26+
.Example
27+
[source,json]
28+
{
29+
"windows": {
30+
"resources": {
31+
"memory": {
32+
"limit": 2097152,
33+
"reservation": 524288
34+
}
3035
}
31-
```
36+
},
37+
…
38+
}
3239

33-
### CPU
40+
CPU
41+
^^^
3442

3543
`cpu` is an OPTIONAL configuration for the container's CPU usage.
3644

3745
The following parameters can be specified:
3846

39-
* **`count`** *(uint64, OPTIONAL)* - specifies the number of CPUs available to the container.
40-
41-
* **`shares`** *(uint16, OPTIONAL)* - specifies the relative weight to other containers with CPU shares. The range is from 1 to 10000.
47+
`count`::
48+
(uint64, OPTIONAL) - specifies the number of CPUs available to the container.
4249

43-
* **`percent`** *(uint, OPTIONAL)* - specifies the percentage of available CPUs usable by the container.
50+
`shares`::
51+
(uint16, OPTIONAL) - specifies the relative weight to other containers with CPU shares. The range is from 1 to 10000.
4452

45-
#### Example
53+
`percent`::
54+
(uint, OPTIONAL) - specifies the percentage of available CPUs usable by the container.
4655

47-
```json
48-
"windows": {
49-
"resources": {
50-
"cpu": {
51-
"percent": 50
52-
}
53-
}
56+
[[windows-resources-cpu-example]]
57+
.Example
58+
[source,json]
59+
{
60+
"windows": {
61+
"resources": {
62+
"cpu": {
63+
"percent": 50
64+
}
5465
}
55-
```
66+
},
67+
…
68+
}
5669

57-
### Storage
70+
Storage
71+
^^^^^^^
5872

5973
`storage` is an OPTIONAL configuration for the container's storage usage.
6074

6175
The following parameters can be specified:
6276

63-
* **`iops`** *(uint64, OPTIONAL)* - specifies the maximum IO operations per second for the system drive of the container.
77+
`iops`::
78+
(uint64, OPTIONAL) - specifies the maximum IO operations per second for the system drive of the container.
6479

65-
* **`bps`** *(uint64, OPTIONAL)* - specifies the maximum bytes per second for the system drive of the container.
80+
`bps`::
81+
(uint64, OPTIONAL) - specifies the maximum bytes per second for the system drive of the container.
6682

67-
* **`sandboxSize`** *(uint64, OPTIONAL)* - specifies the minimum size of the system drive in bytes.
83+
`sandboxSize`::
84+
(uint64, OPTIONAL) - specifies the minimum size of the system drive in bytes.
6885

69-
#### Example
70-
71-
```json
72-
"windows": {
73-
"resources": {
74-
"storage": {
75-
"iops": 50
76-
}
77-
}
86+
[[windows-resources-storage-example]]
87+
.Example
88+
[source,json]
89+
{
90+
"windows": {
91+
"resources": {
92+
"storage": {
93+
"iops": 50
94+
}
7895
}
79-
```
96+
},
97+
…
98+
}
8099

81-
### Network
100+
Network
101+
^^^^^^^
82102

83103
`network` is an OPTIONAL configuration for the container's network usage.
84104

85105
The following parameters can be specified:
86106

87-
* **`egressBandwidth`** *(uint64, OPTIONAL)* - specified the maximum egress bandwidth in bytes per second for the container.
88-
89-
#### Example
90-
91-
```json
92-
"windows": {
93-
"resources": {
94-
"network": {
95-
"egressBandwidth": 1048577
96-
}
97-
}
98-
}
99-
```
107+
`egressBandwidth`::
108+
(uint64, OPTIONAL) - specified the maximum egress bandwidth in bytes per second for the container.
109+
110+
[[windows-resources-network-example]]
111+
.Example
112+
[source,json]
113+
{
114+
"windows": {
115+
"resources": {
116+
"network": {
117+
"egressBandwidth": 1048577
118+
}
119+
}
120+
},
121+
…
122+
}

‎config.asc‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ The following properties can be specified:
405405
This SHOULD only be set if `platform.os` is `solaris`.
406406

407407
`windows`::
408-
(object, OPTIONAL) `<<config-windows>`.
408+
(object, OPTIONAL) <<config-windows>.
409409
This SHOULD only be set if `platform.os` is `windows`.
410410

411411
[[platform-linux-example]]
@@ -432,6 +432,8 @@ include::config-linux.asc[]
432432

433433
include::config-solaris.asc[]
434434

435+
include::config-windows.asc[]
436+
435437
:leveloffset: 0
436438

437439
[[hooks]]

‎protocols.asc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Protocols defined by this specification are:
55

66
* Linux containers: <<runtime>>, <<runtime-linux>>, <<config>>, and <<config-linux>>.
77
* Solaris containers: <<runtime>>, <<config>>, and <<config-solaris>>.
8-
* Windows containers: <<runtime>>, <<config>>, and `<<config-windows>>`.
8+
* Windows containers: <<runtime>>, <<config>>, and <<config-windows>>.

‎schema/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ The layout of the files is as follows:
99
* [config-schema.json](config-schema.json) - the primary entrypoint for the [configuration](../config.asc) schema
1010
* [config-linux.json](config-linux.json) - the [Linux-specific configuration sub-structure](../config-linux.asc)
1111
* [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.asc)
12-
* [config-windows.json](config-windows.json) - the [Windows-specific configuration sub-structure](../config-windows.md)
12+
* [config-windows.json](config-windows.json) - the [Windows-specific configuration sub-structure](../config-windows.asc)
1313
* [state-schema.json](state-schema.json) - the primary entrypoint for the [state JSON](../runtime.asc#state) schema
1414
* [defs.json](defs.json) - definitions for general types
1515
* [defs-linux.json](defs-linux.json) - definitions for Linux-specific types

0 commit comments

Comments
 (0)