Use versioned links for installation instructions #180
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
gthao313
reviewed
Apr 4, 2022
| @@ -10,14 +10,17 @@ Updates to Bottlerocket are rolled out in [waves](https://github.com/bottlerocke | |||
|
|
|||
| ### Installation | |||
|
|
|||
| We can install the Bottlerocket update operator using the recommended configuration defined in [bottlerocket-update-operator.yaml](./bottlerocket-update-operator.yaml): | |||
| We can install the Bottlerocket update operator using the recommended configuration defined in [bottlerocket-update-operator.yaml](https://github.com/bottlerocket-os/bottlerocket-update-operator/blob/v0.2.0/yamlgen/deploy/bottlerocket-update-operator.yaml): | |||
|
|
|||
| ```sh | |||
| kubectl apply -f ./bottlerocket-update-operator.yaml | |||
There was a problem hiding this comment.
Just curious and question if customers ignore the recommended configuration link above, and directly run this command with latest changes of brupop. Will they still use latest version of CRD and meet same issue because ./bottlerocket-update-operator.yaml still symlink to yamlgen/deploy/bottlerocket-update-operator.yaml?
There was a problem hiding this comment.
Unfortunately so. I think this continues to be a way to make a mistake until we merge #161, which should make the CRDs immutable. Then it won't matter so long as your CRD deployment is newer than the latest release.
somnusfish
approved these changes
Apr 4, 2022
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.
Issue number: #179
Description of changes: Doc change. This uses a versioned link to Brupop's YAML documents for installation instructions, which should prevent issues of pulling mismatched CRD definitions from the latest released version of Brupop.
Terms of contribution:
By submitting this pull request, I agree that this contribution is dual-licensed under the terms of both the Apache License, version 2.0, and the MIT license.