qaskx-cli
The purpose of qaskx-cli is to provide a command line tool to use information captured in the rediOps and use it to perform the defined development and operations actions on the code and any generated artefacts.
The documentation for qaskx-cli is provided at this site.
qaskx-cli Concept
The qaskx-cli is a command line tool that can be chained with other tools used in your development, continuous integration and deployment software lifecycles.
The qaskx-cli is the command tool that manages the rediOps definition held in a “.well-known” locatio to achieve this.
There are commands and subcommands that provide various capabilities to manage the rediOps definition.
rediOps Concept
The basic concept of rediOps is to provide a single definition file that provides the links to other project and source metadata files, reducing the clutter in the source root directory or relying on assumed locations of files.
The objective is that there is no change required to existing DevOps, DataOps or DevSecOps processes but you can capture information in the rediOps definition so that assumptions are not made and you have one location to record metadata and scripts to execute. The information is retained and linked to the source code with the Version Control System such as git.
The long term benefit is that your organisation can record the tools and the scripts that are used at a point in time and you can change tooling or different teams can have different tools, but a metadata record exists with the code of this tooling and its evolution.
Only the current active tools are defined but the definition version tracks the journey of the tools.
At the heart of the rediOps concept is a devops.json file stored in the .well-known
directory. The use of the .well-known directory follows the industry web practice of
an Internet site having a well known directory exposed which contains metadata files.
An example of this is the files used in OpenID.
In the case of rediOps, the location is not an Internet site but a source code directory. Of course this location can also be exposed to the Internet if the source code is hosted on a version control system (VCS) such as GitHub, GitLab, Bitbucket or Gitea.
Before adopting or using the qaskx-cli command line tool you are encouraged to read about the rediOps purpose and schema. If the rediOps principle is not a concept aligned with your organisation then the qaskx-cli is unlikely to be a useful tool.
qaskx-cli is a command line program written in golang and therefore is portable.