Update documentation to use the new „config credentials“ commands

This commit is contained in:
Philipp Muens 2016-12-01 11:50:58 +01:00
parent f36c119556
commit 0baf2ebc8c
4 changed files with 56 additions and 54 deletions

View File

@ -47,7 +47,7 @@ The Serverless Framework allows you to deploy auto-scaling, pay-per-execution, e
</div>
<div>
<ul>
<li><a href="./providers/aws/cli-reference/setup.md">Setup</a></li>
<li><a href="./providers/aws/cli-reference/config.md">Config</a></li>
<li><a href="./providers/aws/cli-reference/create.md">Create</a></li>
<li><a href="./providers/aws/cli-reference/install.md">Install</a></li>
<li><a href="./providers/aws/cli-reference/deploy.md">Deploy</a></li>

View File

@ -0,0 +1,50 @@
<!--
title: Serverless Framework Commands - AWS Lambda - Config
menuText: Config
menuOrder: 10
description: Configure Serverless.
layout: Doc
-->
<!-- DOCS-SITE-LINK:START automatically generated -->
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/config)
<!-- DOCS-SITE-LINK:END -->
# Config
This plugin helps you to configure Serverless.
## Configure credentials
```bash
serverless config credentials --provider provider --key key --secret secret
```
### Options
- `--provider` or `-p` The provider (in this case `aws`). **Required**.
- `--key` or `-k` The `aws_access_key_id`. **Required**.
- `--secret` or `-s` The `aws_secret_access_key`. **Required**.
- `--profile` or `-n` The name of the profile which should be created.
### Provided lifecycle events
- `config:credentials:credentials`
### Examples
#### Configure the `default` profile
```bash
serverless config credentials --provider aws --key 1234 --secret 5678
```
This example will configure the `default` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.
#### Configure a custom profile
```bash
serverless config credentials --provider aws --key 1234 --secret 5678 --profile custom-profile
```
This example create and configure a `custom-profile` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.

View File

@ -1,48 +0,0 @@
<!--
title: Serverless Framework Commands - AWS Lambda - Setup
menuText: Setup
menuOrder: 10
description: Easily set up AWS profiles.
layout: Doc
-->
<!-- DOCS-SITE-LINK:START automatically generated -->
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/providers/aws/cli-reference/setup)
<!-- DOCS-SITE-LINK:END -->
# Setup
This plugin helps you with the setup of your AWS profiles.
```bash
serverless setup --provider provider --key key --secret secret
```
## Options
- `--provider` or `-p` The provider (in this case `aws`). **Required**.
- `--key` or `-k` The `aws_access_key_id`. **Required**.
- `--secret` or `-s` The `aws_secret_access_key`. **Required**.
- `--profile` or `-n` The name of the profile which should be created.
## Provided lifecycle events
- `setup:setup`
## Examples
### Setup the `default` profile
```bash
serverless setup --provider aws --key 1234 --secret 5678
```
This example will setup the `default` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.
### Setup a custom profile
```bash
serverless setup --provider aws --key 1234 --secret 5678 --profile custom-profile
```
This example create and setup a `custom-profile` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.

View File

@ -71,17 +71,17 @@ serverless deploy
For a more permanent solution you can also set up credentials through AWS profiles. Here are different methods you can use to do so.
##### Setup with `serverless setup` command
##### Setup with `serverless config credentials` command
Serverless provides a convenient way to setup AWS profiles with the help of the `serverless setup` command.
Serverless provides a convenient way to configure AWS profiles with the help of the `serverless config credentials` command.
Here's an example how you can setup the `default` AWS profile:
Here's an example how you can configure the `default` AWS profile:
```bash
serverless setup --provider aws --key AKIAIOSFODNN7EXAMPLE --secret wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
serverless config credentials --provider aws --key AKIAIOSFODNN7EXAMPLE --secret wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
```
Take a look at the [`setup` CLI reference](../cli-reference/setup.md) for more information about profile setup.
Take a look at the [`config` CLI reference](../cli-reference/config.md) for more information about credential configuration.
##### Setup with the `aws-cli`