Home

Synopsys Operator Introduction

Synopsys Operator is a cloud-native administration utility for Synopsys software. Synopsys Operator assists in the deployment and management of Synopsys software in cloud-native environments (i.e., Kubernetes and OpenShift).

Once the Operator is installed, you can leverage it to easily deploy and manage Synopsys software like Black Duck, OpsSight Connector, and Black Duck Alert.

Synopsys Operator leverages Custom Resource Definitions (CRDs) to allow Black Duck-specific structured data to be stored and manipulated using Kubernetes and OpenShift primitives. Synopsys Operator is implemented as a custom controller.

Overview

Synopsys Operator was developed in conjunction with OpsSight Connector v2.2.0 and released in December 2018.

Synopsys Operator is a Kubernetes Operator, which is an application-specific controller that extends the Kubernetes API to create, configure, and manage instances of complex stateful applications on behalf of a Kubernetes user.

Synopsys Operator leverages CRDs, or Custom Resource Definitions. A CRD is an extension of the Kubernetes API, and defines a set of custom objects that allows you to access and manipulate structured data via the Kubernetes API. Synopsys Operator listens for events triggered by changes to these custom objects, and then modifies the cluster accordingly.

Operators are designed to bring a cluster into a desired state; Synopsys Operator is designed to ensure that a deployment of Synopsys software in a cluster is healthy and operational. Synopsys Operator can be used to deploy Black Duck servers, OpsSight Connector, and other components - like Black Duck Alert. It schedules the above components, and organizes their volume mounts and their security context constraints.

Because Synopsys Operator uses CRDs, it makes Synopsys objects "first-class citizens" in your cluster. After installing Synopsys Operator, you can access Synopsys objects in your cluster with the same commands you would to access other cluster primitives, for example:

kubectl get hubs
kubectl get opssights
kubectl get alerts

(Replace 'kubectl' with 'oc' if using OpenShift.)

Synopsys Operator runs as a single container in your cluster. See the Usage Guide for details about the features of Synopsys Operator.

Versions

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

Unless otherwise specified, this wiki describes version 2018.12.0 of Synopsys Operator, which is the latest stable and released version. See the Release Notes page for the latest information on Synopsys Operator releases.

Where to Go Next

Check out the topics in the sidebar on the right for more information. Specifically, to install Synopsys Operator, go to the Synopsys Operator Installation Guide.