Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/cli-reference/config-credentials.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# AWS - Config Credentials

```bash
serverless config credentials --provider provider --key key --secret secret
osls config credentials --provider provider --key key --secret secret
```

## Options
Expand All @@ -21,15 +21,15 @@ serverless config credentials --provider provider --key key --secret secret
### Configure the `default` profile

```bash
serverless config credentials --provider aws --key 1234 --secret 5678
osls config credentials --provider aws --key 1234 --secret 5678
```

This example will configure the `default` profile with the `aws_access_key_id` of `1234` and the `aws_secret_access_key` of `5678`.

### Configure a custom profile

```bash
serverless config credentials \
osls config credentials \
--provider aws \
--key 1234 \
--secret 5678 \
Expand All @@ -41,7 +41,7 @@ This example create and configure a `custom-profile` profile with the `aws_acces
### Update an existing profile

```bash
serverless config credentials \
osls config credentials \
--provider aws \
--key 1234 \
--secret 5678 \
Expand Down
36 changes: 19 additions & 17 deletions docs/cli-reference/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,21 @@

Creates a new service from a remote or local template.

**Create a service in a new folder from a remote template:**
osls does not include a maintained catalog of built-in template names. Use a local template directory, or a trusted remote Git URL, when creating a service from a template.

**Create a service in a new folder using a local template:**

```bash
serverless create \
--template-url https://github.com/serverless/examples/tree/v3/... \
osls create \
--template-path path/to/my/template/folder \
--path myService
```

**Create a service in a new folder using a local template:**
**Create a service in a new folder from a remote template:**

```bash
serverless create \
--template-path path/to/my/template/folder \
osls create \
--template-url https://github.com/<owner>/<repo>/tree/<branch>/<template-directory> \
--path myService
```

Expand All @@ -23,36 +25,36 @@ serverless create \
- `--template-url` or `-u` A remotely hosted template URL. Supports plain Git URLs plus GitHub, GitHub Enterprise, GitLab, Bitbucket, and Bitbucket Server. **Required if --template-path is not present**.
- `--template-path` The local path of your template. **Required if --template-url is not present**.
- `--path` or `-p` The path where the service should be created.
- `--name` or `-n` The name of the service in `serverless.yml`. If `--path` is omitted, Serverless also uses this as the target directory name.
- `--name` or `-n` The name of the service in `serverless.yml`. If `--path` is omitted, osls also uses this as the target directory name.

## Provided lifecycle events

- `create:create`

## Examples

### Creating a named service in a new directory from a remote template
### Creating a named service in a new directory using a local template

```bash
serverless create \
--template-url https://github.com/serverless/examples/tree/v3/... \
osls create \
--template-path path/to/my/template/folder \
--path my-new-service \
--name my-new-service
```

This example will download the template into the `my-new-service` directory. This directory will be created if not present. osls will not overwrite an existing target directory when `--path` is used.
This example will copy the template into the `my-new-service` directory. This directory will be created if not present. osls will not overwrite an existing target directory when `--path` is used.

Additionally osls will rename the service according to the name you provide. If `--path` is omitted, osls uses `--name` as the target directory. If `--name` is omitted, the service name defaults to the target directory's final path segment.

### Creating a new service using a local template
### Creating a named service in a new directory from a remote template

```bash
serverless create \
--template-path path/to/my/template/folder \
--path path/to/my/service \
osls create \
--template-url https://github.com/<owner>/<repo>/tree/<branch>/<template-directory> \
--path my-new-service \
--name my-new-service
```

This will copy the `path/to/my/template/folder` folder into `path/to/my/service`. If `--name` is provided, the copied template's service name will be renamed to `my-new-service`. If `--name` is omitted, the service name defaults to the target directory's final path segment.
This will download the template into the `my-new-service` directory. If `--name` is provided, the copied template's service name will be renamed to `my-new-service`. If `--name` is omitted, the service name defaults to the target directory's final path segment.

If neither `--path` nor `--name` is provided, osls will create a new directory named after the local template folder and preserve the template's existing service name.
When using a local template, if neither `--path` nor `--name` is provided, osls will create a new directory named after the local template folder and preserve the template's existing service name.
12 changes: 6 additions & 6 deletions docs/cli-reference/deploy-function.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# AWS - Deploy Function

The `sls deploy function` command deploys an individual function without AWS CloudFormation. This command simply swaps out the zip file that your CloudFormation stack is pointing toward. This is a much faster way of deploying changes in code.
The `osls deploy function` command deploys an individual function without AWS CloudFormation. This command simply swaps out the zip file that your CloudFormation stack is pointing toward. This is a much faster way of deploying changes in code.

```bash
serverless deploy function -f functionName
osls deploy function -f functionName
```

**Note:** This command **now** deploys both function configuration and code by
default. Just as before, this puts your function in an inconsistent state that
is out of sync with your CloudFormation stack. Use this for faster development
cycles and not production deployments

**Note:** This command is not supported for functions configured with `durableConfig` locally or already deployed with durable configuration in AWS. Use `serverless deploy` so osls can publish a new durable function version and retarget the generated durable alias.
**Note:** This command is not supported for functions configured with `durableConfig` locally or already deployed with durable configuration in AWS. Use `osls deploy` so osls can publish a new durable function version and retarget the generated durable alias.

## Options

Expand All @@ -25,19 +25,19 @@ cycles and not production deployments
### Deployment without stage and region options

```bash
serverless deploy function --function helloWorld
osls deploy function --function helloWorld
```

### Deployment with stage and region options

```bash
serverless deploy function --function helloWorld \
osls deploy function --function helloWorld \
--stage dev \
--region us-east-1
```

### Deploy only configuration changes

```bash
serverless deploy function --function helloWorld --update-config
osls deploy function --function helloWorld --update-config
```
10 changes: 5 additions & 5 deletions docs/cli-reference/deploy-list.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# AWS - Deploy List

The `sls deploy list [functions]` command will list information about your deployments.
The `osls deploy list [functions]` command will list information about your deployments.

You can either see all available deployments in your S3 deployment bucket by running `serverless deploy list` or you can see the deployed functions by running `serverless deploy list functions`.
You can either see all available deployments in your S3 deployment bucket by running `osls deploy list` or you can see the deployed functions by running `osls deploy list functions`.

The displayed information is useful when rolling back a deployment or function via `serverless rollback`.
The displayed information is useful when rolling back a deployment or function via `osls rollback`.

## Options

Expand All @@ -16,11 +16,11 @@ The displayed information is useful when rolling back a deployment or function v
### List existing deploys

```bash
serverless deploy list
osls deploy list
```

### List deployed functions and their versions

```bash
serverless deploy list functions
osls deploy list functions
```
14 changes: 7 additions & 7 deletions docs/cli-reference/deploy.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# AWS - deploy

The `sls deploy` command deploys your entire service via CloudFormation. 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 AWS Lambda or just change function configuration.
The `osls deploy` command deploys your entire service via CloudFormation. Run this command when you have made infrastructure changes (i.e., you edited `serverless.yml`). Use `osls deploy function -f myFunction` when you have made code changes and you want to quickly upload your updated code to AWS Lambda or just change function configuration.

```bash
serverless deploy
osls deploy
```

## Options
Expand All @@ -21,14 +21,14 @@ serverless deploy

## Artifacts

After the `serverless deploy` command runs, the framework runs `serverless package` in the background first then deploys the generated package.
After the `osls deploy` command runs, the framework runs `osls package` in the background first then deploys the generated package.

## Examples

### Deployment without stage and region options

```bash
serverless deploy
osls deploy
```

This is the simplest deployment usage possible. With this command osls will deploy your service to the defined
Expand All @@ -37,7 +37,7 @@ provider in the default stage (`dev`) to the default region (`us-east-1`).
### Deployment with stage and region options

```bash
serverless deploy --stage production --region eu-central-1
osls deploy --stage production --region eu-central-1
```

With this example we've defined that we want our service to be deployed to the `production` stage in the region
Expand All @@ -46,7 +46,7 @@ With this example we've defined that we want our service to be deployed to the `
### Deployment from a pre-packaged directory

```bash
serverless deploy --package /path/to/package/directory
osls deploy --package /path/to/package/directory
```

With this example, the packaging step will be skipped and the CLI will start deploying the package from the `/path/to/package/directory` directory.
Expand All @@ -56,5 +56,5 @@ With this example, the packaging step will be skipped and the CLI will start dep
- `SLS_AWS_MONITORING_FREQUENCY` allows the adjustment of the deployment monitoring frequency time in ms, default is `5000`.

```bash
SLS_AWS_MONITORING_FREQUENCY=10000 serverless deploy
SLS_AWS_MONITORING_FREQUENCY=10000 osls deploy
```
8 changes: 4 additions & 4 deletions docs/cli-reference/generate-event.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ layout: Doc
Creates sample Lambda function payloads for different types of events.

```bash
serverless generate-event --type eventType
osls generate-event --type eventType
```

## Options
Expand Down Expand Up @@ -40,17 +40,17 @@ serverless generate-event --type eventType
### Generate SQS event payload

```bash
serverless generate-event -t aws:sqs
osls generate-event -t aws:sqs
```

### Generate Kinesis event payload with body

```bash
serverless generate-event -t aws:kinesis -b '{"foo": "bar"}'
osls generate-event -t aws:kinesis -b '{"foo": "bar"}'
```

### Generate SQS event and save it to a file

```bash
serverless generate-event -t aws:sqs > event.json
osls generate-event -t aws:sqs > event.json
```
6 changes: 3 additions & 3 deletions docs/cli-reference/info.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Displays information about the deployed service.

```bash
serverless info
osls info
```

## Options
Expand All @@ -26,7 +26,7 @@ See the example below for an example output.
**Example:**

```bash
$ serverless info
$ osls info

Service Information
service: my-serverless-service
Expand All @@ -45,7 +45,7 @@ functions:
When using the `--verbose` flag, the `info` command will also append all Stack Outputs to the output:

```bash
$ serverless info --verbose
$ osls info --verbose

Service Information
service: my-serverless-service
Expand Down
8 changes: 4 additions & 4 deletions docs/cli-reference/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Installs a service from a remote Git URL into a new directory in the current working directory.

```bash
serverless install --url https://github.com/some/service
osls install --url https://github.com/some/service
```

## Options
Expand All @@ -29,23 +29,23 @@ serverless install --url https://github.com/some/service
### Installing a service from a remote URL

```bash
serverless install --url https://github.com/pmuens/serverless-crud
osls install --url https://github.com/pmuens/serverless-crud
```

This example downloads the `serverless-crud` service from the remote repository, creates a new directory named `serverless-crud` in the current working directory, and unzips the files into it.

### Installing a service from a remote URL with a new service name

```bash
serverless install --url https://github.com/pmuens/serverless-crud --name my-crud
osls install --url https://github.com/pmuens/serverless-crud --name my-crud
```

This example downloads the `serverless-crud` service from the remote repository, creates a new directory named `my-crud` in the current working directory, and renames the service to `my-crud` if `serverless.yml` exists in the service root.

### Installing a service from a repository subdirectory URL

```bash
serverless install --url https://github.com/serverless/examples/tree/master/aws-node-rest-api-with-dynamodb
osls install --url https://github.com/serverless/examples/tree/master/aws-node-rest-api-with-dynamodb
```

This example downloads the `aws-node-rest-api-with-dynamodb` service from a repository subdirectory.
Loading