Commit Graph

1014 Commits

Author SHA1 Message Date
zhouhao 11d1ae747c schema: Format fix
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-27 13:57:49 +08:00
zhouhao 79494b2175 schema: Fix the error
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-27 13:49:18 +08:00
Mrunal Patel 13895d6074 Merge pull request #775 from q384566678/rootfs-enum
schema: Add enumeration to rootfsPropagation values
2017-04-26 15:59:09 -07:00
Tianon Gravi 138ad89ca8 Merge pull request #768 from wking/optional-syscalls
config-linux: Make linux.seccomp.syscalls OPTIONAL
2017-04-26 08:29:52 -07:00
v1.0.0.batts c6bff91450 Merge pull request #769 from wking/require-syscall-names
config-linux: Require at least one entry in linux.seccomp.sycalls[].names
2017-04-26 11:26:05 -04:00
v1.0.0.batts 482fe6bf1c Merge pull request #773 from q384566678/device-up
config-linux.md: Update the link to the devices
2017-04-26 11:16:05 -04:00
Mrunal Patel cb90a82fc1 Merge pull request #778 from wking/schema-makefile-phony
schema/Makefile: Add .PHONY declarations for phony targets
2017-04-26 08:08:27 -07:00
Mrunal Patel 5492fc0bf6 Merge pull request #780 from hqhq/remove_blkio_range
Remove range limit which depend on kernel
2017-04-26 08:07:04 -07:00
Qiang Huang ce55de2517 Remove range limit which depend on kernel
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2017-04-26 22:46:02 +08:00
W. Trevor King 42984e8d3c config-linux: Make linux.seccomp.syscalls OPTIONAL
Before this commit, linux.seccomp.sycalls was required, but we didn't
require an entry in the array.  That means '"syscalls": []' would be
technically valid, and I'm pretty sure that's not what we want.

If it makes sense to have a seccomp property that does not need
syscalls entries, then syscalls should be optional (which is what this
commit is doing).

If it does not makes sense to have an empty/unset syscalls then it
should be required and have a minimum length of one.

Before 652323c (improve seccomp format to be more expressive,
2017-01-13, #657), syscalls was omitempty (and therefore more
optional-feeling, although there was no real Markdown spec for seccomp
before 3ca5c6c, config-linux.md: fix seccomp, 2017-03-02, #706, so
it's hard to know).  This commit has gone with OPTIONAL, because a
seccomp config which only sets defaultAction seems potentially valid.

The SCMP_ACT_KILL example is prompted by:

On Tue, Apr 25, 2017 at 01:32:26PM -0700, David Lyle wrote [1]:
> Technically, OPTIONAL is the right value, but unless you specify the
> default action for seccomp to be SCMP_ACT_ALLOW the result will be
> an error at run time.
>
> I would suggest an additional clarification to this fact in
> config-linux.md would be very helpful if marking syscall as
> OPTIONAL.

I've phrased the example more conservatively, because I'm not sure
that SCMP_ACT_ALLOW is the only possible value to avoid an error.  For
example, perhaps a SCMP_ACT_TRACE default with an empty syscalls array
would not die on the first syscall.  The point of the example is to
remind config authors that without a useful syscalls array, the
default value is very important ;).

Also add the previously-missing 'required' property to the seccomp
JSON Schema entry.

[1]: https://github.com/opencontainers/runtime-spec/pull/768#issuecomment-297156102

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-25 15:06:57 -07:00
Michael Crosby f2276206b3 Merge pull request #770 from q384566678/rootfsPropagation-test
config-linux.md: Increase the valid value of rootfsPropagation
2017-04-25 11:18:19 -07:00
Michael Crosby b5a9eb85b1 Merge pull request #776 from wking/file-link-fix
config-linux: Fix 'file' POSIX link
2017-04-25 11:11:00 -07:00
W. Trevor King 45cd926102 schema/Makefile: Add .PHONY declarations for phony targets
The only non-phony target (where the target name matches the output
file) is 'validate', but we need .PHONY there because the Go
dependencies are not represented in the Makefile.  This commit adds
the missing .PHONY declarations to the other targets, which truly are
phony.

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-24 13:47:03 -07:00
Michael Crosby 4754b55de9 Merge pull request #774 from q384566678/makefile-clean
schema: add `clean` to Makefile
2017-04-21 15:30:07 -07:00
W. Trevor King 4c33c9e041 config-linux: Fix 'file' POSIX link
This was broken by f9dc90b0 (make link usage consistent across the
specification, 2017-02-09, #687), which updated the link label, but
not this link.  Now that the link label matches the link text, we can
use the implicit link name shortcut [1].

[1]: https://daringfireball.net/projects/markdown/syntax#link

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-21 09:40:45 -07:00
zhouhao a084798c96 schema: Add enumeration to rootfsPropagation values
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-21 13:29:13 +08:00
zhouhao 9d5ff350b4 config-linux.md: Update the link to the devices
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-20 13:38:05 +08:00
zhouhao df784c5fb8 schema: add clean to Makefile
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-18 17:51:15 +08:00
zhouhao e3d8d10e05 config-linux.md: Increase the valid value of rootfsPropagation
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-13 09:33:07 +08:00
W. Trevor King 5c62f9b839 config-linux: Require at least one entry in linux.seccomp.sycalls[].names
I expect the (undocumented) intention here is to iterate through
'names' and call seccomp_rule_add(3) or similar for each name.  In
that case, an empty 'names' makes the whole syscall entry a no-op, and
with this commit we can warn users who are validating such configs.

If, on the other hand, we were comfortable with no-op syscall entries,
we'd want to make 'names' OPTIONAL.

Warning folks who accidentally empty (or don't set) 'names' seems more
useful to me, and doesn't restrict the useful config space, so that's
what I've gone with in this commit.

minItems is documented in [1], and there is an example of its use in
[2]:

  "options": {
    "type": "array",
    "minItems": 1,
    "items": { "type": "string" },
    "uniqueItems": true
  },

[1]: https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.11
[2]: http://json-schema.org/example2.html

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-12 10:17:13 -07:00
Michael Crosby cfc95a5676 Merge pull request #761 from wking/box-size-units
config: Specify height/width units (characters) for consoleSize
2017-04-12 10:02:23 -07:00
Michael Crosby 54a66769e9 Merge pull request #765 from wking/not-required
spec: Add "NOT RECOMMENDED" to RFC 2119 keywords
2017-04-12 09:48:39 -07:00
Mrunal Patel 67316f0df1 Merge pull request #763 from wking/seccomp-args-omitempty
specs-go/config: Add omitempty to LinuxSyscall.Args
2017-04-12 08:10:55 -07:00
W. Trevor King 8634ad9291 spec: Add "NOT RECOMMENDED" to RFC 2119 keywords
Catching up with erratum 499 [1].

[1]: https://www.rfc-editor.org/errata_search.php?rfc=2119&eid=499

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-11 10:33:51 -07:00
v1.0.0.batts daba39cc05 Merge pull request #750 from q384566678/schema-test
schema: modify Makefile
2017-04-10 08:04:29 -04:00
v1.0.0.batts af9e4b3d88 Merge pull request #758 from wking/ics-description-link-readme
meeting: Include README link in DESCRIPTION body
2017-04-10 08:04:02 -04:00
zhouhao 8b8afafec7 Makefile: modify the default value
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-04-10 09:40:24 +08:00
W. Trevor King bb4cca78cd specs-go/config: Add omitempty to LinuxSyscall.Args
It used to have this, but the omitempty was dropped in 652323cd
(improve seccomp format to be more expressive, 2017-01-13, #657).
However, the docs that landed in 3ca5c6c5 (config-linux.md: fix
seccomp, 2017-03-02, #706) list the property as optional, and if it is
optional, we can leave it unset instead of serializing an empty array.

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-06 23:13:22 -07:00
W. Trevor King 8941ddadd4 config: Specify height/width units (characters) for consoleSize
This is pretty clear from the examples like:

  "consoleSize": {
    "height": 25,
    "width": 80
  }

But examples are not normative, so this commit makes the character
units normative.

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-06 22:35:56 -07:00
W. Trevor King 9a497c278a meeting: Include README link in DESCRIPTION body
And bump DTSTAMP for the touched VEVENTS.

com.android.calendar version 7.1.1 only displays the DESCRIPTION body,
and does not provide a link to ALTREP (in fact, I don't see any
instances of ALTREP in the source [1]).  Including the README link in
the DESCRIPTION body gives folks using that calendar application an
easy way to get to the README section.

The ICS was validated with [2].

[1]: https://android.googlesource.com/platform/packages/apps/Calendar/+/android-7.1.1_r38
[2]: https://icalendar.org/validator.html

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-06 07:20:42 -07:00
Mrunal Patel 0946333a36 Merge pull request #757 from wking/ics-uberconf-link
meeting: Add UberConference information
2017-04-05 17:08:46 -07:00
Vincent Batts db14059635 Merge pull request #739 from wking/meetbot-minute-archives
README: Link to MeetBot logs for meeting minutes
2017-04-05 14:50:36 -04:00
W. Trevor King 6fadfd1eb8 meeting: Add UberConference information
And bump DTSTAMP for the touched VEVENTS.

This is less DRY, but makes life easier for folks pulling up the
calendar a minute before the meeting, since they don't have to click
through to the README section.  Also requested by Vincent [1] ;).

The LOCATION entry [2] seems like a reasonable location for the
conference-call page, so I've used that.  Note that the URI there is a
text value; LOCATION supports URIs in ALTREP [2], but the
UberConference page isn't an "alternate text representation for the
property value" [3].  The URI in DESCRIPTION is a fallback for clients
that don't support/display LOCATION (I'm not sure if any exist, but
it's easy to play it safe).  I couldn't find a more structured
location for the phone number, unless we also wanted to put that in
LOCATION.

The ICS was validated with [4].

[1]: http://ircbot.wl.linuxfoundation.org/eavesdrop/%23opencontainers/%23opencontainers.2017-04-05.log.html#t2017-04-05T17:55:25
[2]: https://tools.ietf.org/html/rfc5545#section-3.8.1.7
[3]: https://tools.ietf.org/html/rfc5545#section-3.2.1
[4]: https://icalendar.org/validator.html

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-05 11:26:34 -07:00
W. Trevor King b37ccfaac0 README: Link to MeetBot logs for meeting minutes
Rob had been keeping the wiki up to date with links to the MeetBot
logs, but linking directly to the MeetBot logs gives us one less thing
to maintain.  The meetings which are only in the wiki are 2015-07-22,
2015-08-05, 2015-08-12, 2015-08-26, 2015-09-02, 2015-09-09,
2015-09-16, 2015-09-24, 2015-09-30.  The last is in MeetBot, but it
was our first MeetBot meeting, so the MeetBot logs are not great.

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-05 09:28:18 -07:00
Vincent Batts e8a0d3d977 Merge pull request #748 from wking/meeting-copy-edit
README: E.123 number for meeting call
2017-04-05 10:27:31 -04:00
Vincent Batts d5f56f0d9c Merge pull request #753 from wking/tk/remove-env-var-dollars
config: Replace '$GOOS' with 'GOOS', etc.
2017-04-05 10:24:58 -04:00
W. Trevor King 124a819511 config: Replace '$GOOS' with 'GOOS', etc.
Windows' cmd.exe prefers wrapping in % (e.g. %GOOS%) [1], and Rob
Dolin has asked for the POSIX $ to be removed [2].  In this case, I
think the context is sufficient that we can just use the variable name
instead of Rob's recommended "for the environment variable FOO".

[1]: https://www.microsoft.com/resources/documentation/windows/xp/all/proddocs/en-us/ntcmds_shelloverview.mspx?mfr=true
[2]: https://github.com/opencontainers/runtime-spec/issues/477#issue-157945714

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-04-04 15:52:59 -07:00
Michael Crosby 18f4f18955 Merge pull request #751 from hqhq/use_MUST_for_weight
Use MUST and MAY for weight and leafWeight
2017-04-03 14:18:18 -07:00
Mrunal Patel d094a5c9c1 Merge pull request #749 from wking/array-of-x
*: Replace "array" type with "array of objects"
2017-03-30 08:03:05 -07:00
Mrunal Patel 99d224cfe5 Merge pull request #752 from q384566678/fix-typo
GOVERNANCE.md: fix typo
2017-03-30 08:01:40 -07:00
zhouhao 4a157998cd GOVERNANCE.md: fix typo
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-03-30 15:14:35 +08:00
Qiang Huang 018c5f20b0 Use MUST and MAY for weight and leafWeight
Carry: #728

Signed-off-by: Rob Dolin <robdolin@microsoft.com>
Signed-off-by: Qiang Huang <h.huangqiang@huawei.com>
2017-03-30 13:01:38 +08:00
zhouhao 3324e7e876 schema: add .PHONY to validate
Signed-off-by: zhouhao <zhouhao@cn.fujitsu.com>
2017-03-30 11:19:11 +08:00
W. Trevor King ff207496ab *: Replace "array" type with "array of objects"
We have a few different element types in our arrays, so it's useful to
clarify the element type for the property being specified.  Before
this commit:

  $ sed -n 's|.*\*\*`\([^`]*\)`\*\*[^(]*(\([^,]*\),.*|\2|p' *.md | sort | uniq -c | grep array
        7 array
        1 array of ints
        8 array of objects
       13 array of strings

All of the bare 'array' instances turned out to be arrays of objects.

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-03-29 11:17:32 -07:00
W. Trevor King 84e348a7eb README: E.123 number for meeting call
And fix a period/paren swap.  The period/paren swap and contry-code
addition both bring the local version more in line with the image-spec
version [1] and seem like good changes.

I've diverged from the image-spec version by using space separation in
the phone number instead of hyphens.  From E.123 [2,3]:

  9.1  Grouping of digits in a telephone number [5] should be
  accomplished by means or spaces [6] unless an agreed upon explicit
  symbol (e.g. hyphen) is necessary for procedural purposes. Only
  spaces should be used in an international number.

[1]: https://github.com/opencontainers/image-spec/blob/v1.0.0-rc5/README.md#weekly-call
[2]: http://www.itu.int/rec/T-REC-E.123/en
[3]: https://www.itu.int/rec/dologin_pub.asp?lang=e&id=T-REC-E.123-200102-I!!PDF-E&type=items

Signed-off-by: W. Trevor King <wking@tremily.us>
2017-03-29 10:40:21 -07:00
Daniel, Dao Quang Minh 6ca773ae74 Merge pull request #740 from wking/alternating-meetings
README: Document the alternate-week meeting times
2017-03-29 10:27:59 +01:00
Qiang Huang 6e31bc0880 Merge pull request #744 from wking/fix-anchor-for-runtime-implementations
implementations: Fix 'name"..."' -> 'name="..."' runtime anchor
2017-03-28 23:14:25 -05:00
Mrunal Patel 71366eecb5 Merge pull request #741 from q384566678/fix-info
config-linux.md: fix info
2017-03-28 16:30:59 -07:00
W. Trevor King 989aed767a implementations: Fix 'name"..."' -> 'name="..."' runtime anchor
Signed-off-by: W. Trevor King <wking@tremily.us>
2017-03-28 13:49:39 -07:00
Michael Crosby 3adac26772 Merge pull request #706 from q384566678/fix-seecomp
config-linux.md: fix seccomp
2017-03-27 10:24:44 -07:00