Check out the following FAQs to learn more about the purpose and function of Zowe™.
Zowe is an open source project within the Open Mainframe Project that is part of The Linux Foundation. The Zowe project provides modern software interfaces on IBM z/OS to address the needs of a variety of modern users. These interfaces include a new web graphical user interface, a script-able command-line interface, extensions to existing REST APIs, and new REST APIs on z/OS.
Zowe technology can be used by a variety of mainframe IT and non-IT professionals. The target audience is primarily application developers and system programmers, but the Zowe Application Framework is the basis for developing web browser interactions with z/OS that can be used by anyone.
In the simplest terms (taken from the FAQs above) - "...if you have modified EPL-2.0 licensed source code and you distribute that code or binaries built from that code outside your company, you must make the source code available under the EPL-2.0."
The Open Mainframe Project wants to encourage adoption and innovation, and also let the community share new source code across the Zowe ecosystem. The open source code can be used by anyone, provided that they adhere to the licensing terms.
The Zowe Desktop (web user interface) can be used in many ways, such as to provide custom graphical dashboards that monitor data for z/OS products and applications.
Zowe CLI can also be used in many ways, such as for simple job submission, data set manipulation, or for writing complex scripts for use in mainframe-based DevOps pipelines.
The increased capabilities of RESTful APIs on z/OS allows APIs to be used in programmable ways to interact with z/OS services.
Zowe provides a convenience build that includes the components released-to-date, as well as IP being considered for contribution, in an easy to install package on Zowe.org. The convenience build can be easily installed and the Zowe capabilities seen in action.
To install the complete Zowe solution, see Installing Zowe.
To get up and running with the Zowe CLI component quickly, see Zowe CLI quick start.
Prerequisites vary by component used, but in most cases the primary prerequisites are Java and NodeJS on z/OS and the z/OS Management Facility enabled and configured. For a complete list of software requirements listed by component, see System requirements for z/OS components and System requirements for Zowe CLI.
Docker is a download option for Zowe that allows you to run certain Zowe server components outside of z/OS. The Docker image contains the Zowe components that do not have the requirement of having to run on z/OS: The App server, API Mediation Layer, and the USS/MVS/JES Explorers.
Configurating components with Docker is similar to the procedures you would follow without Docker, however tasks such as installation and running with Docker are a bit different, as these tasks become Linux oriented, rather than utilizing Jobs and STCs.
NOTE: z/OS is still required when using the Docker image. Depending on which components of Zowe you use, you'll still need to set up z/OS Management Facility as well as Zowe's ZSS and Cross memory servers.
At this time, the Docker image referred to in this documentation contains only Zowe server components. It is possible to make a Docker image that contains the Zowe CLI, so additional Zowe content, such as the CLI, may have Docker as a distribution option later.
If you are interested in improvements such as this one, please be sure to express that interest to the Zowe community!
Only the parts of Zowe that involve Java code are ZIIP enabled. The API Mediation Layer composed of the API Gateway, Discovery and Catalog servers along with any Java-based services that work with them such as the Jobs and Datasets servers are ZIIP enabled. Also, the CLI and VSCode Explorer make large use of z/OSMF, which is Java so they are ZIIP enabled as well. More details on portions of Zowe which are Java (ZIIP) enabled can be found here.
This leaves C and NodeJS code which are not ZIIP enabled, BUT, we have a tech preview available currently that allows execution of Java as well as NodeJS code, on Linux or zLinux via Docker. With the tech preview, only the C code remains on z/OS, which is not ZIIP enabled.
Zowe components use typical z/OS System authorization facility (SAF) calls for security.
The source code for Zowe is maintained on an Open Mainframe Project GitHub server. Everyone has read access. "Committers" on the project have authority to alter the source code to make fixes or enhancements. A list of Committers is documented in Committers to the Zowe project.
The best way to get started is to join a Zowe Slack channel and/or email distribution list and begin learning about the current capabilities, then contribute to future development.
For more information about emailing lists, community calendar, meeting minutes, and more, see the Zowe Community GitHub repo.
For information and tutorials about extending Zowe with a new plug-in or application, see Extending on Zowe Docs.
Zowe will continue to evolve in the coming years based on new ideas and new contributions from a growing community.
IBM has contributed a free hands-on tutorial for Zowe. Visit the Zowe Tutorial page to learn about adding new applications to the Zowe Desktop and and how to enable communication with other Zowe components.
The Zowe community is also currently working to provide a vendor-neutral site for an open z/OS build and sandbox environment.
Zowe is also compatible with IBM z/OSMF Lite for non-production use. For more information, see Configuring z/OSMF Lite on Zowe Docs.
For developers new to the mainframe, command-line interfaces might be more familiar than an ISPF interface. Zowe CLI lets developers be productive from day-one by using familiar tools. Zowe CLI also lets developers write scripts that automate a sequence of mainframe actions. The scripts can then be executed from off-platform automation tools such as Jenkins automation server, or manually during development.
Zowe CLI is very flexible; developers can integrate with modern tools that work best for them. It can work in conjunction with popular build and testing tools such as Gulp, Gradle, Mocha, and Junit. Zowe CLI runs on a variety of operating systems, including Windows, macOS, and Linux. Zowe CLI scripts can be abstracted into automation tools such as Jenkins and TravisCI.
|Interactive use, in a command prompt or bash terminal.||Perform one-off tasks such as submitting a batch job.|
|Interactive use, in an IDE terminal||Download a data set, make local changes in your editor, then upload the changed dataset back to the mainframe.|
|Scripting, to simplify repetitive tasks||Write a shell script that submits a job, waits for the job to complete, then returns the output.|
|Scripting, for use in automated pipelines||Add a script to your Jenkins (or other automation tool) pipeline to move artifacts from a mainframe development system to a test system.|
You can install Zowe CLI using the following methods:
Local package installation: The local package method lets you install Zowe CLI from a zipped file that contains the core application and all plug-ins. When you use the local package method, you can install Zowe CLI in an offline environment. We recommend that you download the package and distribute it internally if your site does not have internet access.
Online NPM registry: The online NPM (Node Package Manager) registry method unpacks all of the files that are necessary to install Zowe CLI using the command line. When you use the online registry method, you need an internet connection to install Zowe CLI
- Zowe CLI runs significantly faster when you run it in daemon mode. Daemon mode significantly improves the performance of Zowe CLI commands by running Zowe CLI as a persistent background process. For more information, see Using daemon mode.
- Zowe CLI V2 introduces team profiles. Using team profiles helps to improve the initial setup of Zowe CLI by making service connection details easier to share and easier to store within projects. For more information, see Using team profiles.
- You can automate a sequence of Zowe CLI commands by writing bash scripts. You can then run your scripts in an automation server such as Jenkins. For example, you might write a script that moves your Cobol code to a mainframe test system before another script runs the automated tests.
- Zowe CLI lets you manipulate data sets, submit jobs, provision test environments, and interact with mainframe systems and source control management, all of which can help you develop robust continuous integration/delivery.
As a developer, you can extend Zowe CLI in the following ways:
Build a plug-in for Zowe CLI
Contribute code to the core Zowe CLI
Fix bugs in Zowe CLI or plug-in code, submit enhancement requests via GitHub issues, and raise your ideas with the community in Slack.
Note: For more information, see Developing for Zowe CLI.
The Zowe Explorer VSCode extension provides developers new to the mainframe with a modern UI, allowing you to access and work with the data set, USS, and job functionalities in a fast and streamlined manner. In addition, Zowe Explorer enables you to work with Zowe CLI profiles and issue TSO/MVS commands.
First of all, make sure you fulfill the following Zowe Explorer software requirements:
- Get access to z/OSMF.
- Install Node.js v8.0 or later.
- Install VSCode.
- Configure TSO/E address space services, z/OS data set, file REST interface, and z/OS jobs REST interface. For more information, see z/OS Requirements.
Once the software requirements are fulfilled, create a Zowe Explorer profile.
Follow these steps:
- Navigate to the explorer tree.
- Click the + button next to the DATA SETS, USS, or JOBS bar.
- Select the Create a New Connection to z/OS option.
- Follow the instructions, and enter all required information to complete the profile creation.
You can also watch Getting Started with Zowe Explorer to understand how to use the basic features of the extension.
The Secure Credential Store Plug-in is no longer required for Zowe Explorer.
Secure credential storage functionality is now contained in the Zowe CLI core application.
Zowe Explorer V2 supports using Service Profiles, Base Profiles, and Team Profiles. For more information, see Using profiles in the Using Zowe CLI section.
See the Zowe FTP extension README in GitHub for information about how to build, install, and use FTP as your back-end service for working with UNIX files.
As a developer, you may contribute to Zowe Explorer in the following ways:
Build a Zowe Explorer extension.
Contribute code to core Zowe Explorer.
Fix bugs in Zowe Explorer, submit enhancement requests via GitHub issues, and raise your ideas with the community in Slack.
Note: For more information, see Extending Zowe Explorer.
Zowe IntelliJ plug-in allows you to access and work with data sets, members and jobs directly from your IntelliJ-based IDE.
Install the plug-in in your IntelliJ-based IDE directly from marketplace or download it from here.
You can use it in any IntelliJ-based IDE.
To create a connection, expand plug-in panel on an IDE sidebar (on the right side of your screen) and press the "wrench" pictogram, or go to File -> Settings (CTRL+ALT+S), select Zowe Explorer (Zowe IntelliJ plugin) and then switch to the z/OSMF connection tab. Press the “+” button and fill inn all necessary fields.
If you have something to introduce but there is no related issue in the project repo, then you can either create the issue by yourself or contact us to help you with it. See more information in the CONTRIBUTION.md file.