From 8eb48cf13943acd59bb17375e50970c8c3d9e487 Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Fri, 28 Oct 2022 15:32:52 -0500 Subject: [PATCH 1/2] ENDOC-595 update ent app and ent pod info --- vuepress/docs/next/docs/getting-started/ent-diag.md | 6 +++--- vuepress/docs/v7.1/docs/getting-started/ent-diag.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/vuepress/docs/next/docs/getting-started/ent-diag.md b/vuepress/docs/next/docs/getting-started/ent-diag.md index 119ac232e3..a50c5839e2 100644 --- a/vuepress/docs/next/docs/getting-started/ent-diag.md +++ b/vuepress/docs/next/docs/getting-started/ent-diag.md @@ -12,16 +12,16 @@ Diagnostic information is critical to analysis and troubleshooting, and the Enta | `ent bundle info` |Show status information for the bundle project| | `ent --debug bundle "command"` |Enable debug mode| | `ent diag` | Run diagnostics on the pods currently in an Entando namespace and prepare a diagnostic tar.gz -| `ent pod-info` | Display the output of `kubectl describe` and `kubectl logs` for each Entando pod in a namespace +| `ent pod "command"` | Displays information related to a set of pods | `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods - ### Command Details -* `ent diag`: Executes operations to analyze, organize and output detailed pod information. In addition to calling `ent pod-info`, `ent diag` exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. It also generates diagnostics and returns log paths similar to the following: +* `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command also generates diagnostics and returns log paths like the following: ``` > Collected diagdata available under "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000" for consultation > Collected diagdata available in archive "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000.tgz" ``` +* `ent pod "command"`: Analyzes pods in a cluster with commands like `describe`, `logs`, `shell`, `force-reload`, `port-forward`, and others. ### Log Files Log files for the `ent bundle build` and `pack` commands are generated for each component inside the .entando/logs directory. For single components and other processes, they are printed to the standard outputs. \ No newline at end of file diff --git a/vuepress/docs/v7.1/docs/getting-started/ent-diag.md b/vuepress/docs/v7.1/docs/getting-started/ent-diag.md index 119ac232e3..e5fcccd15b 100644 --- a/vuepress/docs/v7.1/docs/getting-started/ent-diag.md +++ b/vuepress/docs/v7.1/docs/getting-started/ent-diag.md @@ -12,16 +12,16 @@ Diagnostic information is critical to analysis and troubleshooting, and the Enta | `ent bundle info` |Show status information for the bundle project| | `ent --debug bundle "command"` |Enable debug mode| | `ent diag` | Run diagnostics on the pods currently in an Entando namespace and prepare a diagnostic tar.gz -| `ent pod-info` | Display the output of `kubectl describe` and `kubectl logs` for each Entando pod in a namespace +| `ent pod "command"` | Displays information related to a set of pods | `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods - ### Command Details -* `ent diag`: Executes operations to analyze, organize and output detailed pod information. In addition to calling `ent pod-info`, `ent diag` exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. It also generates diagnostics and returns log paths similar to the following: +* * `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command also generates diagnostics and returns log paths like the following: ``` > Collected diagdata available under "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000" for consultation > Collected diagdata available in archive "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000.tgz" ``` +* `ent pod "command"`: Analyzes pods in a cluster with commands like `describe`, `logs`, `shell`, `force-reload`, `port-forward`, and others. ### Log Files Log files for the `ent bundle build` and `pack` commands are generated for each component inside the .entando/logs directory. For single components and other processes, they are printed to the standard outputs. \ No newline at end of file From 7ecc766f57c31066e547513075852faec097e5f5 Mon Sep 17 00:00:00 2001 From: jyunmitch Date: Mon, 31 Oct 2022 15:57:39 -0500 Subject: [PATCH 2/2] ENDOC-595 minor correction --- vuepress/docs/v7.1/docs/getting-started/ent-diag.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vuepress/docs/v7.1/docs/getting-started/ent-diag.md b/vuepress/docs/v7.1/docs/getting-started/ent-diag.md index e5fcccd15b..1a67b8170a 100644 --- a/vuepress/docs/v7.1/docs/getting-started/ent-diag.md +++ b/vuepress/docs/v7.1/docs/getting-started/ent-diag.md @@ -16,7 +16,7 @@ Diagnostic information is critical to analysis and troubleshooting, and the Enta | `ent pod grep --all "error\|fail"` | Locate error messages within EntandoApp pods ### Command Details -* * `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command also generates diagnostics and returns log paths like the following: +* `ent diag`: Executes operations to analyze, organize and output detailed pod information. It exports custom resources, ingresses, deployments, "previous" pod logs, namespace events, etc. The command also generates diagnostics and returns log paths like the following: ``` > Collected diagdata available under "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000" for consultation > Collected diagdata available in archive "~/.entando/reports/entando-diagdata-2020-11-19T02:58:47+0000.tgz"