Skip to content

Commit 336dcdf

Browse files
filintodmsfussell
filintod
and
msfussell
authored
add image pull info (#4545)
* add info about image pull policy Signed-off-by: Filinto Duran <[email protected]> * Update multi-app-overview.md Add note Signed-off-by: Mark Fussell <[email protected]> * Update multi-app-template.md Added example Signed-off-by: Mark Fussell <[email protected]> --------- Signed-off-by: Filinto Duran <[email protected]> Signed-off-by: Mark Fussell <[email protected]> Co-authored-by: Mark Fussell <[email protected]>
1 parent b15df6b commit 336dcdf

File tree

2 files changed

+37
-34
lines changed

2 files changed

+37
-34
lines changed

‎daprdocs/content/en/developing-applications/local-development/multi-app-dapr-run/multi-app-overview.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ apps:
124124
appDirPath: ./nodeapp/
125125
appPort: 3000
126126
containerImage: ghcr.io/dapr/samples/hello-k8s-node:latest
127+
containerImagePullPolicy: Always
127128
createService: true
128129
env:
129130
APP_PORT: 3000
@@ -134,6 +135,7 @@ apps:
134135

135136
> **Note:**
136137
> - If the `containerImage` field is not specified, `dapr run -k -f` produces an error.
138+
> - The containerImagePullPolicy indicates that a new container image is always downloaded for this app.
137139
> - The `createService` field defines a basic service in Kubernetes (ClusterIP or LoadBalancer) that targets the `--app-port` specified in the template. If `createService` isn't specified, the application is not accessible from outside the cluster.
138140

139141
For a more in-depth example and explanation of the template properties, see [Multi-app template]({{< ref multi-app-template.md >}}).
@@ -169,4 +171,4 @@ Watch [this video for an overview on Multi-App Run in Kubernetes](https://youtu.
169171

170172
- [Learn the Multi-App Run template file structure and its properties]({{< ref multi-app-template.md >}})
171173
- [Try out the self-hosted Multi-App Run template with the Service Invocation quickstart]({{< ref serviceinvocation-quickstart.md >}})
172-
- [Try out the Kubernetes Multi-App Run template with the `hello-kubernetes` tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes)
174+
- [Try out the Kubernetes Multi-App Run template with the `hello-kubernetes` tutorial](https://github.com/dapr/quickstarts/tree/master/tutorials/hello-kubernetes)

‎daprdocs/content/en/developing-applications/local-development/multi-app-dapr-run/multi-app-template.md

+34-33
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,7 @@ apps:
203203
appLogDestination: file # (optional), can be file, console or fileAndConsole. default is fileAndConsole.
204204
daprdLogDestination: file # (optional), can be file, console or fileAndConsole. default is file.
205205
containerImage: ghcr.io/dapr/samples/hello-k8s-node:latest # (optional) URI of the container image to be used when deploying to Kubernetes dev/test environment.
206+
containerImagePullPolicy: IfNotPresent # (optional), the container image is downloaded if one is not present locally, otherwise the local one is used.
206207
createService: true # (optional) Create a Kubernetes service for the application when deploying to dev/test environment.
207208
- appID: backend # optional
208209
appDirPath: .dapr/backend/ # REQUIRED
@@ -285,39 +286,39 @@ The properties for the Multi-App Run template align with the `dapr run -k` CLI f
285286

286287
{{< table "table table-white table-striped table-bordered" >}}
287288

288-
| Properties | Required | Details | Example |
289-
|--------------------------|:--------:|--------|---------|
290-
| `appDirPath` | Y | Path to the your application code | `./webapp/`, `./backend/` |
291-
| `appID` | N | Application's app ID. If not provided, will be derived from `appDirPath` | `webapp`, `backend` |
292-
| `appChannelAddress` | N | The network address the application listens on. Can be left to the default value by convention. | `127.0.0.1` | `localhost` |
293-
| `appProtocol` | N | The protocol Dapr uses to talk to the application. | `http`, `grpc` |
294-
| `appPort` | N | The port your application is listening on | `8080`, `3000` |
295-
| `daprHTTPPort` | N | Dapr HTTP port | |
296-
| `daprGRPCPort` | N | Dapr GRPC port | |
297-
| `daprInternalGRPCPort` | N | gRPC port for the Dapr Internal API to listen on; used when parsing the value from a local DNS component | |
298-
| `metricsPort` | N | The port that Dapr sends its metrics information to | |
299-
| `unixDomainSocket` | N | Path to a unix domain socket dir mount. If specified, communication with the Dapr sidecar uses unix domain sockets for lower latency and greater throughput when compared to using TCP ports. Not available on Windows. | `/tmp/test-socket` |
300-
| `profilePort` | N | The port for the profile server to listen on | |
301-
| `enableProfiling` | N | Enable profiling via an HTTP endpoint | |
302-
| `apiListenAddresses` | N | Dapr API listen addresses | |
303-
| `logLevel` | N | The log verbosity. | |
304-
| `appMaxConcurrency` | N | The concurrency level of the application; default is unlimited | |
305-
| `placementHostAddress` | N | | |
306-
| `appSSL` | N | Enable https when Dapr invokes the application | |
307-
| `daprHTTPMaxRequestSize` | N | Max size of the request body in MB. | |
308-
| `daprHTTPReadBufferSize` | N | Max size of the HTTP read buffer in KB. This also limits the maximum size of HTTP headers. The default 4 KB | |
309-
| `enableAppHealthCheck` | N | Enable the app health check on the application | `true`, `false` |
310-
| `appHealthCheckPath` | N | Path to the health check file | `/healthz` |
311-
| `appHealthProbeInterval` | N | Interval to probe for the health of the app in seconds
312-
| |
313-
| `appHealthProbeTimeout` | N | Timeout for app health probes in milliseconds | |
314-
| `appHealthThreshold` | N | Number of consecutive failures for the app to be considered unhealthy | |
315-
| `enableApiLogging` | N | Enable the logging of all API calls from application to Dapr | |
316-
| `env` | N | Map to environment variable; environment variables applied per application will overwrite environment variables shared across applications | `DEBUG`, `DAPR_HOST_ADD` |
317-
| `appLogDestination` | N | Log destination for outputting app logs; Its value can be file, console or fileAndConsole. Default is fileAndConsole | `file`, `console`, `fileAndConsole` |
318-
| `daprdLogDestination` | N | Log destination for outputting daprd logs; Its value can be file, console or fileAndConsole. Default is file | `file`, `console`, `fileAndConsole` |
319-
| `containerImage`| N | URI of the container image to be used when deploying to Kubernetes dev/test environment. | `ghcr.io/dapr/samples/hello-k8s-python:latest`
320-
| `createService`| N | Create a Kubernetes service for the application when deploying to dev/test environment. | `true`, `false` |
289+
| Properties | Required | Details | Example |
290+
|----------------------------|:--------:|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------|
291+
| `appDirPath` | Y | Path to the your application code | `./webapp/`, `./backend/` |
292+
| `appID` | N | Application's app ID. If not provided, will be derived from `appDirPath` | `webapp`, `backend` |
293+
| `appChannelAddress` | N | The network address the application listens on. Can be left to the default value by convention. | `127.0.0`, `localhost` |
294+
| `appProtocol` | N | The protocol Dapr uses to talk to the application. | `http`, `grpc` |
295+
| `appPort` | N | The port your application is listening on | `8080`, `3000` |
296+
| `daprHTTPPort` | N | Dapr HTTP port | |
297+
| `daprGRPCPort` | N | Dapr GRPC port | |
298+
| `daprInternalGRPCPort` | N | gRPC port for the Dapr Internal API to listen on; used when parsing the value from a local DNS component | |
299+
| `metricsPort` | N | The port that Dapr sends its metrics information to | |
300+
| `unixDomainSocket` | N | Path to a unix domain socket dir mount. If specified, communication with the Dapr sidecar uses unix domain sockets for lower latency and greater throughput when compared to using TCP ports. Not available on Windows. | `/tmp/test-socket` |
301+
| `profilePort` | N | The port for the profile server to listen on | |
302+
| `enableProfiling` | N | Enable profiling via an HTTP endpoint | |
303+
| `apiListenAddresses` | N | Dapr API listen addresses | |
304+
| `logLevel` | N | The log verbosity. | |
305+
| `appMaxConcurrency` | N | The concurrency level of the application; default is unlimited | |
306+
| `placementHostAddress` | N | | |
307+
| `appSSL` | N | Enable https when Dapr invokes the application | |
308+
| `daprHTTPMaxRequestSize` | N | Max size of the request body in MB. | |
309+
| `daprHTTPReadBufferSize` | N | Max size of the HTTP read buffer in KB. This also limits the maximum size of HTTP headers. The default 4 KB | |
310+
| `enableAppHealthCheck` | N | Enable the app health check on the application | `true`, `false` |
311+
| `appHealthCheckPath` | N | Path to the health check file | `/healthz` |
312+
| `appHealthProbeInterval` | N | Interval to probe for the health of the app in seconds | |
313+
| `appHealthProbeTimeout` | N | Timeout for app health probes in milliseconds | |
314+
| `appHealthThreshold` | N | Number of consecutive failures for the app to be considered unhealthy | |
315+
| `enableApiLogging` | N | Enable the logging of all API calls from application to Dapr | |
316+
| `env` | N | Map to environment variable; environment variables applied per application will overwrite environment variables shared across applications | `DEBUG`, `DAPR_HOST_ADD` |
317+
| `appLogDestination` | N | Log destination for outputting app logs; Its value can be file, console or fileAndConsole. Default is fileAndConsole | `file`, `console`, `fileAndConsole` |
318+
| `daprdLogDestination` | N | Log destination for outputting daprd logs; Its value can be file, console or fileAndConsole. Default is file | `file`, `console`, `fileAndConsole` |
319+
| `containerImage` | N | URI of the container image to be used when deploying to Kubernetes dev/test environment. | `ghcr.io/dapr/samples/hello-k8s-python:latest` |
320+
| `containerImagePullPolicy` | N | The container image pull policy (default to `Always`). | `Always`, `IfNotPresent`, `Never` |
321+
| `createService` | N | Create a Kubernetes service for the application when deploying to dev/test environment. | `true`, `false` |
321322

322323
{{< /table >}}
323324

0 commit comments

Comments
 (0)