Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up and deduplicate manifests throughout the repo #2510

Open
6 tasks
bourgeoisor opened this issue Apr 25, 2024 · 0 comments
Open
6 tasks

Clean up and deduplicate manifests throughout the repo #2510

bourgeoisor opened this issue Apr 25, 2024 · 0 comments
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@bourgeoisor
Copy link
Member

Currently, base Kubernetes manifests for Online Boutique live in 4 distinct places:

  • kubernetes-manifests/
  • kustomize/base/
  • release/kubernetes-manifests.yaml
  • helm-chart/templates/

And Istio manifests live in 3 distinct places:

  • kustomize/components/service-mesh-istio
  • istio-manifests/
  • release/istio-manifests.yaml

This makes releasing, but also figuring out which manifests are source of truths and which are generated copies, needlessly difficult.

At a minimum, we should (more-or-less in this order):

  • Discontinue the use of istio-manifests/ in docs / tutorials (in favour of the Kustomize component), and remove this directory.
  • Discontinue the use of release/istio-manifests.yaml in docs / tutorials (in favour of the Kustomize component), and remove this file.
  • Improve consistency between releases of the Kubernetes manifests and helm-chart/templates/ (through README notes and new PR requirements).
  • Discontinue the use of kubernetes-manifests/ in docs / tutorials (in favour of kustomize/base/ which should be latest upstream and not latest release), and remove this directory.

Additionally, or later, we could also consider:

  • Modifying docs / tutorials to use a specific release tag (e.g. v0) instead of cloning latest, and using the kustomize/ directory at that slice in time.
  • Discontinue the use of release/kubernetes-manifests.yaml (in favour of the slice in time of kustomize/), and remove this directory.
@bourgeoisor bourgeoisor added type: cleanup An internal cleanup or hygiene concern. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Apr 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant