| <!-- |
| # |
| # Licensed to the Apache Software Foundation (ASF) under one or more |
| # contributor license agreements. See the NOTICE file distributed with |
| # this work for additional information regarding copyright ownership. |
| # The ASF licenses this file to You under the Apache License, Version 2.0 |
| # (the "License"); you may not use this file except in compliance with |
| # the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, software |
| # distributed under the License is distributed on an "AS IS" BASIS, |
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| # See the License for the specific language governing permissions and |
| # limitations under the License. |
| # |
| --> |
| |
| # OpenWhisk Packaging Specification |
| |
| [](http://www.apache.org/licenses/LICENSE-2.0) |
| |
| ## Purpose |
| |
| In general, the goal of this specification is to evolve a simple grammar to describe and deploy a complete OpenWhisk package without having to use any APIs. Primarily, it is accomplished by coding a Package Manifest file and optionally a Deployment file using YAML. |
| |
| The ```wskdeploy``` utility is the reference implementation of this specification for the Apache OpenWhisk project. |
| |
| --- |
| |
| # Programming Guide |
| |
| If you want to learn how to write Packages and Applications by example using the specification and deploy them using the ```wskdeploy``` utility, please read the step-by-step guide: |
| - "[wskdeploy utility by example](../docs/programming_guide.md#wskdeploy-utility-by-example)" |
| |
| --- |
| |
| # Package Specification |
| |
| The majority of the OpenWhisk Packaging Specification, for convenience, is made available here in Markdown/HTML format. The canonical source for all versions is in PDF format and can be found within the [archive](archive) directory. |
| |
| #### Notational Conventions |
| |
| The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC |
| 2119](http://www.ietf.org/rfc/rfc2119.txt). |
| |
| ### Index |
| |
| #### Overview |
| - [Introduction](html/spec_intro.md#introduction) - an overview of the goals for the packaging specification. |
| - [Compatibility](html/spec_intro.md#compatibility) - describes intent to be compatible with other standards. |
| - [Programming model](html/spec_programming_model.md#programming-model) - an overview of the OpenWhisk programming model. |
| - [Package processing](html/spec_package_processing.md#package-processing) - describes how the developers can use Package Manifests and Deployment files with the ```wskdeploy``` utility. |
| - [Grammar](html/spec_grammar.md#grammar) - describes the YAML grammar the specification builds upon. |
| |
| #### [Schema](html/spec_schema.md#schema) |
| - [Parameter Types](html/spec_parameter_types.md#parameter-types) - supported YAML and OpenWhisk Types. |
| - [Parameters](html/spec_parameters.md#parameters) - grammar, schema and examples for input and output parameters. |
| - [Maps](html/spec_maps.md#map-schema) - schema for using the Map parameter type. |
| - [Entity Schema](html/spec_shared_entity_schema.md#shared-entity-schema) - keys that are common to all entities in the programming model. |
| - [Packages](html/spec_packages.md#packages) - grammar, schema and examples for Packages. |
| - [Actions](html/spec_actions.md#actions) - grammar, schema and examples for Actions. |
| - [Triggers](html/spec_trigger.md#triggers) - grammar, schema and examples for Triggers. |
| - [Rules](html/spec_rule.md#rules) - grammar, schema and examples for Rules. |
| - [Sequences](html/spec_sequences.md#sequences) - schema to compose multiple Actions into a single, named Action sequence. |
| - [Entity Naming & Namespacing](html/spec_entity_naming_and_namespacing.md#naming-and-namespacing) - describes what characters can be used to name Packages, Actions, Triggers and Rules and how to manage them with namespaces. |
| - [APIs](html/spec_apis.md#apis) - grammar, schema and examples for APIs. |
| |
| #### References |
| - [Normative & Non-normative References](html/spec_normative_refs.md) |
| - [Definitions](html/spec_definitions.md#definitions) - defines terms that are used in the specification. |
| - [Revision History](html/spec_history.md#revision-history) - lists changes to specification by version/revision. |
| |
| #### License |
| The OpenWhisk packaging specification is licensed under [The Apache License, |
| Version 2.0](http://www.apache.org/licenses/LICENSE-2.0.html). |
| |
| --- |
| |
| ### Disclaimer |
| This specification is under development and in draft status; therefore, it is subject to change during this development period. We are posting drafts seeking review, comments, suggestions and use cases from the OpenWhisk and greater Serverless community. |
