cli

README

Actions CLI

The Actions CLI allows you to setup Actions on your local dev machine or on a Kubernetes cluster, provides debugging support, launches and manages Actions instances.

Getting started

Prerequisites

• Download the release for your OS
• Unpack it
• Move it to your desired location (for Mac/Linux - mv actions /usr/local/bin. For Windows, add the executable to your System PATH.)

Note: For Windows users, run the cmd terminal in administrator mode

Note: For Linux users, if you run docker cmds with sudo, you need to use sudo actions init

Install Actions

To setup Actions on your local machine:

Note: For Windows users, run the cmd terminal in administrator mode

$ actions init
⌛  Making the jump to hyperspace...
↗   Downloading binaries and setting up components...
✅  Success! Actions is up and running

To setup Actions on Kubernetes:

$ actions init --kubernetes
⌛  Making the jump to hyperspace...
↗   Deploying the Actions Operator to your cluster...
✅  Success! Actions is up and running. To verify, run 'kubectl get pods' in your terminal

Installing a specific version (Standalone)

Using actions init will download and install the latest version of Actions. In order to specify a specific version of the Actions runtime, use the runtime-version flag:

$ actions init --runtime-version v0.3.0-alpha
⌛  Making the jump to hyperspace...
↗   Downloading binaries and setting up components...
✅  Success! Actions is up and running

Note: The init command will install the latest stable version of Actions on your cluster. For more advanced use cases, use our Helm Chart.

Launch Actions and your app

The Actions CLI lets you debug easily by launching both Actions and your app. Logs from both the Actions Runtime and your app will be displayed in real time!

Example of launching Actions with a node app:

$ actions run --app-id nodeapp node app.js

Example of launching Actions with a node app listening on port 3000:

$ actions run --app-id nodeapp --app-port 3000 node app.js

Example of launching Actions on port 6000:

$ actions run --app-id nodeapp --app-port 3000 --port 6000 node app.js

Publish/Subscribe

To use pub-sub with your app, make sure that your app has a POST HTTP endpoint with some name, say myevent. This sample assumes your app is listening on port 3000.

Launch Actions and your app:

$ actions run --app-id nodeapp --app-port 3000 node app.js

Publish a message:

$ actions publish --topic myevent

Publish a message with a payload:

$ actions publish --topic myevent --payload '{ "name": "yoda" }'

Invoking

To test your endpoints with Actions, simply expose any POST HTTP endpoint. For this sample, we'll assume a node app listening on port 300 with a /mymethod endpoint.

Launch Actions and your app:

$ actions run --app-id nodeapp --app-port 3000 node app.js

Invoke your app:

$ actions send --app-id nodeapp --method mymethod

List

To list all Actions instances running on your machine:

$ actions list

To list all Actions instances running in a Kubernetes cluster:

$ actions list --kubernetes

Stop

Use actions list to get a list of all running instances. To stop an actions app on your machine:

$ actions stop --app-id myAppID

Enable profiling

In order to enable profiling, use the enable-profiling flag:

$ actions run --app-id nodeapp --app-port 3000 node app.js --enable-profiling

Actions will automatically assign a profile port for you. If you want to manually assign a profiling port, use the profile-port flag:

$ actions run --app-id nodeapp --app-port 3000 node app.js --enable-profiling --profile-port 7777

Set log level

In order to set the Actions runtime log verbosity level, use the log-level flag:

$ actions run --app-id nodeapp --app-port 3000 node app.js --log-level debug

This sets the Actions log level to debug. The default is info.

Uninstall (Kubernetes)

To remove Actions from your Kubernetes cluster, use the uninstall command.

Note this won't remove Actions installations that were deployed using Helm.

$ actions uninstall --kubernetes

Developing Actions CLI

Prerequisites

1. The Go language environment (instructions).
   • Make sure that your GOPATH and PATH are configured correctly

   export GOPATH=~/go
   export PATH=$PATH:$GOPATH/bin
   

2. Delve for Debugging
3. (for windows) MinGW to install gcc and make
   • Recommend to use chocolatey mingw package and ensure that MinGW bin directory is in PATH environment variable

Clone the repo

cd $GOPATH/src
mkdir -p github.com/actionscore/cli
git clone https://github.com/actionscore/cli.git github.com/actionscore/cli

Build

You can build actions binaries via make tool and find the binaries in ./dist/{os}_{arch}/release/.

Note : for windows environment with MinGW, use mingw32-make.exe instead of make.

• Build for your current local environment

cd $GOPATH/src/github.com/actionscore/cli/
make build

• Cross compile for multi platforms

make build GOOS=linux GOARCH=amd64

Run unit-test

make test

Debug Actions CLI

We highly recommend to use VSCode with Go plugin for your productivity. If you want to use the different editors, you can find the list of editor plugins for Delve.

This section introduces how to start debugging with Delve CLI. Please see Delve documentation for the detail usage.

Start with debugger

$ cd $GOPATH/src/github.com/actionscore/cli
$ dlv debug .
Type 'help' for list of commands.
(dlv) break main.main
(dlv) continue

Debug unit-tests

# Specify the package that you want to test
# e.g. debuggin ./pkg/actors
$ dlv test ./pkg/actors