About this Documentation

orcharhino is a large software suite that emphasizes user choice and vendor independence. As a result, orcharhino often supports multiple solutions, even for a single type of feature. For example, orcharhino supports the use of Ansible, Puppet, and Salt for its configuration management.

Keeping this in mind, not every aspect of orcharhino will be of equal interest to all users and this documentation is not primarily intended to be read from front to back.

This section of the introduction serves to illustrate the structure of the documentation and how to approach reading it.

This documentation describes orcharhino as seen by an administrative user with full access permissions.

In addition to this documentation, there is also an orcharhino Knowledge Base to collect short guides, best practices, and recommendations that do not fit naturally within the structure of this documentation.

Section Structure and References

This documentation uses headings of different levels to provide structure. Throughout this documentation we refer to top level headings as chapters, second level headings as sections, third level headings as subsections, and fourth level headings as subsubsections. For example, you are currently reading the structure and references subsection of the about this documentation section of the introduction chapter.

Depending on context, the term section can also be used to refer to everything contained in a single heading of arbitrary level. For example, the following section is the entry points subsection.

In addition this documentation makes ubiquitous use of references (links) to the various section headings. Each section header in the previous two examples is a link to the relevant section. References allow readers to follow some topic of interest around the documentation and help to avoid duplicate documentation.

Entry Points

The installation and maintenance chapter deals with the initial orcharhino installation as well as with routine maintenance like upgrades and backups. The installing plugins page is dedicated to optional plugins that can be installed to extend orcharhino’s core feature set.

By contrast, the structure of the management UI chapter closely shadows the structure of the orcharhino web interface. Each orcharhino menu is given its own section and each menu entry is given its own subsection. As such, each page in this chapter seeks to be a viable entry point for reading the documentation. Ultimately, the management UI chapter should provide detailed documentation on every page, button, and action that can be accessed through orcharhino’s web interface.

Each section in the usage guides chapter is dedicated to a self contained topic of interest on some individual aspect of orcharhino. Each such usage guide can be read if and when it becomes relevant to a particular reader’s orcharhino usage. Each individual usage guide is intended to be read from front to back.

The configuration management chapter contains usage guides for each of the three configuration management systems supported by orcharhino: Ansible, Puppet, and Salt.

The compute resource chapter contains information on how to attach compute resource providers to orcharhino. It holds instructions for Amazon EC2, Google GCE, Microsoft Azure, Proxmox, and VMware.

The troubleshooting chapter contains instructions for topics relating to troubleshooting orcharhino like logging and background services.

The ATIX Support chapter includes information about ATIX’s orcharhino support, as well as information on the orcharhino Knowledge Base.

The glossary contains definitions on the most frequently used terms throughout orcharhino and its documentation.

Offline Usage

Every orcharhino instance contains the documentation at orcharhino.example.com/or_doc/index. Alternatively, you can download a .zip archive of the orcharhino documentation to your local machine.