Product Documentation

Appearance

EE: All cloud platforms

Cloud: Installation ​

Yellowbrick is installed into your own cloud account using a tool called the Yellowbrick Deployer. The Deployer is a machine image available across supported public cloud platforms and regions. It contains all Yellowbrick software along with a deployment tool. The deployment tool can be driven via a graphical user interface for simple installations, or via a command line for more complex installations. It's responsible for installs, upgrades and uninstalls.

If you're doing a Yellowbrick PoC or just getting started, we strongly recommend doing a public installation using the Deployer web application since it's by far the easiest way to get started and requires minimal cloud infrastructure administration.

Public Installation using the Web Application ​

Public installations deploy Yellowbrick into a network with public (internet-facing) access. The Deployer creates necessary cloud infrastructure (such as VPCs, networks, routers, gateways and a Kubernetes cluster) on your behalf. Most of the infrastructure is private but the instance is accessed over the internet, like most SaaS applications.

To secure the deployment, you can add IP access restrictions and configure multi-factor authentication using single sign-on (SSO). The Deployer web application can export an infrastructure manifest if you're curious to see exactly what will be configured.

We highly recommend setting up SSO with Multi-Factor Authentication (MFA) before loading confidential data or doing business-critical work.

Private Installation using the Web Application ​

Yellowbrick uniquely supports installation into a completely private network that's inaccessible from the internet. To set up and configure such a deployment, you'll need to have skills in cloud infrastructure administration and networking in order to provision a number of prerequisites prior to running the Deployer. This is a more involved and intricate process than a public installation.

Private installations are documented here.

CLI Deployments ​

For scripting deployments as part of CI/CD pipelines or automating deployments in a headless fashion, the deployment tool can be driven from the CLI to perform both public and private installations. CLI deployment also allows further customization of the installation by allowing things like timeouts to be overridden.

CLI deployments are primarily driven by a JSON configuration file which can be exported by the web application as a starting point.

CLI installations are documented here