add documents

Author: dfounderliu

README.md

@@ -0,0 +1,67 @@
+
+# Tencent-scf - Create
+
+Creates a new service in the current working directory based on the provided template.
+
+**Create service in current working directory:**
+
+```bash
+serverless create --template tencent-nodejs
+```
+
+**Create service in new folder:**
+
+```bash
+serverless create --template tencent-nodejs --path myService
+```
+
+**Create service in new folder using a custom template:**
+
+```bash
+serverless create --template-url https://github.com/serverless/serverless/tree/master/lib/plugins/create/templates/tencent-nodejs --path myService
+```
+## Options
+
+- `--template` or `-t` The name of one of the available templates. **Required if --template-url and --template-path are not present**.
+- `--template-url` or `-u` The name of one of the available templates. **Required if --template and --template-path are not present**.
+- `--template-path` The local path of your template. **Required if --template and --template-url are not present**.
+- `--path` or `-p` The path where the service should be created.
+- `--name` or `-n` the name of the service in `serverless.yml`.
+
+## Available Templates
+
+To see a list of available templates run `serverless create --help`
+
+Most commonly used templates:
+
+- tencent-nodejs
+- tencent-python
+- tencent-php
+- tencent-go
+
+## Examples
+
+### Creating a new service
+
+```bash
+serverless create --template tencent-nodejs --name my-project
+```
+
+This example will generate scaffolding for a service with `Tencent` as a provider and `nodejs8` as runtime. The scaffolding
+will be generated in the current working directory.
+
+Your new service will have a default stage called `dev` and a default region inside that stage called `ap-guangzhou`.
+The provider which is used for deployment later on is Tencent Cloud.
+
+### Creating a named service in a (new) directory
+
+```bash
+serverless create --template tencent-nodejs --path tencent-project
+```
+
+This example will generate scaffolding for a service with `Tencent` as a provider and `nodejs8` as runtime. The scaffolding
+will be generated in the `tencent-project` directory. This directory will be created if not present. Otherwise Serverless
+will use the already present directory.
+
+Additionally Serverless will rename the service according to the path you provide. In this example the service will be
+renamed to `tencent-project`.

docs/en/create.md

@@ -0,0 +1,42 @@
+
+# Tencent Cloud - Credentials
+
+The Serverless Framework needs access to account credentials for your Tencent Cloud account so that it can create and manage resources on your behalf.
+
+## Create a Tencent Cloud Account
+
+If you already have a Tencent Cloud account, skip to the next step to [create an CAM User and Access Key](#create-an-cam-user-and-access-key)
+
+To create a Tencent Cloud account:
+1. Open https://cloud.tencent.com/, and then choose Sign up.
+2. Follow the online instructions.
+- Part of the sign-up procedure involves entering a PIN using the phone keypad.
+
+
+## Create an IAM User and Access Key
+
+Services in Tencent Cloud, such as SCF, require that you provide credentials when you access them to ensure that you have permission to access the resources owned by that service. To accomplish this Tencent Cloud recommends that you use Cloud Access Management (CAM).
+
+You need to create credentials Serverless can use to create resources in your Project.
+1. Login to your account and go to the [Cloud Access Management (CAM) page](https://console.cloud.tencent.com/cam/capi).
+2. Click on **Access Key** and then **Create Key**.
+3. View and copy the **APPID**, **SecretId** & **SecretKey** to a temporary place. (To get the SecretKey, you may need to enter a PIN using the phone keypad.)
+4. Create a file named `credentials` containing the credentials that you have collected.
+```ini
+[default]
+tencent_appid = 1251000000
+tencent_secret_id = AKIDteBxxxxxxxxxxnZfk
+tencent_secret_key = AKID2qsxxxxxxxxxxxxxtTo
+```
+Save the credentials file to a folder like`~/.tencent/credentials`. Copy the path of the file you saved.
+
+## Update `serverless.yml` (optional)
+
+Open up your `serverless.yml` file and update the `provider` section with
+the path to your credentials file (this path needs to be absolute). It should look something like this:
+
+```yml
+provider:
+ name: tencent
+ credentials: ~/.tencent/credentials
+```

docs/en/credentials.md

@@ -0,0 +1,28 @@
+
+# Tencent-scf - Deploy Function
+
+The `sls deploy function` command deploys an individual SCF function when there is any change in the function. This is a much faster way of deploying changes in code.
+
+```bash
+serverless deploy function -f functionName
+```
+
+## Options
+
+- `--function` or `-f` The name of the function which should be deployed
+- `--stage` or `-s` The stage in your service that you want to deploy to.
+- `--region` or `-r` The region in that stage that you want to deploy to.
+
+## Examples
+
+### Deployment without stage and region options
+
+```bash
+serverless deploy function --function helloWorld
+```
+
+### Deployment with stage and region options
+
+```bash
+serverless deploy function --function helloWorld --stage dev --region ap-guangzhou
+```

docs/en/deploy-function.md

@@ -0,0 +1,27 @@
+
+# Tencent-scf - Deploy List
+
+The `sls deploy list [functions]` command will list information about your deployments.
+
+You can either see all available deployments in your COS deployment bucket by running `serverless deploy list` or you can see the deployed functions by running `serverless deploy list functions`.
+
+The displayed information is useful when rolling back a deployment or function via `serverless rollback`.
+
+## Options
+
+- `--stage` or `-s` The stage in your service that you want to deploy to.
+- `--region` or `-r` The region in that stage that you want to deploy to.
+
+## Examples
+
+### List existing deploys
+
+```bash
+serverless deploy list
+```
+
+### List deployed functions and their versions
+
+```bash
+serverless deploy list functions
+```

docs/en/deploy-list.md

@@ -0,0 +1,50 @@
+
+# Tencent-scf - deploy
+
+The `sls deploy` command deploys your entire service. Run this command when you have made infrastructure changes (i.e., you edited `serverless.yml`). Use `serverless deploy function -f myFunction` when you have made code changes and you want to quickly upload your updated code to Tencent SCF (Serverless Cloud Functions) or just change function configuration.
+
+```bash
+serverless deploy
+```
+
+## Options
+
+- `--config` or `-c` Name of your configuration file, if other than `serverless.yml|.yaml|.js|.json`.
+- `--stage` or `-s` The stage in your service that you want to deploy to.
+- `--region` or `-r` The region in that stage that you want to deploy to.
+- `--package` or `-p` path to a pre-packaged directory and skip packaging step.
+- `--force` Forces a deployment to take place.
+- `--function` or `-f` Invoke `deploy function` (see above). Convenience shortcut - cannot be used with `--package`.
+
+## Artifacts
+
+After the `serverless deploy` command runs, the framework runs `serverless package` in the background first then deploys the generated package. During the deployment, the framework creates a COS(Cloud Object Storage) bucket to storage the package by default.
+
+## Examples
+
+### Deployment without stage and region options
+
+```bash
+serverless deploy
+```
+
+This is the simplest deployment usage possible. With this command Serverless will deploy your service to the defined
+provider in the default stage (`dev`) to the default region (`ap-guangzhou`).
+
+
+### Deployment with stage and region options
+
+```bash
+serverless deploy --stage pro --region ap-guangzhou
+```
+
+With this example we've defined that we want our service to be deployed to the `pro` stage in the region
+`ap-guangzhou`.
+
+### Deployment from a pre-packaged directory
+
+```bash
+serverless deploy --package /path/package/directory
+```
+
+With this example, the packaging step will be skipped and the framework will start deploying the package from the `/path/package/directory` directory.

docs/en/deploy.md

@@ -0,0 +1,61 @@
+
+# Tencent-SCF - Deploying
+
+The Serverless Framework was designed to provision your Serverless Cloud Functions, Events and infrastructure Resources safely and quickly. It does this via a couple of methods designed for different types of deployments.
+
+## Deploy All
+
+This is the main method for doing deployments with the Serverless Framework:
+
+```bash
+serverless deploy
+```
+
+Use this method when you have updated your Function, Event or Resource configuration in `serverless.yml` and you want to deploy that change (or multiple changes at the same time) to Amazon Web Services.
+
+**Note:** You can always enforce a deployment using the `--force` option, or specify a different configuration file name with the the `--config` option.
+
+
+### Tips
+
+- Use this in your CI/CD systems, as it is the safest method of deployment.
+- You can print the progress during the deployment if you use `verbose` mode, like this:
+ ```
+ serverless deploy --verbose
+ ```
+- This method defaults to `dev` stage and `ap-guangzhou` region. You can change the default stage and region in your `serverless.yml` file by setting the `stage` and `region` properties inside a `provider` object as the following example shows:
+
+ ```yml
+ # serverless.yml
+
+ service: service-name
+ provider:
+ name: tencent
+ stage: production
+ region: ap-beijing
+ ```
+
+- You can also deploy to different stages and regions by passing in flags to the command:
+
+ ```
+ serverless deploy --stage production --region ap-beijing
+ ```
+
+- You can specify your own COS bucket which should be used to store all the deployment artifacts.
+ The `cosBucket` config which is nested under `provider` lets you e.g. set the `name` for this bucket. If you don't provide your own bucket, Serverless will create a bucket which by default.
+
+
+## Deploy Function
+
+This deployment method simply overwrites the zip file of the current function on Tencent Cloud.
+
+```bash
+serverless deploy function --function myFunction
+```
+
+### Tips
+
+- Use this when you are developing and want to test because it's much faster.
+- During development, people will often run this command several times, as opposed to `serverless deploy` which is only run when larger infrastructure provisioning is required.
+
+Check out the [deploy command docs](../cli-reference/deploy.md) for all details and options.

docs/en/deploying.md

@@ -0,0 +1,59 @@
+
+# Tencent-SCF - Events
+
+Simply put, events are the things that trigger your functions to run.
+
+If you are using Tencent as your provider, all `events` in the service are anything in Tencent Cloud that can trigger an Serverless Cloud Function, like an COS bucket upload, an Cloud Kafka topic, and HTTP endpoints created via API Gateway.
+
+[View the events section for a list of supported events](./events)
+
+## Configuration
+
+Events belong to each Function and can be found in the `events` property in `serverless.yml`.
+
+```yml
+# 'functions' in serverless.yml
+functions:
+ createUser: # Function name
+ handler: handler.createUser # Reference to file handler.js & exported function 'createUser'
+ events: # All events associated with this function
+ - timer:
+ name: timer
+ parameters:
+ cronExpression: '*/5 * * * *'
+ enable: true
+```
+
+Events are objects, which can contain event-specific information.
+
+The `events` property is an array, because it's possible for functions to be triggered by multiple events, as shown.
+
+You can set multiple Events per Function, as long as that is supported by Tencnet Cloud and doesn't reach the limit.
+
+```yml
+# 'functions' in serverless.yml
+functions:
+ createUser: # Function name
+ handler: handler.users # Reference to file handler.js & exported function 'users'
+ events: # All events associated with this function
+ - apigw:
+ name: hello_world_apigw1
+ parameters:
+ stageName: release
+ serviceId:
+ httpMethod: ANY
+ - apigw:
+ name: hello_world_apigw2
+ parameters:
+ stageName: test
+ serviceId:
+ httpMethod: PUT
+```
+
+## Types
+
+The Serverless Framework supports all of the Serverless Cloud Function events. Instead of listing them here, we've put them in a separate section, since they have a lot of configurations and functionality. [Check out the events section for more information.](../events)
+
+## Deploying
+
+To deploy or update your Functions, Events and Infrastructure, run `serverless deploy`.

docs/en/events.md

@@ -0,0 +1,53 @@
+
+# CKafka (Cloud Kafka)
+
+## Using a pre-existing CKafka topic
+
+In the following example we choose a pre-existing CKafka topic with name `ckafka_trigger`. The function will be called every time a message is sent to the `test` topic.
+
+```yml
+functions:
+ function_one:
+ handler: index.main_handler
+ runtime: Nodejs8.9
+ events:
+ - ckafka:
+ name: ckafka_trigger
+ parameters:
+ name: ckafka-2o10hua5 # ckafka-id
+ topic: test
+ maxMsgNum: 999
+ offset: latest
+ enable: true
+```
+
+**Note:** CKafka triggers are enabled by default, and the consumer of CKafka will start to get the message from the `latest` offset.
+
+## Event Message Structure for CKafka Trigger
+
+When the specified CKafka topic receives a message, the backend consumer module of SCF will consume the message and encapsulate the message into an event in JSON format like the one below, which triggers the bound function and pass the data content as input parameters to the function.
+
+```json
+{
+ "Records": [
+ {
+ "Ckafka": {
+ "topic": "test-topic",
+ "partition":1,
+ "offset":36,
+ "msgKey": "None",
+ "msgBody": "Hello from Ckafka!"
+ }
+ },
+ {
+ "Ckafka": {
+ "topic": "test-topic",
+ "partition":1,
+ "offset":37,
+ "msgKey": "None",
+ "msgBody": "Hello from Ckafka again!"
+ }
+ }
+ ]
+}
+```