Subodh
dafcd9777f
Some checks failed
Continuous Integration - Pull Request / code-tests (pull_request) Has been cancelled
Continuous Integration - Pull Request / deployment-tests (local-code) (pull_request) Has been cancelled
helm-chart-ci / helm-chart-ci (pull_request) Has been cancelled
kubevious-manifests-ci / kubevious-manifests-ci (pull_request) Has been cancelled
kustomize-build-ci / kustomize-build-ci (pull_request) Has been cancelled
terraform-validate-ci / terraform-validate-ci (pull_request) Has been cancelled
Clean up deployment / cleanup-namespace (pull_request) Has been cancelled
Continuous Integration - Main/Release / code-tests (push) Has been cancelled
Continuous Integration - Main/Release / deployment-tests (local-code) (push) Has been cancelled
helm-chart-ci / helm-chart-ci (push) Has been cancelled
kubevious-manifests-ci / kubevious-manifests-ci (push) Has been cancelled
kustomize-build-ci / kustomize-build-ci (push) Has been cancelled
terraform-validate-ci / terraform-validate-ci (push) Has been cancelled
40 lines
2.5 KiB
Markdown
40 lines
2.5 KiB
Markdown
## 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.
|
|
1. Preserve the simplicity of demos.
|
|
1. 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](https://github.com/GoogleCloudPlatform/microservices-demo/tree/main/kustomize) if they align with the [purpose of Online Boutique](/docs/purpose.md).
|
|
|
|
### 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](https://kind.sigs.k8s.io/).
|
|
|
|
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](https://about.google/) 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](https://github.com/GoogleCloudPlatform/microservices-demo#quickstart-gke).
|
|
|
|
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](https://github.com/GoogleCloudPlatform/microservices-demo/tree/main/kustomize/components) which users can optionally opt into.
|