dapr/cli

Command-line tools for Dapr.

Any language, any framework, anywhere

Dapr is a portable, serverless, event-driven runtime that makes it easy for developers to build resilient, stateless and stateful microservices that run on the cloud and edge and embraces the diversity of languages and developer frameworks.

Dapr codifies the best practices for building microservice applications into open, independent, building blocks that enable you to build portable applications with the language and framework of your choice. Each building block is independent and you can use one, some, or all of them in your application.

We are a Cloud Native Computing Foundation (CNCF) incubation project.

Goals

• Enable developers using any language or framework to write distributed applications
• Solve the hard problems developers face building microservice applications by providing best practice building blocks
• Be community driven, open and vendor neutral
• Gain new contributors
• Provide consistency and portability through open APIs
• Be platform agnostic across cloud and edge
• Embrace extensibility and provide pluggable components without vendor lock-in
• Enable IoT and edge scenarios by being highly performant and lightweight
• Be incrementally adoptable from existing code, with no runtime dependency

How it works

Dapr injects a side-car (container or process) to each compute unit. The side-car interacts with event triggers and communicates with the compute unit via standard HTTP or gRPC protocols. This enables Dapr to support all existing and future programming languages without requiring you to import frameworks or libraries.

Dapr offers built-in state management, reliable messaging (at least once delivery), triggers and bindings through standard HTTP verbs or gRPC interfaces. This allows you to write stateless, stateful and actor-like services following the same programming paradigm. You can freely choose consistency model, threading model and message delivery patterns.

Dapr runs natively on Kubernetes, as a self hosted binary on your machine, on an IoT device, or as a container that can be injected into any system, in the cloud or on-premises.

Dapr uses pluggable component state stores and message buses such as Redis as well as gRPC to offer a wide range of communication methods, including direct dapr-to-dapr using gRPC and async Pub-Sub with guaranteed delivery and at-least-once semantics.

Why Dapr?

Writing highly performant, scalable and reliable distributed application is hard. Dapr brings proven patterns and practices to you. It unifies event-driven and actors semantics into a simple, consistent programming model. It supports all programming languages without framework lock-in. You are not exposed to low-level primitives such as threading, concurrency control, partitioning and scaling. Instead, you can write your code by implementing a simple web server using familiar web frameworks of your choice.

Dapr is flexible in threading and state consistency models. You can leverage multi-threading if you choose to, and you can choose among different consistency models. This flexibility enables you to implement advanced scenarios without artificial constraints. Dapr is unique because you can transition seamlessly between platforms and underlying implementations without rewriting your code.

Features

• Event-driven Pub-Sub system with pluggable providers and at-least-once semantics
• Input and output bindings with pluggable providers
• State management with pluggable data stores
• Consistent service-to-service discovery and invocation
• Opt-in stateful models: Strong/Eventual consistency, First-write/Last-write wins
• Cross platform virtual actors
• Secret management to retrieve secrets from secure key vaults
• Rate limiting
• Built-in Observability support
• Runs natively on Kubernetes using a dedicated Operator and CRDs
• Supports all programming languages via HTTP and gRPC
• Multi-Cloud, open components (bindings, pub-sub, state) from Azure, AWS, GCP
• Runs anywhere, as a process or containerized
• Lightweight (58MB binary, 4MB physical memory)
• Runs as a sidecar - removes the need for special SDKs or libraries
• Dedicated CLI - developer friendly experience with easy debugging
• Clients for Java, .NET Core, Go, Javascript, Python, Rust and C++

Get Started using Dapr

See our Getting Started guide over in our docs.

Quickstarts and Samples

• See the quickstarts repository for code examples that can help you get started with Dapr.
• Explore additional samples in the Dapr samples repository.

Community

We want your contributions and suggestions! One of the easiest ways to contribute is to participate in discussions on the mailing list, chat on IM or the bi-weekly community calls. For more information on the community engagement, developer and contributing guidelines and more, head over to the Dapr community repo.

Contact Us

Reach out with any questions you may have and we'll make sure to answer them as soon as possible!

Platform	Link
💬 Instant Message Chat (preferred)
📧 Mailing List	https://groups.google.com/forum/#!forum/dapr-dev
🐤 Twitter	@daprdev

Community Call

Every two weeks we host a community call to showcase new features, review upcoming milestones, and engage in a Q&A. All are welcome!

📞 Visit https://aka.ms/dapr-community-call for upcoming dates and the meeting link.

Videos and Podcasts

We have a variety of keynotes, podcasts, and presentations available to reference and learn from.

📺 Visit https://docs.dapr.io/contributing/presentations/ for previous talks and slide decks.

Contributing to Dapr

See the Development Guide to get started with building and developing.

Repositories

Repo	Description
Dapr	The main repository that you are currently in. Contains the Dapr runtime code and overview documentation.
CLI	The Dapr CLI allows you to setup Dapr on your local dev machine or on a Kubernetes cluster, provides debugging support, launches and manages Dapr instances.
Docs	The documentation for Dapr.
Quickstarts	This repository contains a series of simple code samples that highlight the main Dapr capabilities.
Samples	This repository holds community maintained samples for various Dapr use cases.
Components-contrib	The purpose of components contrib is to provide open, community driven reusable components for building distributed applications.
Dashboard	General purpose dashboard for Dapr
Go-sdk	Dapr SDK for Go
Java-sdk	Dapr SDK for Java
JS-sdk	Dapr SDK for JavaScript
Python-sdk	Dapr SDK for Python
Dotnet-sdk	Dapr SDK for .NET
Rust-sdk	Dapr SDK for Rust
Cpp-sdk	Dapr SDK for C++
PHP-sdk	Dapr SDK for PHP

Code of Conduct

Please refer to our Dapr Community Code of Conduct

cli's Issues

cli needs to extract tar.gz for macos and linux [blocked by release]

Along with #81, cli needs to download *.tar.gz for macos/linux and extract it in the next preview release.

• : Download and extract .tar.gz archive for linux and macos
• : Remove version condition once Sept Iteration 1 is done.

Enable tar.gz extraction for all runtime versions in Sept Iteration 1 release

Remove version check after actions runtime is release in sept 1 endgame

https://github.com/actionscore/cli/blob/da53eff5cdc130a12bedd577eb519ef41e84c70c/pkg/standalone/standalone.go#L161-L162

Need to have Troubleshooting Section for common issues and resolutions

Need to address common issues and resolutions:
For Example:

First Issue : On Windows, while building cli "mingw32-make.exe build"
if you see the below error
"
process_begin: CreateProcess(NULL, uname -m, ...) failed.
mingw32-make.exe: Makefile:25: pipe: No error
'head' is not recognized as an internal or external command,
operable program or batch file.
'head' is not recognized as an internal or external command,
operable program or batch file.
process_begin: CreateProcess(NULL, uname, ...) failed.
mingw32-make.exe: Makefile:37: pipe: Bad file descriptor
CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -ldflags "-X main.version=edge -X main.apiVersion=1.0" -mod=vendor
-o ./dist/windows_amd64/release/dapr.exe;
'CGO_ENABLED' is not recognized as an internal or external command,
operable program or batch file.
mingw32-make.exe: *** [Makefile:81: dapr] Error 1"

Resolution Check if the Git bin path is existing in the Path variable.

You can run this command which will update the git and add the paths in the Path variable.

choco install git.install --params "/GitAndUnixToolsOnPath /NoGitLfs /SChannel /NoAutoCrlf"

Download icon is janky

When I download in VS-Code Terminal (or in Open Source Windows Terminal) the pulsing download animation is pretty janky. I'd suggest switching to something less fancy (e.g. classic spinning lines) or something like that.

Hide components directory from users for dapr run

Use temp dirs.

Support --uninstall option to clean up

remove the /doc/preview folder

These CLI docs need to be moved to docs repo under reference/CLI
KEEP the release notes folder under docs here.

Remove --app-id from publish command

Instead, we can list all the available Actions and pick any of them. If there are non running, should output a message saying "couldn't find any actions instance running".

Change invoke method to comply with latest spec

Allow setting log level on actions run

dapr run: support detach option

Support detach option in actions run.
I ssh to my ubuntu machine (most developers just to ssh in a terminal to linux machine).
Currently cli runs the action and user process in non-detached mode, so to do anything else I need to start other terminal session. Supporting detach mode for linux users is a must have.

Granted users can run it as daemon with &, but we will have to tell users to run it as daemon. Supporting a detach option makes it very similar to docker option.

Update license to MIT

Make preview kit doc consistent

both docs should be consistent.
https://github.com/actionscore/cli
https://github.com/actionscore/cli/tree/master/docs/preview

make build doesn't work

cc @youngbupark

Steps to reproduce:

1. run make build

Problems:

1. all OS's should be built. what happens is only the current ARCH is getting built.
2. file has no exec permissions. you have to do chmod +x ./actions.
3. even after 2, the file errors out when called:

./actions: line 1: syntax error near unexpected token `newline'
./actions: line 1: `!<arch>`

CLI error message when runtime version is not found

If you run CLI init method with an non-existing runtime version with the --runtime-version switch, the CLI reports "not a valid zip file". It should report "runtime version not found".

dapr init --kubernetes option should configure redis in kubernetes

dapr init --kubernetes option should configure redis in kubernetes to be on par with local actions init setup.

Standalone actions use the same gRPC port

When running multiple action-enabled apps locally (using the "run" CLI command), every subsequent app clobbers the same port (6051).

The actions still get stood up, but only the first one handles requests as expected:

Actions CLI should be named as actions.exe for Windows

The current pipeline creates "actions" instead of "actions.exe"

Add capability to manage components

Ability to dynamically add/update/remove components

Init command doesn't report error when Docker is not running

Tested on Windows. The Init command claims success on Windows when Docker is not running.

Can not kill an actions run that has crashed.

I have an actions run where the node process appears to have crashed. I can't seem to use the actions CLI to stop it (since the process doesn't exist) but I also can't seem to run a new revision of the app.

actions publish payload isn't working on Windows cmd terminal

Populate REL_VERSION in CI

Enable uninstall to remove placement container for standalone mode

Problem:

Dapr init update dapr runtime without updating placement container. Dapr uninstall needs to remove placement container to clean up.

Support runtime versioning and CLI versioning

1. CLI shall support a new switch named --runtime-version, which points to the version number of the runtime to be downloaded/installed.
2. We shall generate a special CLI build for preview kit that treats ---runtime-version as a mandatory flag.
3. The version command of CLI should return both CLI version and runtime version.

Provide an option for non-root install.

running actions init tries to copy something into a privileged location (/usr/local/bin) that's fine, but you might want to:

a) print a more useful error message (e.g. 'sudo actions init') instead of just failing the write.

b) provide a command line option for saving to an alternate location so that people w/o root can still install.

Docs update

Add the following to docs:

• actions list
• actions run
• actions send
• actions publish

Bubble up docker errors in Actions CLI

When actions init fails due to a docker issue, it doesn't bubble the issue up:

C:\actions>actions init
Making the jump to hyperspace...
Placement Service installation skipped due to Docker run error
Success! Get ready to rumble

We should bubble up all potentially valuable errors for users to more easily debug

This should handle both the cases of Docker not installed and Docker not running on all platforms.

Ability to set the logging level with the CLI run command

Need the ability to set the logging level for the ActionsRT.exe i.e. ./actionsrt --log-level error
from the run command. e.g.
actions run --app-id nodeapp --app-port --log-level debug 3000 node app.js

Actions list - support listing endpoints

actions list --endpoints will list out the endpoints from the user app

Remove hardcoded path for binaries in CLI for all platforms

Currently hardcoded to C:\dapr on Windows and /usr/local/bin on Mac/Linux.

Download actions binaries from GitHub Release directly

Justification:
Once actions repo goes public, it makes sense to download actions binaries from GH release not to maintain blob storage.

to get latest release:
https://developer.github.com/v3/repos/releases/#get-the-latest-release

to get the specific version release
https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name

Exit criteria:

• cli can download actions binaries from actions gh release
• cli has the feature flag to enable GH Release download
• Remove upload task in actions ci

Update doc to show the usage of runtime-version selection

• Add the usage of runtime-version selection in cli init command

Bring CLI output to product standard

• Add installation progress for actions init (including download progress)
• Replace prototype output language to product quality language. E.g. "✅ Success! Get ready to rumble"

Change confirmation message on dapr init

Change confirmation message from Dapr is up and running to Dapr has been installed.

Fix illformed error message when Docker is not installed on Windows

Current message is:

C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise>actions init
Making the jump to hyperspace...
Downloading binaries and setting up components...
exec: "docker": executable file not found in %!P(MISSING)ATH%!(NOVERB)

actions run should not overwrite existing component files

Set up State Stores and Pub Sub on k8s

Allow users a more streamlined getting started experience using the cli, by having a setup command install Redis on a k8s cluster and set up the component yaml automatically on behalf of the user.

"Actions List" gets out out sync with what it thinks is running and what actually is running as a process

Make actions init --kubernetes and helm install consistent

• Implementation
• Design decisions PR
• Update Readme.md for Helm chart and CLI
• Update samples
• Update Kubernetes docs on how to install Redis on Kubernetes

Need a new CLI verb to stop a running action

As of now, when we start an action and then close that console window, it continues to exist:

> actions list
  APP ID           ACTIONS PORT  APP PORT  COMMAND        AGE  CREATED
  pythonapp        3500          3000      python app.py  2d   2019-08-14 12:09.34

There is then no way to stop the running action, which presents an issue if we want to reuse the action port.

Feature request: Add a new "stop" or "delete" verb to the CLI take down an action

Improve CLI development document

The document includes how we build/test/debug

• - How to build actions cli
• - How to test actions cli
• - How to debug actions cli

Create a Development Guide for Dapr CLI

Create a separate Development Guide for Dapr CLI and extract out the development steps from main Readme page.

Update to match runtime latest changes

dapr/dapr#113 introduced several breaking changes.

This issue will track all related tasks.

Add profiling flags to the run command

In order to enable profiling in Standalone mode, the CLI needs to pass the --enable-profiling flag to the runtime.

Move from Dep to Go Modules

Archive cli linux/macos binaries with tar

In what area(s)?

/area test-and-release

Describe the feature

Archive cli linux/macos binaries by tar.gz in CI

Justification

Most linux distros don't include unzip by default

change component to conform to new structure

The component structure has changed to support secrets. The CLI needs to create a component YAML that conforms to the runtime.

actions init fails on Windows

On a Windows machine run "actions init"

C:\Users\mfussell\go\src\github.com\actions-org\cli>actions init
Making the jump to hyperspace...
Error extracting actions binary: zip: not a valid zip file

CLI init command should return meaningful message instead of "exit status 1" when kubectl is not installed/configured

CLI init command should return meaningful message instead of "exit status 1" when kubectl is not installed/configured