Skip to content

Latest commit

 

History

History
106 lines (68 loc) · 4.4 KB

README.md

File metadata and controls

106 lines (68 loc) · 4.4 KB
Raw

bahmni-infra-utils

Non-application specific utilities for Bahmni infra

📦 image-scanner.sh

This shell script automates the process of scanning images from a specific Docker organization (passed in, as an argument) using the Trivy vulnerability scanner. The script retrieves a list of Docker repositories from Docker Hub and runs Trivy scans on each image to generate security reports. These reports are saved as HTML files in a designated directory.

To use this script:

  1. Save the script as image-scanner.sh.

  2. Make the script executable by running the following command in your terminal:

    chmod +x image-scanner.sh

  3. Run the script with the organization name as the argument to generate the scan report of the images from bahmni namespace.

    Example usage:

    ./image-scanner.sh bahmni

    NOTE: Replace ./image-scanner.sh with the actual path to your script file if it's located in a different directory.

📦 html.tpl

The provided HTML template is used by the Trivy vulnerability scanner in the image-scanner.sh script to generate detailed reports on the images. The template is responsible for formatting the vulnerability and misconfiguration data produced by Trivy scans into an easily readable and visually structured HTML document.

📦 setArtifactVersion.sh

This script is used in GitHub Actions to set ARTIFACT_VERSION as an environment variable in the actions runner. It determines the version based on the context of the GitHub event (tag, release branch, or other branch) and supports an optional argument to specify a custom version file. If no version file is provided, the script defaults to using package/.appversion.

The version would be set as follows:

  • Tag Push: If the push is a tag, the version would be the tag name.
  • Release Branch Push: If the push is on a branch named release-<version>, the version would be <version>-rc.
  • Other Branch Push:
    • The version would be <version>-<github_run_number>, where <version> is read from the specified version file.
    • If no version file is specified, the version will be read from package/.appversion.

Usage

The script can be executed with or without passing a custom version file:

  • Without a custom version file, in this case, the script will use package/.appversion by default:
./setArtifactVersion.sh
  • With a custom version file:
./setArtifactVersion.sh path/to/custom/.appversion

In this case, the version will be read from the specified file (path/to/custom/.appversion).

📦 transifex.sh

This script simplifies the process of managing translations for Bahmni projects. It is used for pushing and pulling translations to/from Transifex. It checks if the Transifex CLI is installed, and if not, installs it. Then, it performs the specified Transifex operation (push or pull) based on the provided argument.

To use this script:

  1. Save the script in your repository.

  2. Make sure to have a .tx/config file in your repository for Transifex configuration.

  3. Make the script executable by running the following command in your terminal:

    chmod +x transifex.sh

  4. Run the script with the appropriate argument (push or pull) to perform the desired operation.

    Example usage:

    ./transifex.sh push
./transifex.sh pull

    NOTE: Replace ./transifex.sh with the actual path to your script file if it's located in a different directory.

📦 trivy_scan.sh

This script can be used in Github Actions to run a Trivy Filesystem scan and Secrets Scan. Here are the instructions for how to use it:

  • You can add the following step to your Github Actions workflow:

    - name: Trivy Scan
  run: |
    wget -q https://raw.githubusercontent.com/Bahmni/bahmni-infra-utils/main/trivy_scan.sh && chmod +x trivy_scan.sh
    ./trivy_scan.sh
    rm trivy_scan.sh.sh

This will download the script from the Github repository, make it executable, run it, and then remove it. You can also pass command line arguments to the script in this workflow step to specify the paths to scan.

./trivy_scan.sh <path> <path>