mirror of
https://github.com/serverless/serverless.git
synced 2026-01-25 15:07:39 +00:00
docs: Removing pages on deprecated features
This commit is contained in:
Maciej Skierkowski
Mariusz Nowak
parent
b30c95ca69
commit
87f211d0bb
@ -1,45 +0,0 @@
|
||||
<!--
|
||||
title: Serverless Dashboard - Access Roles
|
||||
menuText: Access Roles
|
||||
menuOrder: 2
|
||||
layout: Doc
|
||||
-->
|
||||
|
||||
<!-- DOCS-SITE-LINK:START automatically generated -->
|
||||
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/guides/access-roles/)
|
||||
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
> This document page is related to the deprecated dashboard. We advise using the updated dashboard at app.serverless.com and using the new [Providers feature to manage AWS connections](https://www.serverless.com/framework/docs/guides/providers/) for any new orgs created.
|
||||
|
||||
# Access Roles
|
||||
|
||||
You can use the Serverless Framework Dashboard to set up an AWS Access Role to help you secure your service deployments on AWS by enabling the Serverless Framework to issue temporary AWS Access Keys to deploy your services to AWS.
|
||||
|
||||
If an Access Role is not configured, the Serverless Framework service will use AWS Access Keys stored in [environment variables](https://serverless.com/framework/docs/providers/aws/guide/credentials/) or [AWS Profiles](https://serverless.com/framework/docs/providers/aws/guide/credentials/) to deploy your service.
|
||||
|
||||
With AWS Access Roles the AWS Access Keys are generated by Serverless Framework on every command and the credentials expire after one hour. The Serverless Framework leverages AWS Security Token Service and the AssumeRole API to automate creating and usage of temporary credentials, so your developers can stay productive and work securely without doing this manually.
|
||||
|
||||
If you do not use the Serverless Framework Dashboard to set up an AWS Access Role, then you will need to configure your Serverless Framework open source CLI to use the AWS Access Keys stored in [environment variables](https://serverless.com/framework/docs/providers/aws/guide/credentials/) or [AWS Profiles](https://serverless.com/framework/docs/providers/aws/guide/credentials/).
|
||||
|
||||
## Link your AWS Account
|
||||
|
||||
1. Open the [Dashboard](https://app.serverless.com/)
|
||||
2. Once logged in, click "**profiles**" near the top of the page.
|
||||
3. Navigate to the profile you would like to configure with the AWS Access Role.
|
||||
4. In the **AWS account** tab, click **connect aws** button.
|
||||
5. Follow the instructions on AWS which will take you through creating an IAM Role for the Serverless Framework.
|
||||
6. Once the IAM Role is created, your profile will be automatically updated.
|
||||
|
||||
## Use the generated AWS Access Keys in your service
|
||||
|
||||
You don't have to do anything in your `serverless.yml` file. When you run `sls deploy` the Serverless Framework will identify the deployment profile associated with the application or stage and it will generate the AWS Access Keys using the associated AWS Access Role automatically.
|
||||
|
||||
## Deploy using AWS Access Roles
|
||||
|
||||
That’s it! You are now ready to deploy using your AWS Access Roles.
|
||||
|
||||
```
|
||||
serverless deploy
|
||||
```
|
||||
@ -1,59 +0,0 @@
|
||||
<!--
|
||||
title: Serverless Dashboard - Profiles
|
||||
menuText: Profiles
|
||||
menuOrder: 7
|
||||
layout: Doc
|
||||
-->
|
||||
|
||||
<!-- DOCS-SITE-LINK:START automatically generated -->
|
||||
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/guides/profiles/)
|
||||
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
> This is a deprecated feature of the dashboard. Please look at our documentation for [Providers](https://www.serverless.com/framework/docs/guides/providers/) and
|
||||
> [Parameters](https://www.serverless.com/framework/docs/guides/parameters/) which replaces the use of deployment profiles for setting up AWS connections and parameters.
|
||||
|
||||
# Deployment Profiles
|
||||
|
||||
Deployment Profiles enable each stage of your Serverless application to use a unique set of [Safeguards](./safeguards.md), [Parameters](./parameters.md) and [Access Roles](./access-roles.md).
|
||||
|
||||
## Use Deployment Profiles
|
||||
|
||||
Deployment profiles are managed in the [Serverless Framework Dashboard](https://app.serverless.com). When you run `serverless deploy`, the CLI obtains the Safeguard policies, Parameters, and the generated AWS Credentials.
|
||||
|
||||
### Creating a new Deployment Profile
|
||||
|
||||
Create a new deployment profile by navigating to **profiles** in the [Serverless Framework Dashboard](https://app.serverless.com) and click **add**.
|
||||
|
||||
#### name
|
||||
|
||||
This is a user-readable name for the deployment profile. Most often it has a name that maps to a stage (e.g. “dev”, “prod”), or in larger organizations the line of business or environment (e.g. “apac-banking-prod”). This name will uniquely identify the deployment profile when associating it with a stage in an application.
|
||||
|
||||
#### description
|
||||
|
||||
The description helps provide additional context when listing the deployment profiles.
|
||||
|
||||
#### access roles, parameters and safeguards
|
||||
|
||||
Access Roles, Parameters and Safeguards have individual configuration guides:
|
||||
|
||||
- [access roles](./access-roles.md#link-your-aws-account)
|
||||
- [safeguard policies](./safeguards.md#configuring-policies)
|
||||
- [parameters](./parameters.md)
|
||||
|
||||
### Add a deployment profile to your application and stage
|
||||
|
||||
Create a new stage by navigating to **applications** in the [Serverless Framework Dashboard](https://app.serverless.com).
|
||||
|
||||
1. Expand the application and click into the **stages** tab.
|
||||
2. Click **add stage** in the tab
|
||||
3. Provide the **name** and select the **deployment profile**.
|
||||
|
||||
You can also set the **default deployment profile** field in the application. You can use this to set the deployment profile on all services in that application. When deploying to a stage which hasn't be defined in the dashboard, then the default deployment profile will be used.
|
||||
|
||||
### Using a Deployment Profile to deploy
|
||||
|
||||
When you run `serverless deploy` Serverless Framework will obtain the AWS Access Key, Parameter and Safeguards associated with the deployment profile configured for that application and stage based on the values for `app` and `stage` in your `serverless.yml` file.
|
||||
|
||||
The Serverless Framework will first try to match the current stage from `serverless.yml` with a stage configured on that application in the dashboard. If they match, it will use the deployment profile associated with that stage. If the stages do not match, then the default deployment profile from that application will be used.
|
||||
@ -1,20 +0,0 @@
|
||||
<!--
|
||||
title: Serverless Dashboard - Safeguards
|
||||
menuText: Safeguards
|
||||
menuOrder: 9
|
||||
layout: Doc
|
||||
-->
|
||||
|
||||
<!-- DOCS-SITE-LINK:START automatically generated -->
|
||||
|
||||
### [Read this on the main serverless docs site](https://www.serverless.com/framework/docs/guides/safeguards/)
|
||||
|
||||
<!-- DOCS-SITE-LINK:END -->
|
||||
|
||||
# Safeguards
|
||||
|
||||
**Safeguards** is a policy-as-code framework for Serverless Framework which enables you to inspect your serverless.yml file, and the generated Cloud Formation templates, for compliance with security, operational, and organizational, best practices.
|
||||
|
||||
Safeguards was a feature of the Serverless Framework dashboard and available under the legacy team tier. On August 1st, 2020, it was open sourced and made available free-of-charge as a stand-alone Serverless Framework Plugin free of charge.
|
||||
|
||||
You can find the new plugin at [serverless/safeguards-plugin](https://github.com/serverless/safeguards-plugin/).
|
||||
Loading…
x
Reference in New Issue
Block a user