Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/threadheap/serviceless

[DEPRECATED] Cli tool on top of Serverless framework
https://github.com/threadheap/serviceless

aws aws-lambda cli devops serverless serverless-framework

Last synced: 5 days ago
JSON representation

[DEPRECATED] Cli tool on top of Serverless framework

Host: GitHub
URL: https://github.com/threadheap/serviceless
Owner: threadheap
License: mit
Created: 2017-12-20T10:35:55.000Z (about 7 years ago)
Default Branch: master
Last Pushed: 2018-05-21T09:41:47.000Z (over 6 years ago)
Last Synced: 2024-12-12T18:52:05.947Z (23 days ago)
Topics: aws, aws-lambda, cli, devops, serverless, serverless-framework
Language: JavaScript
Homepage:
Size: 3.92 MB
Stars: 23
Watchers: 3
Forks: 3
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# [DEPRECATED]
[serverless-components](https://github.com/serverless/components) solve the problem

# serviceless

**Serviceless** - cli tool on top of Serverless framework, that simplifies workflow with multiple services.

[![serverless](http://public.serverless.com/badges/v3.svg)](http://www.serverless.com)
[![Build Status](http://circleci-badges-max.herokuapp.com/img/threadheap/serviceless?token=4482e2625fab30eeca954eec94a73091532f7883)](https://circleci.com/gh/8bites/serviceless) [![codecov](https://codecov.io/gh/8bites/serviceless/branch/master/graph/badge.svg)](https://codecov.io/gh/8bites/serviceless)
[![npm version](https://badge.fury.io/js/serviceless.svg)](https://badge.fury.io/js/serviceless)
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)

# Quick start

1. Install serverless framework

```sh
npm install serverless -g
```

2. Install serviceless cli

```sh
npm install serviceless -g
```

3. Deploy

```sh
slx deploy all
```

# How to

## Deploy

#### Deploy all services in a folder

```sh
slx deploy all
```

#### Deploy service with command line prompt

```sh
slx deploy
```

then select service or folder from the list.

#### Deploy service, matching string

```sh
slx deploy
```

### Deploy with cli options

Every serverless option that you set will be propagated to the `sls deploy` command accordingly:

```sh
slx deploy all --stage prod --region eu-central-1
```

will deploy to `prod` stage and `eu-central-1` region.

### Deploy with environment variables

slx will share all enviroment variables with serverless process, so

```sh
MY_SECRET=foo slx deploy all
```

will be injected into serverless config.

### Deploy Flags

`-b`, `--runInBand` - deploy services one by one (parallel by default)

`-e`, `--exitOnFailure` - stop deployment of other services on failure

`-r`, `--rollbackOnFailure` - rollback services on deployment failure
Makes sense to spar with `--exitOnFailure` flag to stop on failure and rollback.

`-v`, `--verbose` - show serverless output

## Help

```sh
slx --help
slx deploy --help
```

# What's next

* [x] add option to rollback to previous state on fail
* [ ] aggregate logs for multiple services
* [ ] add configuration file to deploy in band services that rely on each other
* [ ] save and restore `.serverless` folders to use as deployment artifacts for CI/CD tools

# Contributions

Yes, please!

Clone repo, then

```sh
npm install
npm test
```

# LICENCE

MIT @ [Pavel Vlasov](https://github.com/pavelvlasov)