Skip to content

Commit e557a22

Browse files
committed
update based comments
1 parent 00723a2 commit e557a22

File tree

2 files changed

+16
-16
lines changed

2 files changed

+16
-16
lines changed

articles/container-apps/container-console.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ ms.author: v-wellsjason
1616
Connecting to a container's console is useful when you want to troubleshoot your application inside a container. Azure Container Apps allows you to connect to a container's console using the Azure portal or Azure CLI.
1717

1818
> [!NOTE]
19-
> Azure Container Apps platform offers [Debug Console](container-debug-console.md) to help you troubleshoot your applications if your applications use distroless image.
19+
> Azure Container Apps platform offers a [debug console](container-debug-console.md) to help you troubleshoot your applications if your applications use containers that only include your application and its runtime dependencies, or a "distroless" image.
2020
2121
## Azure portal
2222

articles/container-apps/container-debug-console.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ ms.author: fangjimmy
1313

1414
# Connect to a container debug console in Azure Container Apps
1515

16-
Azure Container Apps platform offers debug console to help you troubleshoot your application under the following circumstances:
16+
Azure Container Apps platform offers a debugging console to help you troubleshoot your application under the following circumstances:
1717

18-
- You cannot connect to the target container when you use distroless image.
18+
- You cannot connect to the target container when you use a container that only includes the application and its runtime dependencies, or a "distroless" image.
1919
- When encounter networking issues, your images do not have debugging utilities to investigate them.
2020

2121
You can connect to debug console using the Azure CLI.
2222

2323
> [!NOTE]
24-
> Debug Console will create a separate container, which will share underlying resources with the container your app is running on. If a debug container already exists, Debug Console will reuse the existing one instead of creating a new one. There will be at most 1 running debug container per Container App replica. If you do not need to keep a debug container running any more, please type **exit** or press **Ctrl + D** in Debug Console session.
24+
> The debug console creates a separate container, which shares the underlying resources with the container where your app is running. If a debug container already exists, the debug console reuses the existing one instead of creating a new one. There is at most one running debug container per container app replica. If you do not need to keep a debug container running, please enter **exit** or use **Ctrl/Cmd + D** in the debug console session.
2525
2626
## Azure CLI
2727

28-
To connect to a container debug console, Use the `az containerapp debug` command. To exit the console, enter **exit** or press **Ctrl + D**.
28+
To connect to a container the debug console, use the `az containerapp debug` command. To exit the console, enter **exit** or use **Ctrl/Cmd + D**.
2929

30-
For example, connect to a container debug console in a container app with a single container using the following command. Replace the \<PLACEHOLDERS\> with your container app's values.
30+
For example, connect to a container debug console in a container app with a single container using the following command. Before you run this command, replace the `<PLACEHOLDERS>` with your container app's values.
3131

3232
# [Bash](#tab/bash)
3333

@@ -51,11 +51,11 @@ To connect to a container debug console in a container app with multiple revisio
5151

5252
| Argument | Description |
5353
|----------|-------------|
54-
| `--revision` | The revision names of the container to connect to. |
55-
| `--replica` | The replica name of the container to connect to. |
56-
| `--container` | The container name of the container to connect to. |
54+
| `--revision` | The revision name of the container to debug. |
55+
| `--replica` | The replica name of the container to debug. |
56+
| `--container` | The container name of the container to debug. |
5757

58-
You can get the revision names with the `az containerapp revision list` command. Replace the \<PLACEHOLDERS\> with your container app's values.
58+
You can get the revision names with the `az containerapp revision list` command. Before you run this command, replace the `<PLACEHOLDERS>` with your container app's values.
5959

6060
# [Bash](#tab/bash)
6161

@@ -77,7 +77,7 @@ az containerapp revision list `
7777

7878
---
7979

80-
Use the `az containerapp replica list` command to get the replica and container names. Replace the \<PLACEHOLDERS\> with your container app's values.
80+
Use the `az containerapp replica list` command to get the replica and container names. Before you run this command, replace the `<PLACEHOLDERS>` with your container app's values.
8181

8282
# [Bash](#tab/bash)
8383

@@ -101,7 +101,7 @@ az containerapp replica list `
101101

102102
---
103103

104-
Connect to the container debug console with the `az containerapp debug` command. Replace the \<PLACEHOLDERS\> with your container app's values.
104+
Connect to the container debug console with the `az containerapp debug` command. Before you run this command, replace the `<PLACEHOLDERS>` with your container app's values.
105105

106106
# [Bash](#tab/bash)
107107

@@ -129,7 +129,7 @@ az containerapp debug `
129129

130130
## Built-in tools in Debug Console
131131

132-
We preinstalled below diagnostic tools to help you troubleshoot issues more easily in debug console.
132+
The following diagnostic tools are preinstalled to the debug console to help you troubleshoot issues:
133133

134134
- [ip-utils](https://github.com/iputils/iputils)
135135
- [net-tools](https://github.com/ecki/net-tools)
@@ -144,9 +144,9 @@ We preinstalled below diagnostic tools to help you troubleshoot issues more easi
144144
- [bind-utils](https://www.linuxfromscratch.org/~ken/inkscape-python-deps/blfs-book-sysv/basicnet/bind-utils.html)
145145
- [tcpping](http://www.vdberg.org/~richard/tcpping.html)
146146

147-
If you want to install other tools, you can run `tdnf install -y <TOOL_NAME>` command. Replace the \<PLACEHOLDERS\> with your tool's values.
147+
If you want to install other tools, run the `tdnf install -y <TOOL_NAME>` command. Before you run this command, replace the `<PLACEHOLDERS>` with your container app's values.
148148

149-
For example, install JDK in debug console in a container app using the following command:
149+
For example, install JDK in the debug console using the following command:
150150

151151
```bash
152152
tdnf install -y msopenjdk-17
@@ -158,7 +158,7 @@ tdnf install -y msopenjdk-17
158158

159159
By default, debug console runs as root user.
160160

161-
You can access /proc/1 to access container's file system if your container runs as root user. If your container does not run as root user, run below command to switch user before accessing /proc/1 directory, or you'll get permission denied error.
161+
You can access `/proc/1` to access container's file system if your container runs as root user. If your container does not run as root user, run below command to switch user before accessing `/proc/1` directory, or you'll get a permission denied error.
162162

163163
```bash
164164
switch-to-app-user

0 commit comments

Comments
 (0)