Document how to upgrade a bundle using digest#2352
Merged
VinozzZ merged 3 commits intogetporter:release/v1from Sep 15, 2022
Merged
Document how to upgrade a bundle using digest#2352VinozzZ merged 3 commits intogetporter:release/v1from
VinozzZ merged 3 commits intogetporter:release/v1from
Conversation
carolynvs
requested changes
Sep 12, 2022
docs/content/quickstart/_index.md
Outdated
| ### Upgrade using digest | ||
|
|
||
| When working in production environment, we highly recommend you to reference the bundle using its digest instead of tag. We used tags in our docs for simplicity, but tags can be overwritten which results in unexpected outcomes from upgrading an bundle. | ||
| To get deterministic and repeatable deployments, use digests instead of tags. it allows to ensure that you deploy the exact expected bundle. |
Member
There was a problem hiding this comment.
Suggested change
| To get deterministic and repeatable deployments, use digests instead of tags. it allows to ensure that you deploy the exact expected bundle. | |
| For deterministic and repeatable deployments, use digests instead of tags to ensure that you deploy the exactly what you intended. |
| ## Upgrade the Installation | ||
|
|
||
| To upgrade the resources managed by the bundle, use `porter upgrade`. | ||
| ### Upgrade using a version tag |
Member
There was a problem hiding this comment.
I just realized that we aren't taking advantage of Porter's --version flag for upgrade.
A more simple way to upgrade using a tag is porter upgrade myinst --version 1.2.3 and then you don't need to re-specify the full bundle reference
Do you want to update the example here? Or I can open a follow-up PR after yours is merged.
Contributor
Author
There was a problem hiding this comment.
Oh nice, I can update the example here
docs/content/quickstart/_index.md
Outdated
Comment on lines
147
to
152
| If you ran into below error message: | ||
| ```console | ||
| $ unable to pull bundle: invalid media type "application/vnd.docker.distribution.manifest.v2+json" for bundle manifest | ||
| ``` | ||
| Make sure that you are referencing the digest for bundles and not the digest for invocation images. | ||
|
|
Member
There was a problem hiding this comment.
Let's explicitly call this out as a troubleshooting section, so that we can include other potential errors or mistakes in the future.
Suggested change
| If you ran into below error message: | |
| ```console | |
| $ unable to pull bundle: invalid media type "application/vnd.docker.distribution.manifest.v2+json" for bundle manifest | |
| ``` | |
| Make sure that you are referencing the digest for bundles and not the digest for invocation images. | |
| ## Troubleshooting | |
| If you receive an `invalid media type` error like below, check that you are referencing the digest for the bundle and not the installer image. | |
| ```plain | |
| unable to pull bundle: invalid media type "application/vnd.docker.distribution.manifest.v2+json" for bundle manifest |
Signed-off-by: Yingrong Zhao <yingrong.zhao@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What does this change
Add documentation for how to upgrade a bundle using digest.
I also added a section in the release guide to document how to handle failed release tags
What issue does it fix
Closes #1626
Notes for the reviewer
Put any questions or notes for the reviewer here.
Checklist
Reviewer Checklist