Getting started with AWS Proton - AWS Proton

AWS Proton is governed as a preview program under the AWS Service Terms. Report issues and feature requests by connecting with us at GitHub where you can open issues, provide feedback and report bugs.

  • The Preview is intended only for evaluation with development or test workloads. You should not use it for production workloads.

  • AWS may change the functionality of the Preview during and after the term of the Preview at its sole discretion or based on participant feedback. The functionality, features, and documentation may change during the Preview term and may be different from any generally available version.

  • Although the Preview is a free service, you are responsible for fees incurred for other AWS Services that you use in connection with the Preview. Standard pricing will apply for your use of those AWS Services.

Getting started with AWS Proton

Get started with AWS Proton using the AWS Management Console

  • Create and view an environment template.

  • Create, view, and publish a service template that uses the environment template that you just created.

  • Create an environment and service (optional).

  • Delete the service template, environment template, environment and service, if created.

Prerequisites

Start Getting started Step 1 after you verify that the following listed prerequisites are met. For more information, see Setting up with AWS Proton.

  • An IAM account with administrator permissions. For more information, see Setting up with IAM.

    Note

    For Public Preview, you and your team, including administrators and developers, as well as your environments, must all be under the same account.

  • The Proton service role and the Proton pipeline service role are attached to your account. For more information, see Setting up Proton service roles and Controlling access with IAM.

  • A version control repository connection. For more information, see Setting up GitHub repository connection.

  • Familiarity with creating AWS CloudFormation templates and Jinja parametrization. For more information, see What is AWS CloudFormation? in the AWS CloudFormation User Guide and Jinja website.

  • General familiarity with AWS infrastructure services.

  • You're logged into your AWS account.

Step 1: Open the Proton console

To start, you complete steps that are outlined in the Proton console's Getting Started section.

  1. Open the Proton console.

  2. In the left-hand menu, click on Getting started.

Step 2: Create an environment template

  1. In Getting started, Proton setup: Prepare the self-service portal for your developers, click on Create environment template.

  2. From the Create environment template page, in the Sample template bundle section, choose Use one of our sample template bundles.

  3. In the Sample template bundle source section, select fargate-environment.

  4. In the Template details section.

    1. Enter the template name as my-env-template.

    2. Enter the environment template display name as My Fargate Environment.

    3. (Optional) Enter a description for the environment template.

  5. Click on the Create Environment template button.

    You're now on a new page that displays the status and details for your new environment template. When the environment template is created, it's in the draft status. Only authorized administrators can view and access it. To make the environment template available for use by developers, follow the next step.

  6. In the Template versions section, click on the radio button to the left of the minor version of the template you just created (1.0).

  7. In the Template versions section, click on the Publish button.

    The first version of your environment template is published and available for use by developers.

  8. In the left-hand menu, click on Templates and select Environment templates.

    A new page displays a list of your environment templates along with status and other details.

Step 3: Create a service template

Create a service template.

  1. Navigate back to Getting started from the left-hand menu of the Proton console.

  2. In Getting started, Proton setup: Prepare the self-service portal for your developers, click on Create a service template.

  3. From the Create service template page, in the Sample template bundle section, choose Use one of our sample template bundles.

  4. In the Template details section.

    1. Enter the service template name as my-svc-template.

    2. Enter the service template display name as My Fargate Service.

    3. (Optional) Enter a description for the service template.

  5. In the Compatible environment templates section.

    1. Check the check-box to the left of the environment template My Fargate Environment to select the compatible environment template for the new service template.

  6. For Encryption settings, keep the defaults.

  7. Click on the Create Service template button.

    You're now on a new page that displays the status and details for your new service template. When the service template is created, it's in the draft status. Only authorized administrators can view and access it. To make the service template available for use by developers, follow the next step.

  8. In the Template versions section, click on the radio button to the left of the minor version of the template you just created (1.0).

  9. In the Template versions section, click on the Publish button.

    The first minor version of your service template is published and available for use by developers. Because it's the latest version of the template, it's the Recommended version.

  10. In the left-hand menu, click on Templates and select Service templates.

    A new page displays a list of your service templates, their status and other details. You can choose to view all your templates or only published templates.

Step 4: Create an environment

  1. Navigate back to Getting started from the left-hand menu of the Proton console.

  2. In Getting started, Proton setup: Prepare the self-service portal for your developers, click on Create environment.

  3. From the Create environment page, select the template you just created named My Fargate Environment and click on Next.

  4. Enter the environment name as my-fargate-environment.

  5. Select the ARN of the Proton service role that you created as part of Setting up Proton service roles.

  6. Click on Next.

  7. On the Configure environment custom settings page, use the defaults.

  8. Click on Create.

    View the environment details for your environment.

  9. In the left-hand menu, click on Environments.

    A new page displays a list of your environments along with status and other details.

Step 5: Optional - Create a service and deploy an application

  • After the environment is created and enters the active status, launch a service based on your service template and environment. To do this, follow the instructions at Create a service in the AWS Proton User Guide.

Step 6: Clean up.

  1. Delete a service (if you created one)

    To delete the service, follow the instructions at Delete a service in the AWS Proton User Guide.

  2. Open the Proton console.

  3. Delete an environment

    1. In the left-hand menu, click on Environments.

    2. In the Environments page, select the environment that you just created.

    3. In the upper right-hand corner, click on Actions, then Delete.

    4. From a new window, Proton prompts you to confirm the delete action.

    5. Follow the instructions and click on Yes, delete.

  4. Delete a service template

    1. In the left-hand menu, click on Templates and select Service templates.

    2. In the Service templates page, select the service template my-svc-template.

      You're now on the service template detail page for my-svc-template.

    3. In the upper right-hand corner, click on Delete.

    4. From a new window, Proton prompts you to confirm the delete action.

    5. Follow the instructions and click on Yes, delete. This deletes the service template and all of its versions.

  5. Delete an environment template

    1. In the left-hand menu, click on Templates and select Environment templates.

    2. In the Environment templates page, select the environment template my-env-template.

      You're now on the environment template detail page for my-env-template.

    3. In the upper right-hand corner, click on Delete.

    4. From a new window, Proton prompts you to confirm the delete action.

    5. Follow the instructions and click on Yes, delete. This deletes the environment template and all of its versions.