Updates in anticipation of cnab-core-1.1.0 #388
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,7 +13,7 @@ The `bundle.json` file is a representation of bundle metadata. It MUST be repres | |
|
|
||
| A `bundle.json` is broken down into the following categories of information: | ||
|
|
||
| - The schema version of the bundle, as a string with a `v` prefix. This schema is to be referenced as `v1` or `v1.1.0` | ||
|
There was a problem hiding this comment. I wasn't sure if all of these There was a problem hiding this comment. While the schema has not changed, it is versioned with the core of the spec so I think it should match that (i.e.: 1.1.0). |
||
| - The top-level package information (`name` and `version`) | ||
| - `name`: The bundle name, including namespacing. The namespace can have one or more elements separated by a dot (e.g. `acme.tunnels.wordpress`). The left most element of the namespace is the most general moving toward more specific elements on the right. | ||
| - `version`: Semantic version of the bundle | ||
|
|
@@ -123,7 +123,7 @@ The following is an example of a `bundle.json` for a bundled distributed as a _t | |
| } | ||
| } | ||
| }, | ||
| "schemaVersion":"v1.1.0", | ||
| "version":"0.1.2" | ||
| } | ||
| ``` | ||
|
|
@@ -134,7 +134,7 @@ The canonical JSON version of the above is: | |
|
|
||
| <!-- prettier-ignore --> | ||
| ```json | ||
| {"credentials":{"hostkey":{"env":"HOST_KEY","path":"/etc/hostkey.txt"}},"custom":{"com.example.backup-preferences":{"frequency":"daily"},"com.example.duffle-bag":{"icon":"https://example.com/icon.png","iconType":"PNG"}},"definitions":{"http_port":{"default":80,"maximum":10240,"minimum":10,"type":"integer"},"port":{"maximum":65535,"minimum":1024,"type":"integer"},"string":{"type":"string"},"x509Certificate":{"contentEncoding":"base64","contentMediaType":"application/x-x509-user-cert","type":"string","writeOnly":true}},"description":"An example 'thin' helloworld Cloud-Native Application Bundle","images":{"my-microservice":{"contentDigest":"sha256:aaaaaaaaaaaa...","description":"my microservice","image":"example/microservice:1.2.3"}},"invocationImages":[{"contentDigest":"sha256:aaaaaaa...","image":"example/helloworld:0.1.0","imageType":"docker"}],"maintainers":[{"email":"[email protected]","name":"Matt Butcher","url":"https://example.com"}],"name":"helloworld","outputs":{"clientCert":{"definition":"x509Certificate","path":"/cnab/app/outputs/clientCert"},"hostName":{"applyTo":["install"],"definition":"string","description":"the hostname produced installing the bundle","path":"/cnab/app/outputs/hostname"},"port":{"definition":"port","path":"/cnab/app/outputs/port"}},"parameters":{"backend_port":{"definition":"http_port","description":"The port that the back-end will listen on","destination":{"env":"BACKEND_PORT"}}},"schemaVersion":"v1.1.0","version":"0.1.2"} | ||
| ``` | ||
|
|
||
| What follows is an example of a thick bundle. Notice how the `invocationImage` and `images` fields reference the underlying docker image manifest (`application/vnd.docker.distribution.manifest.v2+json`), which in turn references the underlying images: | ||
|
|
@@ -230,7 +230,7 @@ What follows is an example of a thick bundle. Notice how the `invocationImage` a | |
| } | ||
| } | ||
| }, | ||
| "schemaVersion":"v1.1.0", | ||
| "version":"1.0.0" | ||
| } | ||
|
|
||
|
|
@@ -268,7 +268,7 @@ The schema version must reference the version of the schema used for this docume | |
| - `CR` indicates that the document references a candidate recommendation. Stability is not assured. | ||
| - No suffix indicates that the document references a release of the specification, and is considered stable. | ||
|
|
||
| The current schema version is `v1.1.0`, which is considered stable. | ||
|
|
||
| ## Name and Version: Identifying Metadata | ||
|
|
||
|
|
@@ -937,7 +937,7 @@ A runtime MUST check that it supports any required extensions before performing | |
| "requiredExtensions":[ | ||
| "io.cnab.dependencies" | ||
| ], | ||
| "schemaVersion":"v1.1.0", | ||
| "version":"0.1.2" | ||
| } | ||
| ``` | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,15 +4,16 @@ | |
|
|
||
| Cloud Native Application Bundles (CNAB) are a package format specification that describes a technology for bundling, installing, and managing distributed applications, that are by design, cloud agnostic. | ||
|
|
||
| ## CNAB Core 1.1.0 (Final) | ||
|
|
||
| The CNAB Working Group with the joint approval of the Executive Directors has approved the CNAB Core 1.1.0 specification for publication. CNAB Core 1.1.0 is complete. | ||
|
There was a problem hiding this comment. Should I have added an additional section rather than amending this one? There was a problem hiding this comment. I think amending here makes sense. We don't want to pollute the README over time with a release history. |
||
|
|
||
| For more information on the approval process, see [the process documentation](901-process.md). Further changes to CNAB Core will be considered for CNAB Core 1.2. | ||
|
|
||
| ### Branch/Tag Structure | ||
|
|
||
| - [master](https://github.com/cnabio/cnab-spec) is the current working draft of all specs | ||
| - [cnab-core-1.1.0](https://github.com/cnabio/cnab-spec/tree/cnab-core-1.1.0) is the CNAB Core 1.1.0 final draft | ||
|
There was a problem hiding this comment. This tag is yet to be created; the intention is to cut the tag after this PR is approved, merged and included in the forthcoming |
||
| - [cnab-core-1.0.1](https://github.com/cnabio/cnab-spec/tree/cnab-core-1.0.1) is the CNAB Core 1.0.1 final draft | ||
| - [cnab-core-1.0](https://github.com/cnabio/cnab-spec/tree/cnab-core-1.0) is the CNAB Core 1.0.0 final draft | ||
| - [cnab-security-1.0.0](https://github.com/cnabio/cnab-spec/tree/cnab-security-1.0.0) is the CNAB Security 1.0.0 final draft | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Q: Does
CNAB1need to change?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would prefer if we have CNAB mean the latest CNAB release of the version (i.e.: In this case, CNAB1 means CNAB 1.1.0) as I think that usually this is what people mean when they say version . If one wants to be more specific, they can do so by specifying the minor and patch versions as well.
If we choose to do this, we may need to clarify our process versioning.