This repository contains a collection of documents describing known deployment configurations for OKD. The information is categorized by deployment platform and installation options, and tracks with the current release of OKD except where noted. Please note, these documents describe configurations for newly installed clusters and do not include resources which may be required during installation (eg bootstrap instances).

These notes serve as a common place for sharing platform configurations, and exposing more of the tribal knowledge that has been aquired by developers and operators working closely with OKD.

The files in this repository are divided into directories for each specific deployment platform. Within each directory are Markdown files for different deployment scenarios. For example, most platforms will have a "Default IPI" document which describes the configuration for a cluster that has been created using the OpenShift installer with a minimal configuration file.

Contributions to the notes are welcomed through pull requests from forked versions of this repository.

When proposing changes to the repository, place your content in the platform directory associated with your notes. Within each directory, look for a file with a similar configuration to your changes. If none exists you should create a new file that indicates what configuration you are describing. For example, if writing about deploying in a disconnected network scenario, you might create a file named IPI-disconnected-network.md.

For inspiration about how to structure content within your document, please see one of the IPI-default.md files.

If you are documenting your personal "home lab" setup, please use your github username in the filename, for example UPI-elmiko.md.

And if all else fails, please do not hesitate to open your pull request and start a discussions with your questions and concerns about implementation.