Skip to content

Commit 125ebc8

Browse files
committed
readme changes and some more messages today
Signed-off-by: Pravin Pushkar <[email protected]>
1 parent 5df0795 commit 125ebc8

File tree

3 files changed

+15
-9
lines changed

3 files changed

+15
-9
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ Output should look like so:
8686

8787
```
8888
⌛ Making the jump to hyperspace...
89-
✅ Downloaded binaries and completed components set up.
89+
✅ Downloaded binaries and completed resources set up.
9090
ℹ️ daprd binary has been installed to $HOME/.dapr/bin.
9191
ℹ️ dapr_placement container is running.
9292
ℹ️ dapr_redis container is running.
@@ -99,10 +99,12 @@ Output should look like so:
9999
100100
This step creates the following defaults:
101101

102-
1. components folder which is later used during `dapr run` unless the `--resources-path` (`--components-path` is deprecated and will be removed in future releases) option is provided. For Linux/MacOS, the default components folder path is `$HOME/.dapr/components` and for Windows it is `%USERPROFILE%\.dapr\components`.
103-
2. component files in the components folder called `pubsub.yaml` and `statestore.yaml`.
102+
1. resources folder which is later used during `dapr run` unless the `--resources-path` (`--components-path` is deprecated and will be removed in future releases) option is provided. For Linux/MacOS, the default resources folder path is `$HOME/.dapr/resources` and for Windows it is `%USERPROFILE%\.dapr\resources`.
103+
2. resoources files in the resources folder called `pubsub.yaml` and `statestore.yaml`.
104104
3. default config file `$HOME/.dapr/config.yaml` for Linux/MacOS or for Windows at `%USERPROFILE%\.dapr\config.yaml` to enable tracing on `dapr init` call. Can be overridden with the `--config` flag on `dapr run`.
105105

106+
> Note: If there is a `components` directory present in the default dapr installation path `$HOME/.dapr/resources` (for Linux/MacOS) or `%USERPROFILE%\.dapr\resources` (for windows) then `dapr init` will copy the `resources` from the `components` to `resources` directory. This is to ensure safe migration from using `components` to `resources` directory.
107+
106108
#### Slim Init
107109

108110
Alternatively to the above, to have the CLI not install any default configuration files or run Docker containers, use the `--slim` flag with the init command. Only Dapr binaries will be installed.
@@ -115,13 +117,15 @@ Output should look like so:
115117

116118
```bash
117119
⌛ Making the jump to hyperspace...
118-
✅ Downloaded binaries and completed components set up.
120+
✅ Downloaded binaries and completed resources set up.
119121
ℹ️ daprd binary has been installed to $HOME/.dapr/bin.
120122
ℹ️ placement binary has been installed.
121123
✅ Success! Dapr is up and running. To get started, go here: https://aka.ms/dapr-getting-started
122124
```
123125

124-
>Note: When initializing Dapr with the `--slim` flag only the Dapr runtime binary and the placement service binary are installed. An empty default components folder is created with no default configuration files. During `dapr run` user should use `--resources-path` (`--components-path` is deprecated and will be removed in future releases) to point to a components directory with custom configurations files or alternatively place these files in the default directory. For Linux/MacOS, the default components directory path is `$HOME/.dapr/components` and for Windows it is `%USERPROFILE%\.dapr\components`.
126+
>Note: When initializing Dapr with the `--slim` flag only the Dapr runtime binary and the placement service binary are installed. An empty default `resources` folder is created with no default configuration files. During `dapr run` user should use `--resources-path` (`--components-path` is deprecated and will be removed in future releases) to point to a `resources` directory with custom configurations files or alternatively place these files in the default directory. For Linux/MacOS, the default `resources` directory path is `$HOME/.dapr/resources` and for Windows it is `%USERPROFILE%\.dapr\resources`.
127+
128+
> Note: If there is a `components` directory present in the default dapr installation path `$HOME/.dapr/resources` (for Linux/MacOS) or `%USERPROFILE%\.dapr\resources` (for windows) then `dapr init` will copy the `resources` from the `components` to `resources` directory. This is to ensure safe migration from using `components` to `resources` directory.
125129
126130
#### Install a specific runtime version
127131

@@ -325,7 +329,7 @@ To remove all Dapr Custom Resource Definitions:
325329
dapr uninstall -k --all
326330
```
327331

328-
*Warning: this will remove any components, subscriptions or configurations that are applied in the cluster at the time of deletion.*
332+
*Warning: this will remove any resources(and components also), subscriptions or configurations that are applied in the cluster at the time of deletion.*
329333

330334
### Upgrade Dapr on Kubernetes
331335

@@ -444,7 +448,7 @@ Launch Dapr and your app:
444448
dapr run --app-id nodeapp --app-port 3000 node app.js
445449
```
446450

447-
Note: To choose a non-default components folder, use the --resources-path(--components-path is deprecated) option.
451+
Note: To choose a non-default resources folder, use the --resources-path(--components-path is deprecated) option.
448452

449453
Invoke your app:
450454

pkg/standalone/standalone.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,9 @@ func Init(runtimeVersion, dashboardVersion string, dockerNetwork string, slimMod
279279

280280
stopSpinning(print.Success)
281281

282-
msg = "Downloaded binaries and completed components set up."
282+
msg = "Downloaded binaries and completed resources set up."
283283
if isAirGapInit {
284-
msg = "Extracted binaries and completed components set up."
284+
msg = "Extracted binaries and completed resources set up."
285285
}
286286
print.SuccessStatusEvent(os.Stdout, msg)
287287
print.InfoStatusEvent(os.Stdout, "%s binary has been installed to %s.", daprRuntimeFilePrefix, daprBinDir)

tests/e2e/standalone/upgrade_test.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ func TestCompToResrcDirMig(t *testing.T) {
5353
renameResourcesDir(t)
5454

5555
// dapr run should work with only components dir.
56+
// 2nd paramter is true to indicate that only components dir is present.
5657
checkDaprRunPrecedenceTest(t, true)
5758

5859
// dapr uninstall without --all flag should work.
@@ -65,6 +66,7 @@ func TestCompToResrcDirMig(t *testing.T) {
6566
copyInMemStateStore(t)
6667

6768
// check dapr run precedence order, resources dir 1st then components dir.
69+
// 2nd paramter is false to indicate that both components and resources dir are present.
6870
checkDaprRunPrecedenceTest(t, false)
6971
}
7072

0 commit comments

Comments
 (0)