Skip to content

Commit 235626f

Browse files
authored
components-path --> resources-path in how-tos and quickstarts (#3016)
* find and replace comopnents-path to resources-path Signed-off-by: Hannah Hunter <[email protected]> * missed a couple Signed-off-by: Hannah Hunter <[email protected]> * updates per pravin Signed-off-by: Hannah Hunter <[email protected]> * mark components-path as deprecated Signed-off-by: Hannah Hunter <[email protected]> * reword Signed-off-by: Hannah Hunter <[email protected]> Signed-off-by: Hannah Hunter <[email protected]>
1 parent 072ee76 commit 235626f

File tree

23 files changed

+58
-56
lines changed

23 files changed

+58
-56
lines changed

daprdocs/content/en/concepts/dapr-services/sidecar.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ For a detailed list of all available arguments run `daprd --help` or see this [t
4949
daprd --app-id --app-port 5000
5050
```
5151

52-
3. If you are using several custom components and want to specify the location of the component definition files, use the `--components-path` argument:
52+
3. If you are using several custom resources and want to specify the location of the resource definition files, use the `--resources-path` argument:
5353

5454
```bash
55-
daprd --app-id myapp --components-path <PATH-TO-COMPONENTS-FILES>
55+
daprd --app-id myapp --resources-path <PATH-TO-RESOURCES-FILES>
5656
```
5757

5858
4. Enable collection of Prometheus metrics while running your app

daprdocs/content/en/developing-applications/building-blocks/bindings/howto-bindings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Create a new binding component named `checkout`. Within the `metadata` section,
3535

3636
{{% codetab %}}
3737

38-
Use the `--components-path` flag with `dapr run` to point to your custom components directory.
38+
Use the `--resources-path` flag with `dapr run` to point to your custom resources directory.
3939

4040
```yaml
4141
apiVersion: dapr.io/v1alpha1

daprdocs/content/en/developing-applications/building-blocks/bindings/howto-triggers.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Create a new binding component named `checkout`. Within the `metadata` section,
4141

4242
{{% codetab %}}
4343

44-
Use the `--components-path` flag with the `dapr run` command to point to your custom components directory.
44+
Use the `--resources-path` flag with the `dapr run` command to point to your custom resources directory.
4545

4646
```yaml
4747
apiVersion: dapr.io/v1alpha1

daprdocs/content/en/developing-applications/building-blocks/configuration/howto-manage-configuration.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,7 @@ asyncio.run(executeConfiguration())
304304
```
305305

306306
```bash
307-
dapr run --app-id orderprocessing --components-path components/ -- python3 OrderProcessingService.py
307+
dapr run --app-id orderprocessing --resources-path components/ -- python3 OrderProcessingService.py
308308
```
309309

310310
{{% /codetab %}}

daprdocs/content/en/developing-applications/building-blocks/pubsub/howto-publish-subscribe.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -63,46 +63,46 @@ scopes:
6363
- checkout
6464
```
6565
66-
You can override this file with another [pubsub component]({{< ref setup-pubsub >}}) by creating a components directory (in this example, `myComponents`) containing the file and using the flag `--components-path` with the `dapr run` CLI command.
66+
You can override this file with another [pubsub component]({{< ref setup-pubsub >}}) by creating a components directory (in this example, `myComponents`) containing the file and using the flag `--resources-path` with the `dapr run` CLI command.
6767

6868
{{< tabs Dotnet Java Python Go Javascript >}}
6969

7070
{{% codetab %}}
7171

7272
```bash
73-
dapr run --app-id myapp --components-path ./myComponents -- dotnet run
73+
dapr run --app-id myapp --resources-path ./myComponents -- dotnet run
7474
```
7575

7676
{{% /codetab %}}
7777

7878
{{% codetab %}}
7979

8080
```bash
81-
dapr run --app-id myapp --components-path ./myComponents -- mvn spring-boot:run
81+
dapr run --app-id myapp --resources-path ./myComponents -- mvn spring-boot:run
8282
```
8383

8484
{{% /codetab %}}
8585

8686
{{% codetab %}}
8787

8888
```bash
89-
dapr run --app-id myapp --components-path ./myComponents -- python3 app.py
89+
dapr run --app-id myapp --resources-path ./myComponents -- python3 app.py
9090
```
9191

9292
{{% /codetab %}}
9393

9494
{{% codetab %}}
9595

9696
```bash
97-
dapr run --app-id myapp --components-path ./myComponents -- go run app.go
97+
dapr run --app-id myapp --resources-path ./myComponents -- go run app.go
9898
```
9999

100100
{{% /codetab %}}
101101

102102
{{% codetab %}}
103103

104104
```bash
105-
dapr run --app-id myapp --components-path ./myComponents -- npm start
105+
dapr run --app-id myapp --resources-path ./myComponents -- npm start
106106
```
107107
{{% /codetab %}}
108108

daprdocs/content/en/developing-applications/building-blocks/pubsub/subscription-methods.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -47,39 +47,39 @@ When running Dapr, set the YAML component file path to point Dapr to the compone
4747
{{% codetab %}}
4848

4949
```bash
50-
dapr run --app-id myapp --components-path ./myComponents -- dotnet run
50+
dapr run --app-id myapp --resources-path ./myComponents -- dotnet run
5151
```
5252

5353
{{% /codetab %}}
5454

5555
{{% codetab %}}
5656

5757
```bash
58-
dapr run --app-id myapp --components-path ./myComponents -- mvn spring-boot:run
58+
dapr run --app-id myapp --resources-path ./myComponents -- mvn spring-boot:run
5959
```
6060

6161
{{% /codetab %}}
6262

6363
{{% codetab %}}
6464

6565
```bash
66-
dapr run --app-id myapp --components-path ./myComponents -- python3 app.py
66+
dapr run --app-id myapp --resources-path ./myComponents -- python3 app.py
6767
```
6868

6969
{{% /codetab %}}
7070

7171
{{% codetab %}}
7272

7373
```bash
74-
dapr run --app-id myapp --components-path ./myComponents -- npm start
74+
dapr run --app-id myapp --resources-path ./myComponents -- npm start
7575
```
7676

7777
{{% /codetab %}}
7878

7979
{{% codetab %}}
8080

8181
```bash
82-
dapr run --app-id myapp --components-path ./myComponents -- go run app.go
82+
dapr run --app-id myapp --resources-path ./myComponents -- go run app.go
8383
```
8484

8585
{{% /codetab %}}

daprdocs/content/en/developing-applications/building-blocks/state-management/howto-state-query-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ docker run -d --rm -p 27017:27017 --name mongodb mongo:5
9696
Next, start a Dapr application. Refer to the [component configuration file](../query-api-examples/components/mongodb/mongodb.yml), which instructs Dapr to use MongoDB as its state store.
9797

9898
```bash
99-
dapr run --app-id demo --dapr-http-port 3500 --components-path query-api-examples/components/mongodb
99+
dapr run --app-id demo --dapr-http-port 3500 --resources-path query-api-examples/components/mongodb
100100
```
101101

102102
Populate the state store with the employee dataset, so you can query it later.

daprdocs/content/en/developing-applications/local-development/ides/vscode/vscode-dapr-extension.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To create a dedicated components folder with the default `statestore`, `pubsub`,
3333
1. Open your application directory in Visual Studio Code
3434
2. Open the Command Palette with `Ctrl+Shift+P`
3535
3. Select `Dapr: Scaffold Dapr Components`
36-
4. Run your application with `dapr run --components-path ./components -- ...`
36+
4. Run your application with `dapr run --resources-path ./components -- ...`
3737

3838
### View running Dapr applications
3939

daprdocs/content/en/getting-started/quickstarts/bindings-quickstart.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ pip3 install -r requirements.txt
8585
Run the `batch-sdk` service alongside a Dapr sidecar.
8686

8787
```bash
88-
dapr run --app-id batch-sdk --app-port 50051 --components-path ../../../components -- python3 app.py
88+
dapr run --app-id batch-sdk --app-port 50051 --resources-path ../../../components -- python3 app.py
8989
```
9090

9191
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
@@ -292,7 +292,7 @@ npm install
292292
Run the `batch-sdk` service alongside a Dapr sidecar.
293293
294294
```bash
295-
dapr run --app-id batch-sdk --app-port 5002 --dapr-http-port 3500 --components-path ../../../components -- node index.js
295+
dapr run --app-id batch-sdk --app-port 5002 --dapr-http-port 3500 --resources-path ../../../components -- node index.js
296296
```
297297
298298
The code inside the `process_batch` function is executed every 10 seconds (defined in [`binding-cron.yaml`]({{< ref "#componentsbinding-cronyaml-component-file" >}}) in the `components` directory). The binding trigger looks for a route called via HTTP POST in your Flask application by the Dapr sidecar.
@@ -495,7 +495,7 @@ dotnet build batch.csproj
495495
Run the `batch-sdk` service alongside a Dapr sidecar.
496496
497497
```bash
498-
dapr run --app-id batch-sdk --app-port 7002 --components-path ../../../components -- dotnet run
498+
dapr run --app-id batch-sdk --app-port 7002 --resources-path ../../../components -- dotnet run
499499
```
500500
501501
The code inside the `process_batch` function is executed every 10 seconds (defined in [`binding-cron.yaml`]({{< ref "#componentsbinding-cronyaml-component-file" >}}) in the `components` directory). The binding trigger looks for a route called via HTTP POST in your Flask application by the Dapr sidecar.
@@ -701,7 +701,7 @@ mvn clean install
701701
Run the `batch-sdk` service alongside a Dapr sidecar.
702702
703703
```bash
704-
dapr run --app-id batch-sdk --app-port 8080 --components-path ../../../components -- java -jar target/BatchProcessingService-0.0.1-SNAPSHOT.jar
704+
dapr run --app-id batch-sdk --app-port 8080 --resources-path ../../../components -- java -jar target/BatchProcessingService-0.0.1-SNAPSHOT.jar
705705
```
706706
707707
The code inside the `process_batch` function is executed every 10 seconds (defined in [`binding-cron.yaml`]({{< ref "#componentsbinding-cronyaml-component-file" >}}) in the `components` directory). The binding trigger looks for a route called via HTTP POST in your Flask application by the Dapr sidecar.
@@ -908,7 +908,7 @@ go build .
908908
Run the `batch-sdk` service alongside a Dapr sidecar.
909909
910910
```bash
911-
dapr run --app-id batch-sdk --app-port 6002 --dapr-http-port 3502 --dapr-grpc-port 60002 --components-path ../../../components -- go run .
911+
dapr run --app-id batch-sdk --app-port 6002 --dapr-http-port 3502 --dapr-grpc-port 60002 --resources-path ../../../components -- go run .
912912
```
913913
914914
The code inside the `process_batch` function is executed every 10 seconds (defined in [`binding-cron.yaml`]({{< ref "#componentsbinding-cronyaml-component-file" >}}) in the `components` directory). The binding trigger looks for a route called via HTTP POST in your Flask application by the Dapr sidecar.

daprdocs/content/en/getting-started/quickstarts/pubsub-quickstart.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ pip3 install -r requirements.txt
5656
Run the `order-processor` subscriber service alongside a Dapr sidecar.
5757

5858
```bash
59-
dapr run --app-id order-processor --components-path ../../../components/ --app-port 5001 -- python3 app.py
59+
dapr run --app-id order-processor --resources-path ../../../components/ --app-port 5001 -- python3 app.py
6060
```
6161

6262
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
@@ -105,7 +105,7 @@ pip3 install -r requirements.txt
105105
Run the `checkout` publisher service alongside a Dapr sidecar.
106106

107107
```bash
108-
dapr run --app-id checkout --components-path ../../../components/ -- python3 app.py
108+
dapr run --app-id checkout --resources-path ../../../components/ -- python3 app.py
109109
```
110110

111111
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
@@ -235,7 +235,7 @@ Verify you have the following files included in the service directory:
235235
Run the `order-processor` subscriber service alongside a Dapr sidecar.
236236

237237
```bash
238-
dapr run --app-port 5001 --app-id order-processing --app-protocol http --dapr-http-port 3501 --components-path ../../../components -- npm run start
238+
dapr run --app-port 5001 --app-id order-processing --app-protocol http --dapr-http-port 3501 --resources-path ../../../components -- npm run start
239239
```
240240

241241
In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.
@@ -267,7 +267,7 @@ Verify you have the following files included in the service directory:
267267
Run the `checkout` publisher service alongside a Dapr sidecar.
268268

269269
```bash
270-
dapr run --app-id checkout --app-protocol http --dapr-http-port 3500 --components-path ../../../components -- npm run start
270+
dapr run --app-id checkout --app-protocol http --dapr-http-port 3500 --resources-path ../../../components -- npm run start
271271
```
272272

273273
In the `checkout` publisher service, we're publishing the orderId message to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. As soon as the service starts, it publishes in a loop:
@@ -389,7 +389,7 @@ dotnet build
389389
Run the `order-processor` subscriber service alongside a Dapr sidecar.
390390

391391
```bash
392-
dapr run --app-id order-processor --components-path ../../../components --app-port 7002 -- dotnet run
392+
dapr run --app-id order-processor --resources-path ../../../components --app-port 7002 -- dotnet run
393393
```
394394

395395
In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.
@@ -423,7 +423,7 @@ dotnet build
423423
Run the `checkout` publisher service alongside a Dapr sidecar.
424424

425425
```bash
426-
dapr run --app-id checkout --components-path ../../../components -- dotnet run
426+
dapr run --app-id checkout --resources-path ../../../components -- dotnet run
427427
```
428428

429429
In the `checkout` publisher, we're publishing the orderId message to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. As soon as the service starts, it publishes in a loop:
@@ -544,7 +544,7 @@ mvn clean install
544544
Run the `order-processor` subscriber service alongside a Dapr sidecar.
545545

546546
```bash
547-
dapr run --app-port 8080 --app-id order-processor --components-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
547+
dapr run --app-port 8080 --app-id order-processor --resources-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
548548
```
549549

550550
In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.
@@ -582,7 +582,7 @@ mvn clean install
582582
Run the `checkout` publisher service alongside a Dapr sidecar.
583583

584584
```bash
585-
dapr run --app-id checkout --components-path ../../../components -- java -jar target/CheckoutService-0.0.1-SNAPSHOT.jar
585+
dapr run --app-id checkout --resources-path ../../../components -- java -jar target/CheckoutService-0.0.1-SNAPSHOT.jar
586586
```
587587

588588
In the `checkout` publisher, we're publishing the orderId message to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. As soon as the service starts, it publishes in a loop:
@@ -706,7 +706,7 @@ go build .
706706
Run the `order-processor` subscriber service alongside a Dapr sidecar.
707707

708708
```bash
709-
dapr run --app-port 6002 --app-id order-processor-sdk --app-protocol http --dapr-http-port 3501 --components-path ../../../components -- go run .
709+
dapr run --app-port 6002 --app-id order-processor-sdk --app-protocol http --dapr-http-port 3501 --resources-path ../../../components -- go run .
710710
```
711711

712712
In the `order-processor` subscriber, we're subscribing to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. This enables your app code to talk to the Redis component instance through the Dapr sidecar.
@@ -736,7 +736,7 @@ go build .
736736
Run the `checkout` publisher service alongside a Dapr sidecar.
737737

738738
```bash
739-
dapr run --app-id checkout --app-protocol http --dapr-http-port 3500 --components-path ../../../components -- go run .
739+
dapr run --app-id checkout --app-protocol http --dapr-http-port 3500 --resources-path ../../../components -- go run .
740740
```
741741

742742
In the `checkout` publisher, we're publishing the orderId message to the Redis instance called `orderpubsub` [(as defined in the `pubsub.yaml` component)]({{< ref "#pubsubyaml-component-file" >}}) and topic `orders`. As soon as the service starts, it publishes in a loop:

daprdocs/content/en/getting-started/quickstarts/secrets-quickstart.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ pip3 install -r requirements.txt
5555
Run the `order-processor` service alongside a Dapr sidecar.
5656

5757
```bash
58-
dapr run --app-id order-processor --components-path ../../../components/ -- python3 app.py
58+
dapr run --app-id order-processor --resources-path ../../../components/ -- python3 app.py
5959
```
6060

6161
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
@@ -164,7 +164,7 @@ npm install
164164
Run the `order-processor` service alongside a Dapr sidecar.
165165

166166
```bash
167-
dapr run --app-id order-processor --components-path ../../../components/ -- npm start
167+
dapr run --app-id order-processor --resources-path ../../../components/ -- npm start
168168
```
169169

170170
#### Behind the scenes
@@ -278,7 +278,7 @@ dotnet build
278278
Run the `order-processor` service alongside a Dapr sidecar.
279279

280280
```bash
281-
dapr run --app-id order-processor --components-path ../../../components/ -- dotnet run
281+
dapr run --app-id order-processor --resources-path ../../../components/ -- dotnet run
282282
```
283283

284284
#### Behind the scenes
@@ -389,7 +389,7 @@ mvn clean install
389389
Run the `order-processor` service alongside a Dapr sidecar.
390390

391391
```bash
392-
dapr run --app-id order-processor --components-path ../../../components/ -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
392+
dapr run --app-id order-processor --resources-path ../../../components/ -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
393393
```
394394

395395
#### Behind the scenes
@@ -494,7 +494,7 @@ go build .
494494
Run the `order-processor` service alongside a Dapr sidecar.
495495

496496
```bash
497-
dapr run --app-id order-processor --components-path ../../../components/ -- go run .
497+
dapr run --app-id order-processor --resources-path ../../../components/ -- go run .
498498
```
499499

500500
#### Behind the scenes

daprdocs/content/en/getting-started/quickstarts/statemanagement-quickstart.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ pip3 install -r requirements.txt
5151
Run the `order-processor` service alongside a Dapr sidecar.
5252

5353
```bash
54-
dapr run --app-id order-processor --components-path ../../../components/ -- python3 app.py
54+
dapr run --app-id order-processor --resources-path ../../../components/ -- python3 app.py
5555
```
5656

5757
> **Note**: Since Python3.exe is not defined in Windows, you may need to use `python app.py` instead of `python3 app.py`.
@@ -172,7 +172,7 @@ Verify you have the following files included in the service directory:
172172
Run the `order-processor` service alongside a Dapr sidecar.
173173

174174
```bash
175-
dapr run --app-id order-processor --components-path ../../../components/ -- npm run start
175+
dapr run --app-id order-processor --resources-path ../../../components/ -- npm run start
176176
```
177177
The `order-processor` service writes, reads, and deletes an `orderId` key/value pair to the `statestore` instance [defined in the `statestore.yaml` component]({{< ref "#statestoreyaml-component-file" >}}). As soon as the service starts, it performs a loop.
178178

@@ -300,7 +300,7 @@ dotnet build
300300
Run the `order-processor` service alongside a Dapr sidecar.
301301

302302
```bash
303-
dapr run --app-id order-processor --components-path ../../../components/ -- dotnet run
303+
dapr run --app-id order-processor --resources-path ../../../components/ -- dotnet run
304304
```
305305

306306
The `order-processor` service writes, reads, and deletes an `orderId` key/value pair to the `statestore` instance [defined in the `statestore.yaml` component]({{< ref "#statestoreyaml-component-file" >}}). As soon as the service starts, it performs a loop.
@@ -419,7 +419,7 @@ mvn clean install
419419
Run the `order-processor` service alongside a Dapr sidecar.
420420

421421
```bash
422-
dapr run --app-id order-processor --components-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
422+
dapr run --app-id order-processor --resources-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar
423423
```
424424

425425
The `order-processor` service writes, reads, and deletes an `orderId` key/value pair to the `statestore` instance [defined in the `statestore.yaml` component]({{< ref "#statestoreyaml-component-file" >}}). As soon as the service starts, it performs a loop.
@@ -538,7 +538,7 @@ go build .
538538
Run the `order-processor` service alongside a Dapr sidecar.
539539

540540
```bash
541-
dapr run --app-id order-processor --components-path ../../../components -- go run .
541+
dapr run --app-id order-processor --resources-path ../../../components -- go run .
542542
```
543543

544544
The `order-processor` service writes, reads, and deletes an `orderId` key/value pair to the `statestore` instance [defined in the `statestore.yaml` component]({{< ref "#statestoreyaml-component-file" >}}). As soon as the service starts, it performs a loop.

daprdocs/content/en/getting-started/tutorials/configure-state-pubsub.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -317,9 +317,9 @@ When you run `dapr init`, Dapr creates a default redis `pubsub.yaml` on your loc
317317
For new component files:
318318

319319
1. Create a new `components` directory in your app folder containing the YAML files.
320-
1. Provide the path to the `dapr run` command with the flag `--components-path`
320+
1. Provide the path to the `dapr run` command with the flag `--resources-path`
321321

322-
If you initialized Dapr in [slim mode]({{< ref self-hosted-no-docker.md >}}) (without Docker), you need to manually create the default directory, or always specify a components directory using `--components-path`.
322+
If you initialized Dapr in [slim mode]({{< ref self-hosted-no-docker.md >}}) (without Docker), you need to manually create the default directory, or always specify a components directory using `--resources-path`.
323323

324324
{{% /codetab %}}
325325

0 commit comments

Comments
 (0)