As part of our commitment to integration between Gen and standard DevOps tools, we are providing sample code alongside a white paper describing a streamlined Gen developer workflow. These scripts are intended to illustrate the integration opportunities that are already present with your Gen installation. There are no requirements to install new Gen components to utilize functionality in these scripts.
You will need to have an Endevor SCM installation, and you must be able to access the installation through the Endevor SCM plugin for Zowe CLI. The details of setting this up will not be detailed here, and you should consult with your Endevor administrator, or the Endevor product documentation for details on what is required to install and configuration those components.
If you are having any trouble getting started with the scripts or running them, please create an issue in this project.
You must have a valid Python 3 installation on the machine where the scripts execute. You can find instructions for how to install Python on your platform of choice by visiting Python downloads. There are also many resources available online that detail how to install Python on different platforms.
Once Python is installed, you must download the PyYAML module using pip (pip install PyYAML). This can
either be done on a global level, or utilizing a virtual environment.
You must have a valid installation of the Zowe CLI. The recommended approach is to use a supported environment, like CA Brightside. This takes out much of the guesswork and trial-and-error that can sometimes accompany installing and configuring open source tools.
However, the only requirements for the scripts to run correctly are to have a valid Zowe CLI with the Endevor SCM for Zowe CLI plugin installed and correctly configured.
You must create a profile of type endevor-profile that points to the Endevor web service configured for your environment. The types of information required for an endevor-profile are things like host, port, protocol, etc. Be sure to remember the name because it is a required configuration parameter for the Python scripts.
The Python scripts currently require a configuration file in YAML format. There is a sample YAML configuration script
provided in the resources directory. You should make a copy of the sample.yml file and tailor the values to
match your environment and preferences. The config file has inline comments describing the function of the variables,
but many of them are self-explanatory.
How you run the scripts will depend on the platform that you choose. The scripts are meant to be invoked from a CLI, but
you can use whatever terminal application you desire on your platform. To view the usage help for the scripts you can
execute one of the following commands from your terminal:
./process-remote-file.py --help on *nix platforms and python3 process-remote-file.py --help
on Windows.
The usage help details all the available command-line arguments and what values are appropriate. Before running the scripts, make sure you take a look at the usage help.