Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 2.71 KB

framework-use-cases.md

File metadata and controls

65 lines (46 loc) · 2.71 KB
Raw

Use cases

This document provides some use cases for Framework to understand the project's context.

Use Case #1 - CLI Plugins

Context

Allow the teams and external partners to extend the Tanzu CLI so that they can build, own and release their own piece of functionality.

Solution

The Tanzu CLI is based on a modular plugin architecture that consists of plugins. This architecture enables teams to build, own, and release their own piece of functionality as well as enable external partners to integrate with the system. The Tanzu CLI also provides tools to make creating and compiling new plugins straightforward.

Check out this document to learn more about the Tanzu CLI architecture and this document to learn on how to bootstrap a new CLI plugin.

Use Case #2 - Features and FeatureGates

Context

Allow developers to deliver new functionality to users rapidly but safely. If there is no way to do that, it would be difficult for individual teams to develop features in parallel without coordinating with the larger team or resorting to an expensive branching model. This reduces the velocity, inhibits experimentation, and also makes the development difficult.

Solution

Framework provides powerful Features and FeatureGates APIs that allows the teams to have a system to control rollout and availability of new Features in controller and plugin logic. With these APIs, it would be easy to modify the behavior of the plugin or controller without changing the code for more controlled experimentation, these can be incredibly useful for agile management style environments.

Check out this document to learn more about the Features and FeatureGates APIs and how to use them.

Use Case #3 - Capabilities

Context

Determining how to interact with clusters running versioned pieces of software on various infrastructure providers is complex. The lack of a standard means to discover details about cluster resource composition and API surface area could result in manual poking and prodding by teams and this approach could eventually manifest as undesirable patterns.

Solution

Framework provides Capability discovery GO package and Capability API to query a cluster's capabilities. It can be used to understand the API surface area and query for objects in the cluster.

For more detailed information on Capability functionality offered by Framework check out this document.