archive-gh-me/serverless
1
0
Fork 0
mirror of https://github.com/serverless/serverless.git synced 2026-01-25 15:07:39 +00:00
Code Issues Projects Releases Wiki Activity

Adding Output Variables page.

Browse Source
This commit is contained in:
Bill Fine 2019-07-13 17:48:26 -07:00 committed by GitHub
parent b32003393a
commit 065c1087fd
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 50 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
docs/dashboard/output_variables Normal file
View File

@ -0,0 +1,50 @@
<!--
title: Serverless Dashboard - Output Variables
menuText: Output Variables
layout: Doc
-->
<!-- DOCS-SITE-LINK:START automatically generated -->
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/)
<!-- DOCS-SITE-LINK:END -->
# Output Variables
The Serverless Framework Dashboard helps you refactor large serverless applications by decoupling the shared services from the dependent services. The new output variables feature allows you to define output variables in a `serverless.yml` and then reference those variables in other `serverless.yml` files. The values are published to Serverless Framework Dashboard when you deploy, and they are loaded in other services when they are deployed.
## Define output variables for shared services
Define new output variables by adding a dictionary (key/value pairs) to the `outputs:` field in the `serverless.yml` file. The values can include any value supported by YAML including strings, integers, lists (arrays), and dictionaries (key/value pairs). The dictionaries can also be nested to any depth.
**serverless.yml**
```yaml
outputs:
my-key: my-value
my-availability-zones:
- us-east-1a
- us-east-1b
my-table-name: DynamoDbTable-${self:custom.stage}
```
The values will be interpolated and saved when the service is deployed. The values are saved as a part of the service instance so they are associated with the service, stage and region.
## Use output variables in dependent services
Output variables can be consumed from other services with they `${state}` variable. The reference must be formatted as `<service-id>.<key>`, where the `<service-id>` references another service in the same application, stage and region and the `<key>` references the dictionary key from the `outputs:`. The `<key>` can also be nested to reference nested values from the dictionary.
**serverless.yml**
```yaml
${state:my-service.var-key}
```
## View output variables in the dashboard
The output variables for a service are made available on two different pages of the Serverless Framework Dashboard.
The current output variables for a given service instance are available in the **Variables** > **Output** section of the service instance view. This will show the values which are currently available.
The historic output variables for a given service instance are available as a part of the deployment record which is available in the **activity & insights** section of the service instance view after a deployment.