docs: re-orders deploy steps and clarifies instructions #6109
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Previously, if you ran the suggested command `kustomize build config/default | kubectl apply -f -`, that would render an incorrect manifest. That is because when the user changed the value of `IMAGE_TAG_BASE` and `IMG` in the Makefile during a previous step, that change has not yet been applied to kustomize manifests at the time of running the suggested command. So the wrong image reference ends up being rendered, and the manifests get applies to the cluster. `make deploy` must be run first, which updates the kustomize manifest. This change clarifies that running `kustomize build config/default` is part of explaining to the reader how things work, is not a required step that should apply anything to the cluster, AND importantly should not be run until after `make deploy`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change:
Previously, if you ran the suggested command
kustomize build config/default | kubectl apply -f -, that would render an incorrect manifest. That is because when the user changed the value ofIMAGE_TAG_BASEandIMGin the Makefile during a previous step, that change has not yet been applied to kustomize manifests at the time of running the suggested command. So the wrong image reference ends up being rendered, and the manifests get applies to the cluster.make deploymust be run first, which updates the kustomize manifest.This change clarifies that running
kustomize build config/defaultis part of explaining to the reader how things work, is not a required step that should apply anything to the cluster, AND importantly should not be run until aftermake deploy.Motivation for the change:
Without it, the tutorial leads the user to a broken state.
Checklist
If the pull request includes user-facing changes, extra documentation is required:
changelog/fragments(seechangelog/fragments/00-template.yaml)website/content/en/docs