Skip to content

Latest commit

 

History

History
39 lines (25 loc) · 2.49 KB

product-requirements.md

File metadata and controls

39 lines (25 loc) · 2.49 KB
Raw

Product Requirements

This document contains a list of requirements that every change made to this repository should meet. Every change must:

  1. Preserve the golden user journey taken by Kubernetes beginners.
  2. Preserve the simplicity of demos.
  3. Preserve the simplicity of the GKE quickstart.

These requirements are about the default deployment (default configuration) of Online Boutique. Changes that will violate any of these rules should not be built into the default configuration of Online Boutique. Such changes should be opt-in only — ideally, as a Kustomize Component if they align with the purpose of Online Boutique.

1. Preserve the golden user journey taken by Kubernetes beginners

The following statement about Online Boutique should always be true:

A user outside of Google can deploy Online Boutique's default configuration on a kind Kubernetes cluster.

This statement describes the golden user journey that we expect new Kubernetes users to take while onboarding to Online Boutique.

Being able to run Online Boutique on a kind cluster ensures that Online Boutique is free and cloud-agnostic. This is aligned with Google's mission of making information universally accessible and useful. To be specific, Online Boutique should be useful and accessible to developers that are new to Kubernetes.

2. Preserve the simplicity of demos

New changes should not complicate the primary user journey showcased in live demos and tutorials.

Today, the primary user journey is as follows:

  1. Visit Online Boutique on a web browser.
  2. Select an item from the homepage and add the item to the cart.
  3. The checkout form is pre-populated with placeholder data (e.g. the shipping address).
  4. The user checks out and completes the order.

3. Preserve the simplicity of the GKE quickstart

New changes should not add additional complexity in the main Online Boutique quickstart.

In particular, new changes should not add extra required steps or additional required tools in that quickstart.

Ideally, extensions to Online Boutique's default functionality (such as a new microservice or a new cloud service integration) should be added as a Kustomize Component which users can optionally opt into.