Skip to content

Commit

Permalink
Fix links due to repo rename (dapr#281)
Browse files Browse the repository at this point in the history
* Removing numbering and README changes

* Fixing build.yaml and other references to numbered names

* Changing more places to use quickstart term

* Additional samples to quickstarts changes
  • Loading branch information
Ori Zohar authored Aug 12, 2020
1 parent 5c24105 commit e7ed68f
Show file tree
Hide file tree
Showing 247 changed files with 118 additions and 121 deletions.
6 changes: 3 additions & 3 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ Please reference the issue this PR will close: #_[issue number]_

Please make sure you've completed the relevant tasks for this PR, out of the following list:

* [ ] The sample code compiles correctly
* [ ] You've tested new builds of the sample if you changed sample code
* [ ] You've updated the sample's README if necessary
* [ ] The quickstart code compiles correctly
* [ ] You've tested new builds of the quickstart if you changed quickstart code
* [ ] You've updated the quickstart's README if necessary
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ jobs:
echo "##[set-env name=SAMPLE_REGISTRY;]$SAMPLE_REGISTRY"
fi
SAMPLE_LIST=(2.hello-kubernetes 3.distributed-calculator 4.pub-sub 5.bindings 7.middleware 8.observability 9.secretstore 10.hello-docker-compose)
SAMPLE_LIST=(hello-kubernetes distributed-calculator pub-sub bindings middleware observability secretstore hello-docker-compose)

for sample in "${SAMPLE_LIST[@]}"; do
echo "Building image for ${sample}..."
Expand All @@ -44,7 +44,7 @@ jobs:
- name: publish image to dockerhub
if: github.event_name != 'pull_request'
run: |
SAMPLE_LIST=(2.hello-kubernetes 3.distributed-calculator 4.pub-sub 5.bindings 7.middleware 8.observability 9.secretstore)
SAMPLE_LIST=(hello-kubernetes distributed-calculator pub-sub bindings middleware observability secretstore)
for sample in "${SAMPLE_LIST[@]}"; do
echo "Push image for ${sample}..."
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Before you file an issue, make sure you've checked the following:
1. Is it the right repository?
- The Dapr project is distributed across multiple repositories. Check the list of [repositories](https://github.com/dapr) if you aren't sure which repo is the correct one.
1. Check for existing issues
- Before you create a new issue, please do a search in [open issues](https://github.com/dapr/samples/issues) to see if the issue or feature request has already been filed.
- Before you create a new issue, please do a search in [open issues](https://github.com/dapr/quickstarts/issues) to see if the issue or feature request has already been filed.
- If you find your issue already exists, make relevant comments and add your [reaction](https://github.com/blog/2119-add-reaction-to-pull-requests-issues-and-comments). Use a reaction:
- 👍 up-vote
- 👎 down-vote
Expand Down
57 changes: 27 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Dapr Samples
# Dapr Quickstarts

[![Build Status](https://github.com/dapr/samples/workflows/samples/badge.svg?event=push&branch=master)](https://github.com/dapr/samples/actions?workflow=samples)
[![Build Status](https://github.com/dapr/quickstarts/workflows/samples/badge.svg?event=push&branch=master)](https://github.com/dapr/quickstarts/actions?workflow=samples)
[![Join the chat at https://gitter.im/Dapr/samples](https://badges.gitter.im/Dapr/samples.svg)](https://gitter.im/Dapr/samples?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

This repository contains a series of samples that highlight Dapr capabilities. The first sample demonstrates how we run Dapr in standalone mode, while the second highlights how we run the same application in Kubernetes. Each subsequent sample includes instructions for running both in standalone and in Kubernetes.
This repository contains a collection of code samples that are aimed to get you started quickly with Dapr, each highlighting a different Dapr capability. The first quickstart to begin with is *hello-world*, it demonstrates how to run Dapr in standalone mode locally on your machine. If you are familiar with Kubernetes and want to see how to run the same application in Kubernetes, look for the *hello-kubernetes* quickstart. Each of the other quickstarts which explore different Dapr capabilities include instructions for running both in standalone and in Kubernetes.

## Getting Started

Expand All @@ -14,33 +14,30 @@ It is recommended to go through the samples via the [Getting Started](https://gi

Dapr is currently under community development with preview releases. The master branch includes breaking changes, therefore ensure that you're running the samples with the right version of Dapr runtime.

| Dapr Sample Version | Dapr Runtime Version |
| Dapr Quickstart Version | Dapr Runtime Version |
|:--------------------:|:--------------------:|
| [v0.9.0](https://github.com/dapr/samples/tree/v0.9.0) | [v0.9.0](https://github.com/dapr/dapr/tree/v0.9.0) |
| [v0.8.0](https://github.com/dapr/samples/tree/v0.8.0) | [v0.8.0](https://github.com/dapr/dapr/tree/v0.8.0) |
| [v0.7.0](https://github.com/dapr/samples/tree/v0.7.0) | [v0.7.0](https://github.com/dapr/dapr/tree/v0.7.0) |
| [v0.6.0](https://github.com/dapr/samples/tree/v0.6.0) | [v0.6.0](https://github.com/dapr/dapr/tree/v0.6.0) |
| [v0.5.0](https://github.com/dapr/samples/tree/v0.5.0) | [v0.5.0](https://github.com/dapr/dapr/tree/v0.5.0) |
| [v0.4.0](https://github.com/dapr/samples/tree/v0.4.0) | [v0.4.0](https://github.com/dapr/dapr/tree/v0.4.0) |
| [v0.3.0](https://github.com/dapr/samples/tree/v0.3.0) | [v0.3.0](https://github.com/dapr/dapr/tree/v0.3.0) |
| [v0.2.0](https://github.com/dapr/samples/tree/v0.2.0) | [v0.2.0](https://github.com/dapr/dapr/tree/v0.2.0) |
| [v0.1.0](https://github.com/dapr/samples/tree/v0.1.0) | [v0.1.0](https://github.com/dapr/dapr/tree/v0.1.0) |

## Samples

| Sample | Description |
| [v0.9.0](https://github.com/dapr/quickstarts/tree/v0.9.0) | [v0.9.0](https://github.com/dapr/dapr/tree/v0.9.0) |
| [v0.8.0](https://github.com/dapr/quickstarts/tree/v0.8.0) | [v0.8.0](https://github.com/dapr/dapr/tree/v0.8.0) |
| [v0.7.0](https://github.com/dapr/quickstarts/tree/v0.7.0) | [v0.7.0](https://github.com/dapr/dapr/tree/v0.7.0) |
| [v0.6.0](https://github.com/dapr/quickstarts/tree/v0.6.0) | [v0.6.0](https://github.com/dapr/dapr/tree/v0.6.0) |
| [v0.5.0](https://github.com/dapr/quickstarts/tree/v0.5.0) | [v0.5.0](https://github.com/dapr/dapr/tree/v0.5.0) |
| [v0.4.0](https://github.com/dapr/quickstarts/tree/v0.4.0) | [v0.4.0](https://github.com/dapr/dapr/tree/v0.4.0) |
| [v0.3.0](https://github.com/dapr/quickstarts/tree/v0.3.0) | [v0.3.0](https://github.com/dapr/dapr/tree/v0.3.0) |
| [v0.2.0](https://github.com/dapr/quickstarts/tree/v0.2.0) | [v0.2.0](https://github.com/dapr/dapr/tree/v0.2.0) |
| [v0.1.0](https://github.com/dapr/quickstarts/tree/v0.1.0) | [v0.1.0](https://github.com/dapr/dapr/tree/v0.1.0) |

## Quickstarts

| Quickstart | Description |
|--------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [1. Hello-world](./1.hello-world) | Demonstrates how to run Dapr locally. Highlights service invocation and state management. |
| [2. Hello-kubernetes](./2.hello-kubernetes) | Demonstrates how to run Dapr in Kubernetes. Highlights service invocation and state management. |
| [1. Hello-world](./hello-world) | Demonstrates how to run Dapr locally. Highlights service invocation and state management. |
| [2. Hello-kubernetes](./hello-kubernetes) | Demonstrates how to run Dapr in Kubernetes. Highlights service invocation and state management. |
| [3. Distributed-calculator](./3.distributed-calculator) | Demonstrates a distributed calculator application that uses Dapr services to power a React web app. Highlights polyglot (multi-language) programming, service invocation and state management. |
| [4. Pub-sub](./4.pub-sub) | Demonstrates how we use Dapr to enable pub-sub applications. Uses Redis as a pub-sub component. |
| [5. Bindings](./5.bindings) | Demonstrates how we use Dapr to create input and output bindings to other components. Uses bindings to Kafka. |
| [6. Functions-and-keda](./6.functions-and-keda) | Demonstrates use of Dapr pub/sub from Azure Functions, as well as composition with KEDA. |
| [7. Middleware](./7.middleware) | Demonstrates use of Dapr middleware to enable OAuth 2.0 authorization. |
| [8. Observability](./8.observability) | Demonstrates Dapr tracing capabilities. Uses Zipkin as a tracing component. |
| [9. Secret Store](./9.secretstore) | Demonstrates the use of Dapr Secrets API. |
| [10. Docker Compose](./10.hello-docker-compose) | Demonstrates how to get Dapr running locally with Docker Compose. |
| [11. Minimal Init (Dapr Slim)](./11.hello-dapr-slim) | Demonstrates how to run dapr locally, without a dependency on Docker. |
| [4. Pub-sub](./pub-sub) | Demonstrates how we use Dapr to enable pub-sub applications. Uses Redis as a pub-sub component. |
| [5. Bindings](./bindings) | Demonstrates how we use Dapr to create input and output bindings to other components. Uses bindings to Kafka. |
| [6. Middleware](./middleware) | Demonstrates use of Dapr middleware to enable OAuth 2.0 authorization. |
| [7. Observability](./observability) | Demonstrates Dapr tracing capabilities. Uses Zipkin as a tracing component. |
| [8. Secret Store](./secretstore) | Demonstrates the use of Dapr Secrets API. |

## SDKs

Expand All @@ -55,8 +52,8 @@ Find SDK-specific samples in the links below:
- **[Javascript SDK](https://github.com/dapr/js-sdk)**
- **[Python SDK](https://github.com/dapr/python-sdk)**

To get started with the samples, clone this repository and follow instructions in each sample:
To get started with the quickstarts, clone this repository and follow instructions in each sample:
```bash
git clone [-b <dapr_version_tag>] https://github.com/dapr/samples.git
git clone [-b <dapr_version_tag>] https://github.com/dapr/quickstarts.git
```
> **Note**: See https://github.com/dapr/samples#supported-dapr-runtime-version for supported tags. Use `git clone https://github.com/dapr/samples.git` when using the edge version of dapr runtime.
> **Note**: See https://github.com/dapr/quickstarts#supported-dapr-runtime-version for supported tags. Use `git clone https://github.com/dapr/quickstarts.git` when using the edge version of dapr runtime.
30 changes: 15 additions & 15 deletions 5.bindings/README.md → bindings/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Dapr Bindings Sample
# Dapr Bindings

In this sample, we'll create two microservices, one with an input binding and another with an output binding. We'll bind to Kafka, but note that there are a myriad of components that Dapr can bind to ([see Dapr components](https://github.com/dapr/docs/tree/master/concepts/bindings)).
In this quickstart, we'll create two microservices, one with an input binding and another with an output binding. We'll bind to Kafka, but note that there are a myriad of components that Dapr can bind to ([see Dapr components](https://github.com/dapr/docs/tree/master/concepts/bindings)).

This sample includes two microservices:
This quickstart includes two microservices:
- Node.js microservice that utilizes an input binding
- Python microservice that utilizes an output binding

Expand All @@ -11,7 +11,7 @@ The bindings connect to Kafka, allowing us to push messages into a Kafka instanc
![Architecture Diagram](./img/Bindings_Standalone.png)


Dapr allows us to deploy the same microservices from our local machines to Kubernetes. Correspondingly, this sample has instructions for deploying this project [locally](#Run-Locally) or in [Kubernetes](#Run-in-Kubernetes).
Dapr allows us to deploy the same microservices from our local machines to Kubernetes. Correspondingly, this quickstart has instructions for deploying this project [locally](#Run-Locally) or in [Kubernetes](#Run-in-Kubernetes).

## Prerequisites

Expand All @@ -27,16 +27,16 @@ Dapr allows us to deploy the same microservices from our local machines to Kuber

## Run Locally

### Clone the sample repository
Clone this sample repository to your local machine:
### Clone the quickstarts repository
Clone this quickstarts repository to your local machine:
```bash
git clone [-b <dapr_version_tag>] https://github.com/dapr/samples.git
git clone [-b <dapr_version_tag>] https://github.com/dapr/quickstarts.git
```
> **Note**: See https://github.com/dapr/samples#supported-dapr-runtime-version for supported tags. Use `git clone https://github.com/dapr/samples.git` when using the edge version of dapr runtime.
> **Note**: See https://github.com/dapr/quickstarts#supported-dapr-runtime-version for supported tags. Use `git clone https://github.com/dapr/quickstarts.git` when using the edge version of dapr runtime.
### Run Kafka Docker Container Locally

In order to run the Kafka bindings sample locally, you will run the [Kafka broker server](https://github.com/wurstmeister/kafka-docker) in a docker container on your machine.
In order to run the Kafka bindings quickstart locally, you will run the [Kafka broker server](https://github.com/wurstmeister/kafka-docker) in a docker container on your machine.

1. Run `docker-compose -f ./docker-compose-single-kafka.yml up -d` to run the container locally
2. Run `docker ps` to see the container running locally:
Expand All @@ -54,15 +54,15 @@ Now that you have Kafka running locally on your machine, we'll need to run our m

1. Navigate to Node subscriber directory in your CLI: `cd nodeapp`
2. Install dependencies: `npm install`
3. Run Node sample app with Dapr: `dapr run --app-id bindings-nodeapp --app-port 3000 node app.js --components-path ./components`
3. Run Node quickstart app with Dapr: `dapr run --app-id bindings-nodeapp --app-port 3000 node app.js --components-path ./components`

### Run Python Microservice with Output Binding

Next, we'll run the Python microservice that uses output bindings

1. Open a new CLI window and navigate to Python subscriber directory in your CLI: `cd pythonapp`
2. Install dependencies: `pip3 install requests`
3. Run Python sample app with Dapr: `dapr run --app-id bindings-pythonapp python3 app.py --components-path ./components`
3. Run Python quickstart app with Dapr: `dapr run --app-id bindings-pythonapp python3 app.py --components-path ./components`

### Observe Logs

Expand Down Expand Up @@ -90,7 +90,7 @@ Next, we'll run the Python microservice that uses output bindings
### Cleanup
Once you're done using the sample locally, you can spin down your local Kafka Docker Container by running:
Once you're done, you can spin down your local Kafka Docker Container by running:
```bash
docker-compose -f ./docker-compose-single-kafka.yml down
Expand Down Expand Up @@ -175,7 +175,7 @@ Hello from Kafka!
### Cleanup
Once you're done using the sample, you can spin down your Kubernetes resources by navigating to the `./deploy` directory and running:
Once you're done, you can spin down your Kubernetes resources by navigating to the `./deploy` directory and running:
```bash
cd ./deploy
Expand All @@ -184,7 +184,7 @@ kubectl delete -f .
This will spin down each resource defined by the .yaml files in the `deploy` directory, including the kafka component.
Once you delete all samples apps, delete Kafka in the cluster.
Once you delete all quickstart apps, delete Kafka in the cluster.
```bash
# clean up kafka cluster
Expand All @@ -193,7 +193,7 @@ helm uninstall dapr-kafka --namespace kafka
## How it Works
Now that you've run the sample locally and/or in Kubernetes, let's unpack how this all works. Our app is broken up into input binding app and output binding app:
Now that you've run the quickstart locally and/or in Kubernetes, let's unpack how this all works. Our app is broken up into input binding app and output binding app:
### Kafka Bindings yaml
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading

0 comments on commit e7ed68f

Please sign in to comment.