Skip to content

Add repository health checks for README links, issue forms, and contributor metadata #124

@Sarfaraz604

Description

@Sarfaraz604

Description

Mifos Gazelle deploys multiple components: infrastructure, MifosX, Payment Hub EE, Mojaloop vNext, and Mastercard demo. The repo already has placeholder test functions in src/deployer/deployer.sh (test_vnext, test_phee, test_mifosx) and CircleCI does basic pod/endpoint checks, but users do not have a reusable local command to verify a deployment after run.sh completes.

Add a post-deployment health check/test mode that validates selected deployed components and prints actionable diagnostics.

Goals

  • Add a new test or healthcheck mode to run.sh.
  • Implement health checks for infra, mifosx, vnext, and phee.
  • Reuse existing helpers/logging style from the deployer scripts.
  • Check Kubernetes pod readiness by namespace.
  • Check key web endpoints where applicable.
  • Integrate or document use of src/utils/k8s-error-summary.py when checks fail.
  • Update docs with usage examples.

Expected Outcome

A contributor or operator can run a command like:

sudo ./run.sh -u $USER -m test -a all


## Acceptance Criteria
-run.sh -h documents the new mode.
-Input validation accepts the new mode.
-Health checks can run for individual components and all.
-Failed checks return a non-zero exit code.
-Output clearly identifies failed namespace, pod, or endpoint.
-Existing deploy and cleanup behavior is not changed.
--Documentation is updated in docs/MIFOS-GAZELLE-README.md.
Implementation Details
##Relevant areas:

src/commandline/commandline.sh
src/deployer/deployer.sh
src/utils/helpers.sh
src/utils/k8s-error-summary.py
.circleci/config.yml
docs/MIFOS-GAZELLE-README.md
The existing placeholder functions in deployer.sh can be expanded:

test_vnext
test_phee
test_mifosx
The CircleCI health check logic can be used as a reference, but the new implementation should be usable locally by contributors.

##Product Name
Mifos Gazelle

##Organisation Name
The Mifos Initiative

##Domain
Financial Inclusion

##Tech Skills Needed
Shell, Kubernetes, Docker, CI/CD, Testing, Debugging

##Category
Testing, DevOps, Maintenance

##Complexity
Medium


Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions