ptzagk / cnab-spec

Cloud Native Application Bundle Specification

Cloud Native Application Bundle Specifications

Abstract

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.

Table of Contents

• Chapter 1: Cloud Native Application Bundle Core 1.0.0 (CNAB1)
  1. The bundle.json File
  2. The Invocation Image Format
  3. The Bundle Runtime
  4. Bundle Formats (Thick and Thin)
• Chapter 2: Cloud Native Application Bundle Registry 1.0.0 (CNAB-Reg)
• Chapter 3: Cloud Native Application Bundle Security 1.0.0 (CNAB-Sec)
• Chapter 4: Cloud Native Application Bundle Claims 1.0.0 (CNAB-Claims1)
• Chapter 5: Cloud Native Application Bundle Dependencies 1.0.0 (CNAB-Deps)
• Chapter 8: Non-normative Content
  1. Declarative Invocation Images
  2. Credential Sets
  3. Repositories
  4. Well known custom actions
• Chapter 9: Appendix
  1. Appendix A: Preliminary Release Process

Contributing

The specification is licensed under OWF Contributor License Agreement 1.0 - Copyright and Patent in the LICENSE file.

Communications

Meetings

• Community Meeting: Every other Wednesday at 09:00 AM US Pacific
  • https://zoom.us/j/653255416
  • Meeting notes and Agenda.

Mailing List

• Send emails to: [email protected]
• To subscribe see: https://groups.google.com/a/opencontainers.org/forum/#!forum/dev

Slack Channel

#cnab Slack channel for related discussion in CNCF's Slack workspace.

Notational Conventions

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" are to be interpreted as described in RFC 2119.

The key words "unspecified", "undefined", and "implementation-defined" are to be interpreted as described in the rationale for the C99 standard.

An implementation IS compliant if it satisfies all the MUST, REQUIRED, and SHALL requirements.

An implementation IS NOT compliant if it fails to satisfy one or more of the MUST, REQUIRED, or SHALL requirements.

Document Naming Conventions

During the draft period of the specification, the documents are named according to the following convention:

• 000-099 contains front matter
• 100-799 contain the specification proper
  • The first digit is the chapter number
  • The following two digits are the section numbers
• 800-899 is reserved for non-normative content (examples, patterns, best practices)
• 900-999 is reserved for appendices