k8s.io/test-infra@v0.0.0-20240520184403-27c6b4c223d8/hack/cluster-migration/README.md (about)

     1  # Kubernetes Prow Job Statistics
     2  
     3  This program provides a detailed statistical report on the jobs within the Kubernetes Prow configuration. It offers insights on the total number of jobs, their distribution across clusters, and individual repository statistics.
     4  
     5  ## Table of Contents
     6  
     7  - [Features](#features)
     8  - [Usage](#usage)
     9  
    10  ## Features
    11  
    12  - **Total Job Count**: Quickly get the total count of all jobs present within the configuration.
    13  - **Cluster-wise Statistics**: See the distribution of jobs across different clusters. Understand the spread between Google jobs and community jobs.
    14  - **Repository-wise Statistics**: Get a detailed report of each repository, showing the number of complete, total, remaining jobs, and the completion percentage.
    15  
    16  ## Usage
    17  
    18  1. **Clone the Repository**: Ensure you have the repository containing the program on your local machine.
    19  
    20  2. **Navigate to the Directory**: Change your directory to where the program resides.
    21  
    22  3. **Compile the Program**:
    23      ```bash
    24      go build main.go
    25      ```
    26  
    27  4. **Run the Program**:
    28      ```bash
    29      ./main --config=path_to_prow_config --job-config=path_to_job_config --repo-report
    30      ```
    31  
    32      - `--config`: Path to the prow config. Default: `../../config/prow/config.yaml`
    33      - `--job-config`: Path to prow job config. Default: `../../config/jobs`
    34      - `--repo-report`: If set, a detailed report of all repo status will be provided.