Update Examples for Tencent Cloud and SCF

Author: stevapple

.gitignore

@@ -8,4 +8,5 @@
 xcuserdata
 Package.resolved
 .serverless
-docker
+docker
+.env

Examples/CloudFunctions/Dockerfile

@@ -1,3 +1 @@
-FROM swift:5.2-amazonlinux2
-
-RUN yum -y install zip
+FROM stevapple/swift-scf:5.2.5

Examples/CloudFunctions/README.md

@@ -13,165 +13,93 @@ cd swift-tencent-scf-runtime/Examples/CloudFunctions
 
 Note: The example scripts assume you have [jq](https://stedolan.github.io/jq/download/) command line tool installed.
 
-## Deployment instructions using AWS CLI
+## Deployment instructions using TCCLI
 
-Steps to deploy this sample to AWS Lambda using the AWS CLI:
+Steps to deploy this sample to Tencent SCF Platform using TCCLI:
 
-1. Login to AWS Console and create an AWS Lambda with the following settings:
-  * Runtime: Custom runtime
-  * Handler: Can be any string, does not matter in this case
+1. Login to SCF Console and create a cloud function
+2. Build, package and deploy the function
 
-2. Build, package and deploy the Lambda
-
-  ```
-  ./scripts/deploy.sh
-  ```
-
-  Notes: 
-  - This script assumes you have AWS CLI installed and credentials setup in `~/.aws/credentials`.
-  - The default lambda function name is `SwiftSample`. You can specify a different one updating `lambda_name` in `deploy.sh`
-  - Update `s3_bucket=swift-lambda-test` in `deploy.sh` before running (AWS S3 buckets require a unique global name)
-  - Both lambda function and S3 bucket must exist before deploying for the first time.
-
-### Deployment instructions using AWS SAM (Serverless Application Model)
-
-AWS [Serverless Application Model](https://aws.amazon.com/serverless/sam/) (SAM) is an open-source framework for building serverless applications. This framework allows you to easily deploy other AWS resources and more complex deployment mechanisms such a CI pipelines.
-
-***Note:*** Deploying using SAM will automatically create resources within your AWS account. Charges may apply for these resources.
-
-To use SAM to deploy this sample to AWS:
-
-1. Install the AWS CLI by following the [instructions](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html).
-
-2. Install SAM CLI by following the [instructions](https://aws.amazon.com/serverless/sam/).
-
-3. Build, package and deploy the Lambda
-
-  ```
-  ./scripts/sam-deploy.sh --guided
-  ```
-
-The script will ask you which sample Lambda you wish to deploy. It will then guide you through the SAM setup process.
-
-  ```
-        Setting default arguments for 'sam deploy'
-	=========================================
-	Stack Name [sam-app]: tencent-scf-runtime-sample
-	AWS Region [us-east-1]: <your-favourite-region>
-	#Shows you resources changes to be deployed and require a 'Y' to initiate deploy
-	Confirm changes before deploy [y/N]: Y
-	#SAM needs permission to be able to create roles to connect to the resources in your template
-	Allow SAM CLI IAM role creation [Y/n]: Y
-	Save arguments to samconfig.toml [Y/n]: Y
-  ```
-
-If you said yes to confirm changes, SAM will ask you to accept changes to the infrastructure you are setting up. For more on this, see [Cloud Formation](https://aws.amazon.com/cloudformation/).
-
-The `sam-deploy` script passes through any parameters to the SAM deploy command.
-
-4. Subsequent deploys can just use the command minus the `guided` parameter:
-
-  ```
-  ./scripts/sam-deploy.sh
-  ```
-
-The script will ask you which sample Lambda you wish to deploy. If you are deploying a different sample lambda, the deploy process will pull down the previous Lambda.
-
-SAM will still ask you to confirm changes if you said yes to that initially.
-
-5. Testing
-
-For the API Gateway sample:
-
-The SAM template will provide an output labelled `LambdaApiGatewayEndpoint` which you can use to test the Lambda. For example:
-
-  ```
-  curl <<LambdaApiGatewayEndpoint>>
-  ```  
-
-***Warning:*** This SAM template is only intended as a sample and creates a publicly accessible HTTP endpoint.
-
-For all other samples use the AWS Lambda console.
+```
+./scripts/deploy.sh
+```
 
-### Deployment instructions using Serverless Framework (serverless.com)
+Notes: 
+- This script assumes you have TCCLI installed and user configured (See https://cloud.tencent.com/document/product/440/34012).
+- You'll be prompted to provide the COS bucket ID and region, and the SCF function name and region.
+- Both the cloud function and COS bucket must exist before deploying for the first time.
 
-[Serverless framework](https://www.serverless.com/open-source/) (Serverless) is a provider agnostic, open-source framework for building serverless applications. This framework allows you to easily deploy other AWS resources and more complex deployment mechanisms such a CI pipelines. Serverless Framework offers solutions for not only deploying but also testing, monitoring, alerting, and security and is widely adopted by the industry and offers along the open-source version a paid one.
+### Deployment instructions using Serverless Framework for Tencent (serverless.com/cn)
 
-***Note:*** Deploying using Serverless will automatically create resources within your AWS account. Charges may apply for these resources.
+[Serverless framework](https://www.serverless.com/open-source/) (Serverless) is a provider agnostic, open-source framework for building serverless applications. [Serverless framework for Tencent](https://www.serverless.com/cn/) is a highly customized version that allows you to easily deploy other Tencent Cloud resources and more complex deployment mechanisms such a CI pipelines. Serverless Framework offers solutions for not only deploying but also testing, monitoring, alerting, and security and is widely adopted by the industry, and the Tencent Cloud version is totally free.
 
-To use Serverless to deploy this sample to AWS:
+***Note:*** Deploying using Serverless will automatically create resources within your Tencent Cloud account. Charges may apply for these resources.
 
-1. Install the AWS CLI by following the [instructions](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-install.html).
+To use Serverless to deploy this sample to Tencent Cloud:
 
-2. Install Serverless by following the [instructions](https://www.serverless.com/framework/docs/getting-started/).
-If you already have installed be sure you have the latest version.
-The examples have been tested with the version 1.72.0.
+1. Install Serverless by following the [instructions](https://www.serverless.com/framework/docs/getting-started/).
+If you already have installed, be sure you have the latest version.
+The examples have been tested with the version 1.78.1.
 
 ```
-Serverless --version
-Framework Core: 1.72.0 (standalone)
-Plugin: 3.6.13
+$ serverless --version
+Framework Core: 1.78.1
+Plugin: 3.7.0
 SDK: 2.3.1
-Components: 2.30.12
+Components: 2.34.1
 ```
 
-3. Build, package and deploy the Lambda
+2. Build, package and deploy the cloud function
 
-  ```
-  ./scripts/serverless-deploy.sh
-  ```
-
-The script will ask you which sample Lambda you wish to deploy.
-
-The `serverless-deploy.sh` script passes through any parameters to the Serverless deploy command.
+```
+./scripts/serverless-deploy.sh
+```
 
-4. Testing
+The script will ask you which sample function you wish to deploy.
 
-For the APIGateway sample:
+3. Test
 
-The Serverless template will provide an endpoint which you can use to test the Lambda. 
+For the APIGateway sample, the Serverless template provides an endpoint with API Gateway which you can use to test the cloud function. 
 
 Outuput example:
 
 ```
-...
-...
-Serverless: Stack update finished...
-Service Information
-service: apigateway-swift-aws
-stage: dev
-region: us-east-1
-stack: apigateway-swift-aws-dev
-resources: 12
-api keys:
-  None
-endpoints:
-  GET - https://r39lvhfng3.execute-api.us-east-1.amazonaws.com/api
-functions:
-  httpGet: apigateway-swift-aws-dev-httpGet
-layers:
-  None
-
-Stack Outputs
-HttpGetLambdaFunctionQualifiedArn: arn:aws:lambda:us-east-1:XXXXXXXXX:function:apigateway-swift-aws-dev-httpGet:1
-ServerlessDeploymentBucketName: apigateway-swift-aws-dev-serverlessdeploymentbuck-ud51msgcrj1e
-HttpApiUrl: https://r39lvhfng3.execute-api.us-east-1.amazonaws.com
+$ sls deploy
+
+serverless ⚡ framework
+Action: "deploy" - Stage: "dev" - App: "SwiftAPIGatewayDemo" - Instance: "SwiftAPIGatewayDemo"
+
+functionName: apigateway-swift-scf
+description:  Swift SCF demo for APIGateway
+namespace:    default
+runtime:      CustomRuntime
+handler:      swift.main
+memorySize:   64
+lastVersion:  $LATEST
+traffic:      1
+triggers:
+  apigw:
+    - http://service-jyl9i6mc-1258834142.gz.apigw.tencentcs.com/release/api
+
+Full details: https://serverless.cloud.tencent.com/apps/SwiftAPIGatewayDemo/SwiftAPIGatewayDemo/dev
+
+31s › SwiftAPIGatewayDemo › Success
 ```
 
 For example:
 
-  ```
-  curl https://r39lvhfng3.execute-api.us-east-1.amazonaws.com/api
-  ```  
+```
+curl http://service-jyl9i6mc-1258834142.gz.apigw.tencentcs.com/release/api
+```
 
 ***Warning:*** This Serverless template is only intended as a sample and creates a publicly accessible HTTP endpoint.
 
-For all other samples use the AWS Lambda console.
+For extensive usage, you need to customize `serverless.yml` yourself.
 
 4. Remove
 
- ```
-  ./scripts/serverless-remove.sh
-  ```
+```
+./scripts/serverless-remove.sh
+```
 
-The script will ask you which sample Lambda you wish to remove from the previous depolyment.
+The script will ask you which sample function you wish to remove from the previous deployment.

Examples/CloudFunctions/scripts/SAM/APIGateway-template.yml

@@ -32,21 +32,21 @@ executable=$1
 workspace="$(pwd)/../.."
 
 echo "-------------------------------------------------------------------------"
-echo "preparing docker build image"
+echo "Preparing docker build image"
 echo "-------------------------------------------------------------------------"
 docker build . -t builder
 echo "done"
 
 echo "-------------------------------------------------------------------------"
-echo "building \"$executable\" lambda"
+echo "Building \"$executable\" SCF"
 echo "-------------------------------------------------------------------------"
-docker run --rm -v "$workspace":/workspace -w /workspace/Examples/LambdaFunctions builder \
+docker run --rm -v "$workspace":/workspace -w /workspace/Examples/CloudFunctions builder \
        bash -cl "swift build --product $executable -c release"
 echo "done"
 
 echo "-------------------------------------------------------------------------"
-echo "packaging \"$executable\" lambda"
+echo "Packaging \"$executable\" SCF"
 echo "-------------------------------------------------------------------------"
-docker run --rm -v "$workspace":/workspace -w /workspace/Examples/LambdaFunctions builder \
+docker run --rm -v "$workspace":/workspace -w /workspace/Examples/CloudFunctions builder \
        bash -cl "./scripts/package.sh $executable"
 echo "done"

Examples/CloudFunctions/scripts/SAM/Benchmark-template.yml

@@ -30,21 +30,21 @@ DIR="$(cd "$(dirname "$0")" && pwd)"
 executables=( $(swift package dump-package | sed -e 's|: null|: ""|g' | jq '.products[] | (select(.type.executable)) | .name' | sed -e 's|"||g') )
 
 if [[ ${#executables[@]} = 0 ]]; then
-    echo "no executables found"
+    echo "No executables found"
     exit 1
 elif [[ ${#executables[@]} = 1 ]]; then
     executable=${executables[0]}
 elif [[ ${#executables[@]} > 1 ]]; then
-    echo "multiple executables found:"
+    echo "Multiple executables found:"
     for executable in ${executables[@]}; do
       echo "  * $executable"
     done
     echo ""
-    read -p "select which executables to deploy: " executable
+    read -p "Select which executable to deploy: " executable
 fi
 
 echo "-------------------------------------------------------------------------"
-echo "configuration"
+echo "Configuration"
 echo "-------------------------------------------------------------------------"
 echo "current dir: $DIR"
 echo "executable: $executable"