AWS App Runner Developer Guide AWS App Runner Developer Guide
Total Page:16
File Type:pdf, Size:1020Kb
AWS App Runner Developer Guide AWS App Runner Developer Guide AWS App Runner: Developer Guide Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS App Runner Developer Guide Table of Contents What is AWS App Runner? .................................................................................................................. 1 Who is App Runner for? .............................................................................................................. 1 Accessing App Runner ................................................................................................................. 1 Pricing for App Runner ............................................................................................................... 2 What's next ............................................................................................................................... 2 Setting up ......................................................................................................................................... 3 Create an AWS account ............................................................................................................... 3 Create an IAM user ..................................................................................................................... 3 Create an access key for your IAM user ......................................................................................... 4 What's next ............................................................................................................................... 5 Getting started .................................................................................................................................. 6 Prerequisites .............................................................................................................................. 6 Step 1: Create an App Runner service ........................................................................................... 7 Step 2: Change your service code ............................................................................................... 12 Step 3: Make a configuration change .......................................................................................... 13 Step 4: View logs for your service .............................................................................................. 14 Step 5: Clean up ...................................................................................................................... 16 What's next ............................................................................................................................. 17 Architecture and concepts ................................................................................................................. 18 App Runner concepts ................................................................................................................ 18 App Runner resources ............................................................................................................... 19 App Runner resource quotas ...................................................................................................... 20 Image-based service ......................................................................................................................... 21 Image repository providers ........................................................................................................ 21 Using an image stored in Amazon ECR in your AWS account ................................................... 21 Using an image stored in Amazon ECR in a different AWS account ........................................... 22 Using an image stored in Amazon ECR Public ...................................................................... 22 Image example ........................................................................................................................ 22 Code-based service ........................................................................................................................... 23 Source code repository providers ................................................................................................ 23 Deploying from GitHub ..................................................................................................... 23 App Runner managed runtimes .................................................................................................. 24 Python runtime ........................................................................................................................ 24 Python runtime configuration ............................................................................................ 25 Python runtime examples .................................................................................................. 25 Release information .......................................................................................................... 27 Node.js runtime ....................................................................................................................... 27 Node.js runtime configuration ............................................................................................ 27 Node.js runtime examples ................................................................................................. 29 Release information .......................................................................................................... 31 Developing for App Runner ............................................................................................................... 32 Runtime information ................................................................................................................ 32 Code development guidelines .................................................................................................... 32 App Runner console ......................................................................................................................... 34 Overall console layout .............................................................................................................. 34 The Services page .................................................................................................................... 34 The service dashboard page ...................................................................................................... 35 The GitHub connections page .................................................................................................... 35 Managing your service ...................................................................................................................... 37 Creation .................................................................................................................................. 37 Prerequisites .................................................................................................................... 37 Create a service ............................................................................................................... 37 When service creation fails ................................................................................................ 47 Deployment ............................................................................................................................. 48 iii AWS App Runner Developer Guide Deployment methods ....................................................................................................... 48 Manual deployment .......................................................................................................... 49 Configuration ........................................................................................................................... 50 Configure your service using the App Runner API or AWS CLI ................................................. 50 Configure your service using the App Runner console ........................................................... 50 Configure your service using an App Runner configuration file ............................................... 51 Health check configuration ................................................................................................ 51 Connections ............................................................................................................................. 53 Manage connections using the App Runner console .............................................................. 54 Manage connections using the App Runner API or AWS CLI .................................................... 54 Auto scaling ............................................................................................................................ 55 Manage auto scaling using the App Runner console .............................................................. 56 Manage auto scaling using the App Runner API or AWS CLI ................................................... 56 Custom domain names ............................................................................................................