|
13 | 13 | # limitations under the License. |
14 | 14 |
|
15 | 15 | """ |
16 | | -A DAG to validate the `tpu-info -help` command execution inside TPU worker pods. |
| 16 | +A DAG to validate the `tpu-info` CLI tool, ensuring help documentation, |
| 17 | +version metadata, and process monitoring are functional inside TPU worker pods. |
17 | 18 | """ |
18 | 19 |
|
19 | 20 | import datetime |
@@ -168,14 +169,22 @@ def validate_tpu_info_process(info: node_pool.Info, pod_name: str) -> str: |
168 | 169 | "v6e-16", |
169 | 170 | ], |
170 | 171 | description=( |
171 | | - "This DAG validates the `tpu-info -help` command " |
172 | | - "execution inside TPU worker pods " |
| 172 | + "Validates tpu-info CLI tool: help documentation, version metadata, " |
| 173 | + "and process monitoring capabilities inside TPU worker pods." |
173 | 174 | ), |
174 | 175 | doc_md=""" |
175 | 176 | ### Description |
176 | | - This DAG validates the `tpu-info -help` command execution inside TPU worker pods |
177 | | - across different TPU versions and machine configurations. |
178 | | - It ensures that the command runs successfully and returns the expected help information. |
| 177 | + This DAG performs an end-to-end validation of the `tpu-info` observability tool |
| 178 | + within TPU worker pods. It ensures the CLI tool is correctly installed and |
| 179 | + functional across different TPU configurations. |
| 180 | +
|
| 181 | + ### Validation Steps: |
| 182 | + 1. **Help Menu Validation**: Verifies `tpu-info -help` displays all required |
| 183 | + options (streaming, rate, etc.) and specific usage instructions. |
| 184 | + 2. **Process Table Validation**: Confirms `tpu-info --process` can successfully |
| 185 | + map PIDs to TPU chips. |
| 186 | + 3. **Version Validation**: Ensures `tpu-info --version` correctly reports |
| 187 | + the tool version, libtpu version, and accelerator type. |
179 | 188 | """, |
180 | 189 | ) as dag: |
181 | 190 | for machine in MachineConfigMap: |
|
0 commit comments