wskdeploy utility by example

A step-by-step guide for deploying Apache OpenWhisk applications using Package Manifest files.

This guide will walk you through how to describe OpenWhisk applications and packages using the OpenWhisk Packaging Specification and deploy them through the Whisk Deploy (wskdeploy) utility. Please use the specification as the ultimate reference for all Manifest file grammar and syntax.

Getting started

Setting up your Host and Credentials

In order to deploy your OpenWhisk package, at minimum, the wskdeploy utility needs valid OpenWhisk APIHOST and AUTH variable to attempt deployment. Please read the Configuring wskdeploy

Debugging your Package Manifests

In addition to the normal output the wskdeploy utility provides, you may enable additional information that may further assist you in debugging. Please read the Debugging Whisk Deploy document.

FAQ for wskdeploy

Answers to Frequently Asked Questions may be found in the wskdeploy utility FAQ.

---

Guided Examples

Below is the list of “guided examples” where you can start by “Creating a ‘hello world’ application” and traverse through each example or jump to any example that interests you.

Each example shows the “code”, that is the Package Manifest, Deployment file and Actions that will be used to deploy that application or package, as well as discusses the interesting features the example is highlighting.

• Package examples
  • Creating a minimal Package - creating a basic package manifest and deploying it.
• Action examples
  • The “Hello World” Action - deploy a “hello world” JavaScript function using a manifest.
  • Setting your Function's runtime - explicitly set the runtime language and version to deploy your action onto.
  • Adding fixed input parameters - bind fixed values to the input parameters of “hello world”.
  • Typed Parameters - declare named input and output parameters on an Action with their types.
  • Advanced Parameters - input and output parameter declarations with types, descriptions, defaults and more.
  • Using Environment Variables - reference values from environment variables and bind them to an Action's input parameters.
• Sequences examples
  • Sequencing Actions together - sequence three actions together to process and augment data.
• Trigger and Rule examples
  • Basic Trigger and Rule - adding a basic trigger and rule to the advanced Parameter “hello world”.
  • Binding parameters in a Deployment file - using a deployment file to bind values to a Trigger’s parameters and applying them to a compatible manifest file.
• API Gateway examples
  • The “Hello World” API Gateway - deploy a “hello world” JavaScript function with associated HTTP API.
  • API Gateway sequence - deploy JavaScript sequence with associated HTTP API.
  • API Gateway HTTP response - deploy JavaScript actions that return custom HTTP responses.
  • API Gateway HTTP response and sequence - deploy JavaScript sequences that return custom HTTP responses.

---