mirror of https://github.com/dapr/docs.git
Merge branch 'v1.12' into update-multi-app-run-steps
This commit is contained in:
commit
a4879190d1
|
@ -11,7 +11,7 @@ description: "How to debug the Dapr sidecar (daprd) on your Kubernetes cluster"
|
|||
|
||||
Sometimes it is necessary to understand what's going on in the Dapr sidecar (daprd), which runs as a sidecar next to your application, especially when you diagnose your Dapr application and wonder if there's something wrong in Dapr itself. Additionally, you may be developing a new feature for Dapr on Kubernetes and want to debug your code.
|
||||
|
||||
his guide will cover how to use built-in Dapr debugging to debug the Dapr sidecar in your Kubernetes pods.
|
||||
This guide covers how to use built-in Dapr debugging to debug the Dapr sidecar in your Kubernetes pods. To learn how to view logs and troubleshoot Dapr in Kubernetes, see the [Configure and view Dapr logs guide]({{< ref "logs-troubleshooting.md#logs-in-kubernetes-mode" >}})
|
||||
|
||||
## Pre-requisites
|
||||
|
||||
|
@ -87,6 +87,62 @@ Forwarding from [::1]:40000 -> 40000
|
|||
|
||||
All done. Now you can point to port 40000 and start a remote debug session to daprd from your favorite IDE.
|
||||
|
||||
## Commonly used `kubectl` commands
|
||||
|
||||
Use the following common `kubectl` commands when debugging daprd and applications running on Kubernetes.
|
||||
|
||||
Get all pods, events, and services:
|
||||
|
||||
```bash
|
||||
kubectl get all
|
||||
kubectl get all --n <namespace>
|
||||
kubectl get all --all-namespaces
|
||||
```
|
||||
|
||||
Get each specifically:
|
||||
|
||||
```bash
|
||||
kubectl get pods
|
||||
```
|
||||
|
||||
```bash
|
||||
kubectl get events --n <namespace>
|
||||
kubectl get events --sort-by=.metadata.creationTimestamp --n <namespace>
|
||||
```
|
||||
|
||||
```bash
|
||||
kubectl get services
|
||||
```
|
||||
|
||||
Check logs:
|
||||
|
||||
```bash
|
||||
kubectl logs <podId> daprd
|
||||
kubectl logs <podId> <myAppContainerName>
|
||||
kuebctl logs <deploymentId> daprd
|
||||
kubectl logs <deploymentId> <myAppContainerName>
|
||||
```
|
||||
|
||||
```bash
|
||||
kubectl describe pod <podId>
|
||||
kubectl describe deploy <deployId>
|
||||
kubectl describe replicaset <replicasetId>
|
||||
```
|
||||
|
||||
Restart a pod by running the following command:
|
||||
|
||||
```bash
|
||||
kubectl delete pod <podId>
|
||||
```
|
||||
|
||||
This causes the `replicaset` controller to restart the pod after the delete.
|
||||
|
||||
## Watch the demo
|
||||
|
||||
See the presentation on troubleshooting Dapr on Kubernetes in the [Dapr Community Call #36](https://youtu.be/pniLPRbuLD8?si=bGid7oYSp9cThtiI&t=838).
|
||||
|
||||
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/pniLPRbuLD8?si=bGid7oYSp9cThtiI&start=838" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
|
||||
## Related links
|
||||
|
||||
- [Overview of Dapr on Kubernetes]({{< ref kubernetes-overview >}})
|
||||
|
|
|
@ -73,6 +73,8 @@ dapr run node myapp.js
|
|||
|
||||
## Logs in Kubernetes mode
|
||||
|
||||
> [Learn how to debug `daprd` on Kubernetes.]({{< ref "debug-daprd.md" >}})
|
||||
|
||||
You can set the log level individually for every sidecar by providing the following annotation in your pod spec template:
|
||||
|
||||
```yml
|
||||
|
|
|
@ -49,31 +49,43 @@ dapr init [flags]
|
|||
|
||||
### Examples
|
||||
|
||||
#### Self hosted environment
|
||||
{{< tabs "Self-hosted" "Kubernetes" >}}
|
||||
|
||||
Install Dapr by pulling container images for Placement, Redis and Zipkin. By default these images are pulled from Docker Hub. To switch to Dapr Github container registry as the default registry, set the `DAPR_DEFAULT_IMAGE_REGISTRY` environment variable value to be `GHCR`. To switch back to Docker Hub as default registry, unset this environment variable.
|
||||
{{% codetab %}}
|
||||
|
||||
**Install**
|
||||
|
||||
Install Dapr by pulling container images for Placement, Redis, and Zipkin. By default, these images are pulled from Docker Hub.
|
||||
|
||||
```bash
|
||||
dapr init
|
||||
```
|
||||
|
||||
Dapr can also run [Slim self-hosted mode]({{< ref self-hosted-no-docker.md >}}), without Docker.
|
||||
|
||||
```bash
|
||||
dapr init -s
|
||||
```
|
||||
|
||||
> To switch to Dapr Github container registry as the default registry, set the `DAPR_DEFAULT_IMAGE_REGISTRY` environment variable value to be `GHCR`. To switch back to Docker Hub as default registry, unset this environment variable.
|
||||
|
||||
**Specify a runtime version**
|
||||
|
||||
You can also specify a specific runtime version. Be default, the latest version is used.
|
||||
|
||||
```bash
|
||||
dapr init --runtime-version 1.4.0
|
||||
dapr init --runtime-version 1.13.0
|
||||
```
|
||||
|
||||
**Install with image variant**
|
||||
|
||||
You can also install Dapr with a particular image variant, for example: [mariner]({{< ref "kubernetes-deploy.md#using-mariner-based-images" >}}).
|
||||
|
||||
```bash
|
||||
dapr init --image-variant mariner
|
||||
```
|
||||
|
||||
Dapr can also run [Slim self-hosted mode]({{< ref self-hosted-no-docker.md >}}) without Docker.
|
||||
|
||||
```bash
|
||||
dapr init -s
|
||||
```
|
||||
**Use Dapr Installer Bundle**
|
||||
|
||||
In an offline or airgap environment, you can [download a Dapr Installer Bundle](https://github.com/dapr/installer-bundle/releases) and use this to install Dapr instead of pulling images from the network.
|
||||
|
||||
|
@ -87,17 +99,17 @@ Dapr can also run in slim self-hosted mode without Docker in an airgap environme
|
|||
dapr init -s --from-dir <path-to-installer-bundle-directory>
|
||||
```
|
||||
|
||||
You can also specify a private registry to pull container images from. These images need to be published to private registries as shown below to enable Dapr CLI to pull them successfully via the `dapr init` command -
|
||||
**Specify private registry**
|
||||
|
||||
You can also specify a private registry to pull container images from. These images need to be published to private registries as shown below to enable Dapr CLI to pull them successfully via the `dapr init` command:
|
||||
|
||||
1. Dapr runtime container image(dapr) (Used to run Placement) - dapr/dapr:<version>
|
||||
2. Redis container image(rejson) - dapr/3rdparty/rejson
|
||||
3. Zipkin container image(zipkin) - dapr/3rdparty/zipkin
|
||||
|
||||
> All the required images used by Dapr needs to be under the`dapr` path.
|
||||
All the required images used by Dapr needs to be under the `dapr` path. The 3rd party images have to be published under `dapr/3rdparty` path.
|
||||
|
||||
> The 3rd party images have to be published under `dapr/3rdparty` path.
|
||||
|
||||
> image-registry uri follows this format - `docker.io/<username>`
|
||||
`image-registry` uri follows the `docker.io/<username>` format.
|
||||
|
||||
```bash
|
||||
dapr init --image-registry docker.io/username
|
||||
|
@ -114,7 +126,37 @@ You can specify a different container runtime while setting up Dapr. If you omit
|
|||
dapr init --container-runtime podman
|
||||
```
|
||||
|
||||
#### Kubernetes environment
|
||||
**Use Docker network**
|
||||
|
||||
You can deploy local containers into Docker networks, which is useful for deploying into separate networks or when using Docker Compose for local development to deploy applications.
|
||||
|
||||
Create the Docker network.
|
||||
|
||||
```bash
|
||||
docker network create mynet
|
||||
```
|
||||
|
||||
Initialize Dapr and specify the created Docker network.
|
||||
|
||||
```bash
|
||||
dapr init --network mynet
|
||||
```
|
||||
|
||||
Verify all containers are running in the specified network.
|
||||
|
||||
```bash
|
||||
docker ps
|
||||
```
|
||||
|
||||
Uninstall Dapr from that Docker network.
|
||||
|
||||
```bash
|
||||
dapr uninstall --all --network mynet
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{% codetab %}}
|
||||
|
||||
```bash
|
||||
dapr init -k
|
||||
|
@ -149,3 +191,7 @@ Scenario 2 : dapr image hosted under a new/different directory in private regist
|
|||
```bash
|
||||
dapr init -k --image-registry docker.io/username/<directory-name>
|
||||
```
|
||||
|
||||
{{% /codetab %}}
|
||||
|
||||
{{< /tabs >}}
|
||||
|
|
Loading…
Reference in New Issue