Skip to content

Commit 7ca2e6c

Browse files
author
John Howard
committed
Fix camelCase and Solaris incosistencies
Signed-off-by: John Howard <[email protected]>
1 parent e6c9689 commit 7ca2e6c

File tree

4 files changed

+27
-27
lines changed

4 files changed

+27
-27
lines changed

config-solaris.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ The SMF(Service Management Facility) FMRI which should go to "online" state befo
1212
"milestone": "svc:/milestone/container:default"
1313
```
1414

15-
## <a name="configSolarisLimitpriv" />limitpriv
15+
## <a name="configSolarisLimitPriv" />limitPriv
1616
The maximum set of privileges any process in this container can obtain.
1717
The property should consist of a comma-separated privilege set specification as described in [priv_str_to_set(3C)][priv-str-to-set.3c] man page for the respective release of Solaris.
1818

19-
**`limitpriv`** *(string, OPTIONAL)*
19+
**`limitPriv`** *(string, OPTIONAL)*
2020

2121
### Example
2222
```json
23-
"limitpriv": "default"
23+
"limitPriv": "default"
2424
```
2525

2626
## <a name="configSolarisMaxShmMemory" />maxShmMemory
@@ -80,7 +80,7 @@ The VNIC is deleted when the container is torn down.
8080
The following properties can be used to set up automatic networks.
8181
For additional information on properties, check the [zonecfg(1M)][zonecfg.1m_2] man page for the respective release of Solaris.
8282

83-
* **`linkname`** *(string, OPTIONAL)* Specify a name for the automatically created VNIC datalink.
83+
* **`linkName`** *(string, OPTIONAL)* Specify a name for the automatically created VNIC datalink.
8484
* **`lowerLink`** *(string, OPTIONAL)* Specify the link over which the VNIC will be created.
8585
Mapped to `lower-link` in the [zonecfg(1M)][zonecfg.1m_2] man page.
8686
* **`allowedAddress`** *(string, OPTIONAL)* The set of IP addresses that the container can use might be constrained by specifying the allowedAddress property.
@@ -90,7 +90,7 @@ Mapped to `allowed-address` in the [zonecfg(1M)][zonecfg.1m_2] man page.
9090
* **`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.
9191
When it is set to false, the allowedAddress will not be configured on container start.
9292
Mapped to `configure-allowed-address` in the [zonecfg(1M)][zonecfg.1m_2] man page.
93-
* **`defrouter`** *(string, OPTIONAL)* The value for the OPTIONAL default router.
93+
* **`defRouter`** *(string, OPTIONAL)* The value for the OPTIONAL default router.
9494
* **`macAddress`** *(string, OPTIONAL)* Set the VNIC's MAC addresses based on the specified value or keyword.
9595
If not a keyword, it is interpreted as a unicast MAC address.
9696
For a list of the supported keywords please refer to the [zonecfg(1M)][zonecfg.1m_2] man page of the respective Solaris release.
@@ -105,16 +105,16 @@ Mapped to `link-protection` in the [zonecfg(1M)][zonecfg.1m_2] man page.
105105
{
106106
"allowedAddress": "172.17.0.2/16",
107107
"configureAllowedAddress": "true",
108-
"defrouter": "172.17.0.1/16",
108+
"defRouter": "172.17.0.1/16",
109109
"linkProtection": "mac-nospoof, ip-nospoof",
110-
"linkname": "net0",
110+
"linkName": "net0",
111111
"lowerLink": "net2",
112112
"macAddress": "02:42:f8:52:c7:16"
113113
}
114114
]
115115
```
116116

117117

118-
[priv-str-to-set.3c]: http://docs.oracle.com/cd/E53394_01/html/E54766/priv-str-to-set-3c.html
118+
[priv-str-to-set.3c]: http://docs.oracle.com/cd/E19253-01/816-5168/priv-str-to-set-3c/index.html
119119
[zoneadmd.1m]: http://docs.oracle.com/cd/E53394_01/html/E54764/zoneadmd-1m.html
120120
[zonecfg.1m_2]: https://docs.oracle.com/cd/E36784_01/html/E36871/zonecfg-1m.html

config-windows.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ The following parameters can be specified:
106106

107107
## <a name="configWindowsCredentialSpec" />Credential Spec
108108

109-
You can configure a container's group Managed Service Account (gMSA) via the OPTIONAL `credentialspec` field of the Windows configuration.
110-
The `credentialspec` is a JSON object whose properties are implementation-defined.
109+
You can configure a container's group Managed Service Account (gMSA) via the OPTIONAL `credentialSpec` field of the Windows configuration.
110+
The `credentialSpec` is a JSON object whose properties are implementation-defined.
111111
For more information about gMSAs, see [Active Directory Service Accounts for Windows Containers][gMSAOverview].
112112
For more information about tooling to generate a gMSA, see [Deployment Overview][gMSATooling].
113113

@@ -130,13 +130,13 @@ You can indicate that a container should be started in a mode to apply pending s
130130

131131
## <a name="configWindowsIgnoreFlushesDuringBoot" />IgnoreFlushesDuringBoot
132132

133-
You can indicate that a container should be started in an a mode where disk flushes are not performed during container boot via the OPTIONAL `ignoreflushesduringboot` field of the Windows configuration.
133+
You can indicate that a container should be started in an a mode where disk flushes are not performed during container boot via the OPTIONAL `ignoreFlushesDuringBoot` field of the Windows configuration.
134134

135135
### Example
136136

137137
```json
138138
"windows": {
139-
"ignoreflushesduringboot": true
139+
"ignoreFlushesDuringBoot": true
140140
}
141141
```
142142

@@ -146,14 +146,14 @@ You can indicate that a container should be started in an a mode where disk flus
146146

147147
The following parameters can be specified:
148148

149-
* **`utilityvmpath`** *(string, OPTIONAL)* - specifies the path to the image used for the utility VM. This would be specified if using a base image which does not contain a utility VM image. If not supplied, the runtime will search the container filesystem layers from the bottom-most layer upwards, until it locates "UtilityVM", and default to that path.
149+
* **`utilityVMPath`** *(string, OPTIONAL)* - specifies the path to the image used for the utility VM. This would be specified if using a base image which does not contain a utility VM image. If not supplied, the runtime will search the container filesystem layers from the bottom-most layer upwards, until it locates "UtilityVM", and default to that path.
150150

151151
### Example
152152

153153
```json
154154
"windows": {
155155
"hyperv": {
156-
"utilityvmpath": "C:\\path\\to\\utilityvm"
156+
"utilityVMPath": "C:\\path\\to\\utilityvm"
157157
}
158158
}
159159
```

schema/config-solaris.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88
"id": "https://opencontainers.org/schema/bundle/solaris/milestone",
99
"type": "string"
1010
},
11-
"limitpriv": {
12-
"id": "https://opencontainers.org/schema/bundle/solaris/limitpriv",
11+
"limitPriv": {
12+
"id": "https://opencontainers.org/schema/bundle/solaris/limitPriv",
1313
"type": "string"
1414
},
1515
"maxShmMemory": {

specs-go/config.go

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -388,7 +388,7 @@ type Solaris struct {
388388
// SMF FMRI which should go "online" before we start the container process.
389389
Milestone string `json:"milestone,omitempty"`
390390
// Maximum set of privileges any process in this container can obtain.
391-
LimitPriv string `json:"limitpriv,omitempty"`
391+
LimitPriv string `json:"limitPriv,omitempty"`
392392
// The maximum amount of shared memory allowed for this container.
393393
MaxShmMemory string `json:"maxShmMemory,omitempty"`
394394
// Specification for automatic creation of network resources for this container.
@@ -413,31 +413,31 @@ type SolarisCappedMemory struct {
413413
// SolarisAnet provides the specification for automatic creation of network resources for this container.
414414
type SolarisAnet struct {
415415
// Specify a name for the automatically created VNIC datalink.
416-
Linkname string `json:"linkname,omitempty"`
416+
LinkName string `json:"linkName,omitempty"`
417417
// Specify the link over which the VNIC will be created.
418-
Lowerlink string `json:"lowerLink,omitempty"`
418+
LowerLink string `json:"lowerLink,omitempty"`
419419
// The set of IP addresses that the container can use.
420-
Allowedaddr string `json:"allowedAddress,omitempty"`
420+
AllowedAddress string `json:"allowedAddress,omitempty"`
421421
// Specifies whether allowedAddress limitation is to be applied to the VNIC.
422-
Configallowedaddr string `json:"configureAllowedAddress,omitempty"`
422+
ConfigAllowedAddress string `json:"configureAllowedAddress,omitempty"`
423423
// The value of the optional default router.
424-
Defrouter string `json:"defrouter,omitempty"`
424+
DefRouter string `json:"defRouter,omitempty"`
425425
// Enable one or more types of link protection.
426-
Linkprotection string `json:"linkProtection,omitempty"`
426+
LinkProtection string `json:"linkProtection,omitempty"`
427427
// Set the VNIC's macAddress
428-
Macaddress string `json:"macAddress,omitempty"`
428+
MacAddress string `json:"macAddress,omitempty"`
429429
}
430430

431431
// Windows defines the runtime configuration for Windows based containers, including Hyper-V containers.
432432
type Windows struct {
433433
// Resources contains information for handling resource constraints for the container.
434434
Resources *WindowsResources `json:"resources,omitempty"`
435435
// CredentialSpec contains a JSON object describing a group Managed Service Account (gMSA) specification.
436-
CredentialSpec interface{} `json:"credentialspec,omitempty"`
436+
CredentialSpec interface{} `json:"credentialSpec,omitempty"`
437437
// Servicing indicates if the container is being started in a mode to apply a Windows Update servicing operation.
438438
Servicing bool `json:"servicing,omitempty"`
439439
// IgnoreFlushesDuringBoot indicates if the container is being started in a mode where disk writes are not flushed during its boot process.
440-
IgnoreFlushesDuringBoot bool `json:"ignoreflushesduringboot,omitempty"`
440+
IgnoreFlushesDuringBoot bool `json:"ignoreFlushesDuringBoot,omitempty"`
441441
// HyperV contains information for running a container with Hyper-V isolation.
442442
HyperV *WindowsHyperV `json:"hyperv,omitempty"`
443443
// Network restriction configuration.
@@ -495,7 +495,7 @@ type WindowsNetwork struct {
495495
// WindowsHyperV contains information for configuring a container to run with Hyper-V isolation.
496496
type WindowsHyperV struct {
497497
// UtilityVMPath is an optional path to the image used for the Utility VM.
498-
UtilityVMPath string `json:"utilityvmpath,omitempty"`
498+
UtilityVMPath string `json:"utilityVMPath,omitempty"`
499499
}
500500

501501
// LinuxSeccomp represents syscall restrictions

0 commit comments

Comments
 (0)