This document describes how to install, configure and use the OpsSight solution. This document also describes its design and architecture.

The "OpsSight solution" refers to the combination of the Synopsys Operator, the OpsSight Connector, and the Black Duck server.

The OpsSight Connector works with Black Duck to scan applications in your cloud-native environment (Kubernetes and OpenShift) for open-source security vulnerabilities. The OpsSight Connector:

• discovers new objects in your cluster
• determines their content and sends signature information to one or more Black Duck instances
• receives security-scan information back from Black Duck
• annotates and labels cluster objects with security status
• provides metrics about security scanning rates

The OpsSight Developers' Guide provides information for developers who wish to contribute to the OpsSight Connector, which is 100% open source. This guide gives developers a comprehensive view of not only how to install OpsSight, but how to tune it, curate its results, and extend it to implement custom functionality or use logic custom to your data center.

Note: If you simply wish to use the latest released and supported version of OpsSight, please reference the official OpsSight documentation.

This wiki contains the latest technical information on the OpsSight Connector, and may describe versions that are not yet released.

Unless otherwise specified, this Developers' Guide describes version 2.2.3 of the OpsSight Connector, which is the latest stable and released version of OpsSight. See the Release Notes page for the latest information on OpsSight Connector releases.

Before you attempt to install, use or contribute to OpsSight, it is highly recommended that you familiarize yourself with the basics of the OpsSight solution and ecosystem. A full list of introductory topics is given in the "Getting Started" sidebar on the right. At the very least, check out the Before You Begin and Overview sections.

Once you are ready to install the product, go to the OpsSight Solution Installation Guide. From there, check out the Configuration, Usage, Troubleshooting, and Development topics of your choice - all shown in the sidebar. If you have questions, don't hesitate to Contact Us.