mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
66 lines
2.4 KiB
Markdown
66 lines
2.4 KiB
Markdown
<!--
|
|
title: Serverless Framework - Apache OpenWhisk Guide - Installing The Serverless Framework
|
|
menuText: Installation
|
|
menuOrder: 2
|
|
description: How to install the Serverless Framework and start using Apache OpenWhisk
|
|
layout: Doc
|
|
-->
|
|
|
|
<!-- DOCS-SITE-LINK:START automatically generated -->
|
|
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/guide/installation)
|
|
<!-- DOCS-SITE-LINK:END -->
|
|
|
|
# OpenWhisk - Installation
|
|
|
|
### Installing Node.js
|
|
|
|
Serverless is a [Node.js](https://nodejs.org) CLI tool so the first thing you need to do is to install Node.js on your machine.
|
|
|
|
Go to the official [Node.js website](https://nodejs.org), download and follow the [installation instructions](https://nodejs.org/en/download/) to install Node.js on your local machine.
|
|
|
|
**Note:** Serverless runs on Node v4 or higher.
|
|
|
|
You can verify that Node.js is installed successfully by running `node --version` in your terminal. You should see the corresponding Node version number printed out.
|
|
|
|
### Installing the Serverless Framework
|
|
|
|
Next, install the Serverless Framework via [npm](https://npmjs.org) which was already installed when you installed Node.js.
|
|
|
|
Open up a terminal and type `npm install -g serverless` to install Serverless.
|
|
|
|
```bash
|
|
npm install -g serverless
|
|
```
|
|
|
|
Once the installation process is done you can verify that Serverless is installed successfully by running the following command in your terminal:
|
|
|
|
```bash
|
|
serverless
|
|
```
|
|
|
|
To see which version of serverless you have installed run:
|
|
|
|
```bash
|
|
serverless --version
|
|
```
|
|
|
|
|
|
|
|
### Installing OpenWhisk Provider Plugin
|
|
|
|
Now we need to install the provider plugin to allow the framework to deploy services to the platform. This plugin is also [published](http://npmjs.com/package/serverless-openwhisk) on [npm](https://npmjs.org) and can installed using the same `npm install` command.
|
|
|
|
```
|
|
npm install -g serverless-openwhisk
|
|
```
|
|
|
|
*Due to an [outstanding issue](https://github.com/serverless/serverless/issues/2895) with provider plugins, the [OpenWhisk provider](https://github.com/serverless/serverless-openwhisk) must be installed as a global module.*
|
|
|
|
|
|
|
|
### Setting up OpenWhisk
|
|
|
|
To run serverless commands that interface with the OpenWhisk platform, you will need to setup your OpenWhisk account credentials on your machine.
|
|
|
|
[Follow these instructions on setting up OpenWhisk credentials](./credentials.md)
|