mirror of
https://github.com/serverless/serverless.git
synced 2026-01-25 15:07:39 +00:00
update headers for doc search
This commit is contained in:
davidwells
parent
3d3821c385
commit
f9d2bbbcf2
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/config-credentials)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Config Credentials
|
||||
# AWS - Config Credentials
|
||||
|
||||
```bash
|
||||
serverless config credentials --provider provider --key key --secret secret
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/create)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Create
|
||||
# AWS - Create
|
||||
|
||||
Creates a new service in the current working directory based on the provided template.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy-function)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy Function
|
||||
# AWS - Deploy Function
|
||||
|
||||
The `sls deploy function` command deploys an individual function without AWS CloudFormation. This command simply swaps out the zip file that your CloudFormation stack is pointing toward. This is a much faster way of deploying changes in code.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy-list)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy List
|
||||
# AWS - Deploy List
|
||||
|
||||
The `sls deploy list` command will list your recent deployments available in your S3 deployment bucket. It will use stage and region from the provider config and show the timestamp of each deployment so you can roll back if necessary using `sls rollback`.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/deploy)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy
|
||||
# AWS - deploy
|
||||
|
||||
The `sls deploy` command deploys your entire service via CloudFormation. Run this command when you have made infrastructure changes (i.e., you edited `serverless.yml`). Use `serverless deploy function -f myFunction` when you have made code changes and you want to quickly upload your updated code to AWS Lambda.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/info)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Info
|
||||
# AWS - Info
|
||||
|
||||
Displays information about the deployed service.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/install)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Install
|
||||
# AWS - Install
|
||||
|
||||
Installs a service from a GitHub URL in the current working directory.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke-local)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Invoke Local
|
||||
# AWS - Invoke Local
|
||||
|
||||
This runs your code locally by emulating the AWS Lambda environment. Please keep in mind, it's not a 100% perfect emulation, there may be some differences, but it works for the vast majority of users. We mock the `context` with simple mock data.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/invoke)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Invoke
|
||||
# AWS - Invoke
|
||||
|
||||
Invokes deployed function. It allows to send event data to the function, read logs and display other important information of the function invocation.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/logs)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Logs
|
||||
# AWS - Logs
|
||||
|
||||
Lets you watch the logs of a specific function.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/metrics)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Metrics
|
||||
# AWS - Metrics
|
||||
|
||||
Lets you watch the metrics of a specific function.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/remove)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Remove
|
||||
# AWS - Remove
|
||||
|
||||
The `sls remove` command will remove the deployed service, defined in your current working directory, from the provider.
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ layout: Doc
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
|
||||
# Rollback
|
||||
# AWS - Rollback
|
||||
|
||||
Rollback the Serverless service to a specific deployment.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/credentials)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Credentials
|
||||
# AWS - Credentials
|
||||
|
||||
The Serverless Framework needs access to your cloud provider's account so that it can create and manage resources on your behalf.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/deploying)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploying
|
||||
# AWS - Deploying
|
||||
|
||||
The Serverless Framework was designed to provision your AWS Lambda Functions, Events and infrastructure Resources safely and quickly. It does this via a couple of methods designed for different types of deployments.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/events)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Events
|
||||
# AWS - Events
|
||||
|
||||
Simply put, events are the things that trigger your functions to run.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/functions)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Functions
|
||||
# AWS - Functions
|
||||
|
||||
If you are using AWS as a provider, all *functions* inside the service are AWS Lambda functions.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/installation)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Installation
|
||||
# AWS - Installation
|
||||
|
||||
### Installing Node.js
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/intro)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Introduction
|
||||
# AWS - Introduction
|
||||
|
||||
The Serverless Framework helps you develop and deploy your AWS Lambda functions, along with the AWS infrastructure resources they require. It's a CLI that offers structure, automation and best practices out-of-the-box, allowing you to focus on building sophisticated, event-driven, serverless architectures, comprised of [Functions](#functions) and [Events](#events).
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/packaging)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Packaging
|
||||
# AWS - Packaging
|
||||
|
||||
Sometimes you might like to have more control over your function artifacts and how they are packaged.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/guide/resources)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Resources
|
||||
# AWS - Resources
|
||||
|
||||
If you are using AWS as a provider for your Service, all *Resources* are other AWS infrastructure resources which the AWS Lambda functions in your *Service* depend on, like AWS DynamoDB or AWS S3.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Serverless Framework Commands - Azure Functions - Deploy Function
|
||||
menuText: Deploy Function
|
||||
menuOrder: 5
|
||||
description: Deploy your Azure Functions functions quickly
|
||||
description: Deploy your Azure Functions functions quickly
|
||||
layout: Doc
|
||||
-->
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/deploy-function)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy Function
|
||||
# Azure - Deploy Function
|
||||
|
||||
The `sls deploy function` command deploys an individual function. This command simply compiles a deployment package with a single function handler. This is a much faster way of deploying changes in code.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/deploy)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy
|
||||
# Azure - Deploy
|
||||
|
||||
The `sls deploy` command deploys your entire service via the Azure Resource Manager API. Run this command when you have made service changes (i.e., you edited `serverless.yml`). Use `serverless deploy function -f myFunction` when you have made code changes and you want to quickly upload your updated code to Azure Functions.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/install)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Install
|
||||
# Azure - Install
|
||||
|
||||
Installs a service from a GitHub URL in the current working directory.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/invoke)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Invoke
|
||||
# Azure - Invoke
|
||||
|
||||
Invokes deployed function. It allows to send event data to the function, read logs and display other important information of the function invocation.
|
||||
|
||||
@ -30,7 +30,7 @@ serverless invoke --function functionName
|
||||
### Azure Functions
|
||||
|
||||
```bash
|
||||
serverless invoke --function functionName
|
||||
serverless invoke --function functionName
|
||||
```
|
||||
|
||||
This example will invoke your deployed function on the configured platform
|
||||
@ -39,13 +39,13 @@ endpoint. This will output the result of the invocation in your terminal.
|
||||
#### Function invocation with data
|
||||
|
||||
```bash
|
||||
serverless invoke --function functionName --data '{"name": "Bernie"}'
|
||||
serverless invoke --function functionName --data '{"name": "Bernie"}'
|
||||
```
|
||||
|
||||
#### Function invocation with data from standard input
|
||||
|
||||
```bash
|
||||
node dataGenerator.js | serverless invoke --function functionName
|
||||
node dataGenerator.js | serverless invoke --function functionName
|
||||
```
|
||||
|
||||
#### Function invocation with data passing
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/logs)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Logs
|
||||
# Azure - Logs
|
||||
|
||||
Lets you watch the logs of a specific function.
|
||||
|
||||
@ -30,4 +30,3 @@ serverless logs -f hello
|
||||
serverless logs -f hello
|
||||
```
|
||||
This will stream all future logs for a given Function.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/azure/cli-reference/remove)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Remove
|
||||
# Azure - Remove
|
||||
|
||||
The `sls remove` command will remove the deployed service, defined in your current working directory, from the provider.
|
||||
|
||||
@ -23,10 +23,10 @@ serverless remove
|
||||
|
||||
## Examples
|
||||
|
||||
### Removal of service
|
||||
### Removal of service
|
||||
|
||||
```bash
|
||||
serverless remove
|
||||
serverless remove
|
||||
```
|
||||
|
||||
This example will remove the deployed service of your current working directory from the current platform endpoint.
|
||||
|
||||
@ -10,10 +10,10 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/config-credentials)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Config Credentials
|
||||
# OpenWhisk - Config Credentials
|
||||
|
||||
```bash
|
||||
serverless config credentials --provider provider --apihost apihost --auth auth
|
||||
serverless config credentials --provider provider --apihost apihost --auth auth
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/create)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Create
|
||||
# OpenWhisk - Create
|
||||
|
||||
Creates a new service in the current working directory based on the provided template.
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
title: Serverless Framework Commands - Apache OpenWhisk - Deploy Function
|
||||
menuText: Deploy Function
|
||||
menuOrder: 5
|
||||
description: Deploy your Apache OpenWhisk functions quickly
|
||||
description: Deploy your Apache OpenWhisk functions quickly
|
||||
layout: Doc
|
||||
-->
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/deploy-function)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy Function
|
||||
# OpenWhisk - Deploy Function
|
||||
|
||||
The `sls deploy function` command deploys an individual function. This command simply compiles a deployment package with a single function handler. This is a much faster way of deploying changes in code.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/deploy)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Deploy
|
||||
# OpenWhisk - Deploy
|
||||
|
||||
The `sls deploy` command deploys your entire service via the Apache OpenWhisk platform API. Run this command when you have made service changes (i.e., you edited `serverless.yml`). Use `serverless deploy function -f myFunction` when you have made code changes and you want to quickly upload your updated code to Apache OpenWhisk.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/info)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Info
|
||||
# OpenWhisk - Info
|
||||
|
||||
Displays information about the deployed service.
|
||||
|
||||
@ -52,5 +52,5 @@ my-hello-world-event-rule
|
||||
|
||||
endpoints:
|
||||
https://xyz1234-gws.api-gw.mybluemix.net
|
||||
/hello-world GET -> hello-world
|
||||
/hello-world GET -> hello-world
|
||||
```
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/install)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Install
|
||||
# OpenWhisk - Install
|
||||
|
||||
Installs a service from a GitHub URL in the current working directory.
|
||||
|
||||
|
||||
@ -10,9 +10,9 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/invoke-local)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Invoke Local
|
||||
# OpenWhisk - Invoke Local
|
||||
|
||||
This runs your code locally by emulating the Apache OpenWhisk environment. Please keep in mind, it's not a 100% perfect emulation, there may be some differences, but it works for the vast majority of users.
|
||||
This runs your code locally by emulating the Apache OpenWhisk environment. Please keep in mind, it's not a 100% perfect emulation, there may be some differences, but it works for the vast majority of users.
|
||||
|
||||
```bash
|
||||
serverless invoke local --function functionName
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/invoke)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Invoke
|
||||
# OpenWhisk - Invoke
|
||||
|
||||
Invokes deployed function. It allows to send event data to the function, read logs and display other important information of the function invocation.
|
||||
|
||||
@ -47,7 +47,7 @@ root directory of the service. The json file should have event and context prope
|
||||
### Apache OpenWhisk
|
||||
|
||||
```bash
|
||||
serverless invoke --function functionName
|
||||
serverless invoke --function functionName
|
||||
```
|
||||
|
||||
This example will invoke your deployed function on the configured platform
|
||||
@ -56,13 +56,13 @@ endpoint. This will output the result of the invocation in your terminal.
|
||||
#### Function invocation with data
|
||||
|
||||
```bash
|
||||
serverless invoke --function functionName --data '{"name": "Bernie"}'
|
||||
serverless invoke --function functionName --data '{"name": "Bernie"}'
|
||||
```
|
||||
|
||||
#### Function invocation with data from standard input
|
||||
|
||||
```bash
|
||||
node dataGenerator.js | serverless invoke --function functionName
|
||||
node dataGenerator.js | serverless invoke --function functionName
|
||||
```
|
||||
|
||||
#### Function invocation with logging
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/logs)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Logs
|
||||
# OpenWhisk - Logs
|
||||
|
||||
Lets you watch the logs of a specific function.
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ layout: Doc
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/openwhisk/cli-reference/remove)
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Remove
|
||||
# OpenWhisk - Remove
|
||||
|
||||
The `sls remove` command will remove the deployed service, defined in your current working directory, from the provider.
|
||||
|
||||
@ -26,7 +26,7 @@ serverless remove
|
||||
### Removal of service in specific stage and region
|
||||
|
||||
```bash
|
||||
serverless remove
|
||||
serverless remove
|
||||
```
|
||||
|
||||
This example will remove the deployed service of your current working directory from the current platform endpoint.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user