Product DocumentationAppearance
Cloud: Kubernetes Guides
Yellowbrick Enterprise Edition is built on standard Kubernetes constructs, such as stateful sets, deployments, services and load balancers. As such, standard Kubernetes tooling works to inspect, manage and monitor the resources and infrastructure that a Yellowbrick instance runs on.
Yellowbrick Enterprise Edition includes a custom Operator which controls the lifecycle of Yellowbrick instances. This Operator utilizes Custom Resource Definitions (CRDs) to manage instances and their companion resources. See Yellowbrick Operator for more information.
Kubernetes Configuration (KUBECONFIG)
How you configure Kubernetes for command line and other API clients depends on which cloud your Yellowbrick instance is deployed on:
Kubernetes Recommendations for Yellowbrick
Generally, it is NOT recommended to scale resources manually utilizing kubectl and related tooling. So while it is possible to use kubectl scale to spin down an instance pod, this will not gracefully shutdown companion services and such. Furthermore, direct modifications to service definitions, such as adding annotations and what/not for cloud-provider specific features, is not supported.
It is recommended to use Yellowbrick Manager for suspending, resuming, changing, upgrading, and tuning Yellowbrick instances. If you desire to script such functionality, please see the Kubectl Administration for how to use kubectl and related tooling to accomplish these tasks.