Rediops

The backbone for increased productivity with qaskx-cli command is the rediOps definition stored as file ./well-known/devops.json.

The rediOps definition is the container for the source metadata or project attributes where most of these attributes are keys, such as the service identifier, or links to script files.

The rediOps definition and file specification can be viewed on Github at location https://github.com/meerkat-manor/rediOps or you can search for github rediops

The rediOps file can contain metadata such as:

  • Unique identifier such as CI from a CMDB
  • Governance details
  • Ownership
  • Repository - not just Git but also items such as Nuget and Docker
  • OpenAPI file, dependencies such as other APIs or Databases
  • Location of build, test, pipeline and deploy scripts
  • Software Bill of Materials (SBOM) link

The metadata is explicitly stored instead of being implictly assumed with given names in given locations in your project.

The metadata supplied is optional, but the more metadata that is supplied the more beneficial it becomes. Tools such as qaskx-cli can place sane default metadata into the definition and then use this information to build, test and deploy the asset.

As the rediOps definition is stored as a plain JSON file, at location .well-known/devops.json in the project directory you can always view and change the file contents to match your requirements. If you are manually modifying the file contents then it is recommended you reference the rediOps specification to ensure the changes are valid.