Skip to content

Commit dcaa23e

Browse files
committed
config-solaris: Transition from Markdown to AsciiDoc
Signed-off-by: W. Trevor King <[email protected]>
1 parent 2aae05e commit dcaa23e

File tree

4 files changed

+135
-68
lines changed

4 files changed

+135
-68
lines changed

config-solaris.asc

Lines changed: 130 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,122 @@
1-
# Solaris Application Container Configuration
1+
[[config-solaris]]
2+
Solaris-specific Container Configuration
3+
----------------------------------------
24

35
Solaris application containers can be configured using the following properties, all of the below properties have mappings to properties specified under zonecfg(8) man page, except milestone.
46

5-
## milestone
7+
milestone
8+
~~~~~~~~~
9+
610
The SMF(Service Management Facility) FMRI which should go to "online" state before we start the desired process within the container.
711

8-
**`milestone`** *(string, OPTIONAL)*
12+
`milestone`::
13+
(string, OPTIONAL)
14+
15+
[[solaris-milestone-example]]
16+
.Example
17+
[source,json]
18+
{
19+
"solaris": {
20+
"milestone": "svc:/milestone/container:default"
21+
},
22+
23+
}
924

10-
### Example
11-
```json
12-
"milestone": "svc:/milestone/container:default"
13-
```
25+
limitpriv
26+
~~~~~~~~~
1427

15-
## limitpriv
1628
The maximum set of privileges any process in this container can obtain.
17-
The property should consist of a comma-separated privilege set specification as described in priv_str_to_set(3C) man page for the respective release of Solaris.
18-
19-
**`limitpriv`** *(string, OPTIONAL)*
29+
The property should consist of a comma-separated privilege set specification as described in `priv_str_to_set(3C)` man page for the respective release of Solaris.
30+
31+
`limitpriv`::
32+
(string, OPTIONAL)
33+
34+
[[solaris-limitpriv-example]]
35+
.Example
36+
[source,json]
37+
{
38+
"solaris": {
39+
"limitpriv": "default"
40+
},
41+
42+
}
2043

21-
### Example
22-
```json
23-
"limitpriv": "default"
24-
```
44+
maxShmMemory
45+
~~~~~~~~~~~~
2546

26-
## maxShmMemory
2747
The maximum amount of shared memory allowed for this application container.
2848
A scale (K, M, G, T) can be applied to the value for each of these numbers (for example, 1M is one megabyte).
2949
Mapped to max-shm-memory in zonecfg(8) man page.
3050

31-
**`maxShmMemory`** *(string, OPTIONAL)*
51+
`maxShmMemory`::
52+
(string, OPTIONAL)
53+
54+
[[solaris-maxShmMemory-example]]
55+
.Example
56+
[source,json]
57+
{
58+
"solaris": {
59+
"maxShmMemory": "512m"
60+
},
61+
62+
}
3263

33-
### Example
34-
```json
35-
"maxShmMemory": "512m"
36-
```
64+
cappedCPU
65+
~~~~~~~~~
3766

38-
## cappedCPU
3967
Sets a limit on the amount of CPU time that can be used by a container.
4068
The unit used translates to the percentage of a single CPU that can be used by all user threads in a container, expressed as a fraction (for example, .75) or a mixed number (whole number and fraction, for example, 1.25).
4169
An ncpu value of 1 means 100% of a CPU, a value of 1.25 means 125%, .75 mean 75%, and so forth.
4270
When projects within a capped container have their own caps, the minimum value takes precedence.
4371
cappedCPU is mapped to capped-cpu in zonecfg(8) man page.
4472

45-
* **`ncpus`** *(string, OPTIONAL)*
73+
`ncpus`::
74+
(string, OPTIONAL)
4675

47-
### Example
48-
```json
49-
"cappedCPU": {
50-
"ncpus": "8"
76+
[[solaris-cappedCPU-example]]
77+
.Example
78+
[source,json]
79+
{
80+
"solaris": {
81+
"cappedCPU": {
82+
"ncpus": "8"
83+
}
84+
},
85+
5186
}
52-
```
5387

54-
## cappedMemory
88+
cappedMemory
89+
~~~~~~~~~~~~
90+
5591
The physical and swap caps on the memory that can be used by this application container.
5692
A scale (K, M, G, T) can be applied to the value for each of these numbers (for example, 1M is one megabyte).
5793
cappedMemory is mapped to capped-memory in zonecfg(8) man page.
5894

59-
* **`physical`** *(string, OPTIONAL)*
60-
* **`swap`** *(string, OPTIONAL)*
95+
`physical`::
96+
(string, OPTIONAL)
97+
98+
`swap`::
99+
(string, OPTIONAL)
61100

62-
### Example
63-
```json
64-
"cappedMemory": {
65-
"physical": "512m",
66-
"swap": "512m"
101+
[[solaris-cappedMemory-example]]
102+
.Example
103+
[source,json]
104+
{
105+
"solaris": {
106+
"cappedMemory": {
107+
"physical": "512m",
108+
"swap": "512m"
109+
}
110+
},
111+
67112
}
68-
```
69113

70-
## Network
114+
Network
115+
~~~~~~~
116+
117+
Automatic Network (anet)
118+
^^^^^^^^^^^^^^^^^^^^^^^^
71119

72-
### Automatic Network (anet)
73120
anet is specified as an array that is used to setup networking for Solaris application containers.
74121
The anet resource represents the automatic creation of a network resource for an application container.
75122
The zones administration daemon, zoneadmd, is the primary process for managing the container's virtual platform.
@@ -80,36 +127,54 @@ The VNIC is deleted when the container is torn down.
80127
The following properties can be used to setup automatic networks.
81128
For additional information on properties check zonecfg(8) man page for the respective release of Solaris.
82129

83-
* **`linkname`** *(string, OPTIONAL)* Specify a name for the automatically created VNIC datalink.
84-
* **`lowerLink`** *(string, OPTIONAL)* Specify the link over which the VNIC will be created.
85-
Mapped to lower-link in the zonecfg(8) man page.
86-
* **`allowedAddress`** *(string, OPTIONAL)* The set of IP addresses that the container can use might be constrained by specifying the allowedAddress property.
87-
If allowedAddress has not been specified, then they can use any IP address on the associated physical interface for the network resource.
88-
Otherwise, when allowedAddress is specified, the container cannot use IP addresses that are not in the allowedAddress list for the physical address.
89-
Mapped to allowed-address in the zonecfg(8) man page.
90-
* **`configureAllowedAddress`** *(string, OPTIONAL)* If configureAllowedAddress is set to true, the addresses specified by allowedAddress are automatically configured on the interface each time the container starts.
91-
When it is set to false, the allowedAddress will not be configured on container start.
92-
Mapped to configure-allowed-address in the zonecfg(8) man page.
93-
* **`defrouter`** *(string, OPTIONAL)* The value for the OPTIONAL default router.
94-
* **`macAddress`** *(string, OPTIONAL)* Set the VNIC's MAC addresses based on the specified value or keyword.
95-
If not a keyword, it is interpreted as a unicast MAC address.
96-
For a list of the supported keywords please refer to the zonecfg(8) man page of the respective Solaris release.
97-
Mapped to mac-address in the zonecfg(8) man page.
98-
* **`linkProtection`** *(string, OPTIONAL)* Enables one or more types of link protection using comma-separated values.
99-
See the protection property in dladm(8) for supported values in respective release of Solaris.
100-
Mapped to link-protection in the zonecfg(8) man page.
101-
102-
#### Example
103-
```json
104-
"anet": [
105-
{
130+
`linkname`::
131+
(string, OPTIONAL) Specify a name for the automatically created VNIC datalink.
132+
133+
`lowerLink`::
134+
(string, OPTIONAL) Specify the link over which the VNIC will be created.
135+
Mapped to lower-link in the zonecfg(8) man page.
136+
137+
`allowedAddress`::
138+
(string, OPTIONAL) The set of IP addresses that the container can use might be constrained by specifying the allowedAddress property.
139+
If allowedAddress has not been specified, then they can use any IP address on the associated physical interface for the network resource.
140+
Otherwise, when allowedAddress is specified, the container cannot use IP addresses that are not in the allowedAddress list for the physical address.
141+
Mapped to allowed-address in the zonecfg(8) man page.
142+
143+
`configureAllowedAddress`::
144+
(string, OPTIONAL) If configureAllowedAddress is set to true, the addresses specified by allowedAddress are automatically configured on the interface each time the container starts.
145+
When it is set to false, the allowedAddress will not be configured on container start.
146+
Mapped to configure-allowed-address in the zonecfg(8) man page.
147+
148+
`defrouter`::
149+
(string, OPTIONAL) The value for the OPTIONAL default router.
150+
151+
`macAddress`::
152+
(string, OPTIONAL) Set the VNIC's MAC addresses based on the specified value or keyword.
153+
If not a keyword, it is interpreted as a unicast MAC address.
154+
For a list of the supported keywords please refer to the zonecfg(8) man page of the respective Solaris release.
155+
Mapped to mac-address in the zonecfg(8) man page.
156+
157+
`linkProtection`::
158+
(string, OPTIONAL) Enables one or more types of link protection using comma-separated values.
159+
See the protection property in dladm(8) for supported values in respective release of Solaris.
160+
Mapped to link-protection in the zonecfg(8) man page.
161+
162+
[[solaris-anet-example]]
163+
.Example
164+
[source,json]
165+
{
166+
"solaris": {
167+
"anet": [
168+
{
106169
"allowedAddress": "172.17.0.2/16",
107170
"configureAllowedAddress": "true",
108171
"defrouter": "172.17.0.1/16",
109172
"linkProtection": "mac-nospoof, ip-nospoof",
110173
"linkname": "net0",
111174
"lowerLink": "net2",
112175
"macAddress": "02:42:f8:52:c7:16"
113-
}
114-
]
115-
```
176+
}
177+
]
178+
},
179+
180+
}

config.asc

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

403403
`solaris`::
404-
(object, OPTIONAL) `<<config-solaris>>`.
404+
(object, OPTIONAL) <<config-solaris>>.
405405
This SHOULD only be set if `platform.os` is `solaris`.
406406

407407
`windows`::
@@ -430,6 +430,8 @@ The following properties can be specified:
430430

431431
include::config-linux.asc[]
432432

433+
include::config-solaris.asc[]
434+
433435
:leveloffset: 0
434436

435437
[[hooks]]

protocols.asc

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

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

schema/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The layout of the files is as follows:
88

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)
11-
* [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.md)
11+
* [config-solaris.json](config-solaris.json) - the [Solaris-specific configuration sub-structure](../config-solaris.asc)
1212
* [config-windows.json](config-windows.json) - the [Windows-specific configuration sub-structure](../config-windows.md)
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

0 commit comments

Comments
 (0)