Skip to content

Backport of docs: add known issues section to 1.9.x upgrade guide into release/1.9.x#13713

Merged
calvn merged 4 commits intorelease/1.9.xfrom
backport/docs/update-1.9.x-known-issues/partially-advanced-squirrel
Jan 20, 2022
Merged

Backport of docs: add known issues section to 1.9.x upgrade guide into release/1.9.x#13713
calvn merged 4 commits intorelease/1.9.xfrom
backport/docs/update-1.9.x-known-issues/partially-advanced-squirrel

Conversation

@hc-github-team-secure-vault-core
Copy link
Copy Markdown
Collaborator

Backport

This PR is auto-generated from #13662 to be assessed for backporting due to the inclusion of the label backport/website.

WARNING automatic cherry-pick of commits failed. Commits will require human attention.

The below text is copied from the body of the original PR.


Adds a "Known Issues" section to our 1.9.x upgrade guide, and includes a note about a panic that can be encountered on Vault installations that are using the ID token backend and have named keys created.

@hashicorp-cla
Copy link
Copy Markdown

hashicorp-cla commented Jan 19, 2022

CLA assistant check

Thank you for your submission! We require that all contributors sign our Contributor License Agreement ("CLA") before we can accept the contribution. Read and sign the agreement

Learn more about why HashiCorp requires a CLA and what the CLA includes


3 out of 4 committers have signed the CLA.

  • tonyp-hc
  • pmmukh
  • calvn
  • temp

temp seems not to be a GitHub user.
You need a GitHub account to be able to sign the CLA. If you already have a GitHub account, please add the email address used for this commit to your account.

Have you signed the CLA already but the status is still pending? Recheck it.

@calvn
Copy link
Copy Markdown
Contributor

calvn commented Jan 19, 2022

@mladlow the upgrade guide file got renamed, leading to failures on any backports that involve this file.

Should also close #13695

@mladlow
Copy link
Copy Markdown
Contributor

mladlow commented Jan 19, 2022

@calvn I think you'll need to update the docs-nav-data.json file too? But I'm worried about the rest of the upgrade guides on this branch now, which I think are all the .0 versions.

@calvn
Copy link
Copy Markdown
Contributor

calvn commented Jan 19, 2022

Actually this is not quite right -- I would also need to update the references on the navbar and remove the 1.9.0 upgrade guide page. @mladlow do you have any advice on how to properly backport that entire file, include the changes from #13370?

@mladlow
Copy link
Copy Markdown
Contributor

mladlow commented Jan 19, 2022

Manually? I think? We might not be able to cherry pick them but my git-skills are also definitely not top-notch. I would do it manually because that would be the fastest one-time solution for me, but it might be worth trying to find out if there is a better way.

@calvn calvn force-pushed the backport/docs/update-1.9.x-known-issues/partially-advanced-squirrel branch from f980538 to 0663dce Compare January 19, 2022 21:48
@vercel vercel bot temporarily deployed to Preview – vault-storybook January 19, 2022 21:48 Inactive
@calvn
Copy link
Copy Markdown
Contributor

calvn commented Jan 19, 2022

I ended up doing an ordered cherry-pick based off https://github.com/hashicorp/vault/commits/main/website/content/docs/upgrading/upgrade-to-1.9.x.mdx to bring the files in, which also takes care of removing upgrade-to-1.9.0.mdx from the branch. This should also close #13695 and properly backports changes from #13370.

It's all piggybacked into this one PR which is not great but makes it way simpler (vs 3 different backports)

Copy link
Copy Markdown
Contributor

@mladlow mladlow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure whether you want the newer content in identity.mdx and the 1.9 upgrade guide from main?

Comment thread website/content/docs/concepts/identity.mdx Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file also has different content in main.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching that, I might have messed up during merge conflict... I'll fix this up.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated, should be good now!

pmmukh and others added 3 commits January 19, 2022 14:41
* Add entity-alias behavior change to docs

* Add upgrade note about entity-alias mapping change

* Rename 1.7-9 upgrade pages, shuffle upgrade note position

* Update website/content/partials/entity-alias-mapping.mdx

Co-authored-by: Meggie <meggie@hashicorp.com>

* Add incorrect policy issue to the docs

* Add example about entity-alias restriction

Co-authored-by: Meggie <meggie@hashicorp.com>
* docs: add known issues section to 1.9.x upgrade guide

* minor rephrasing on oidc known issue

* use relative references for URLs

* Update website/content/docs/upgrading/upgrade-to-1.9.x.mdx

Co-authored-by: Tom Proctor <tomhjp@users.noreply.github.com>

* update known issues section for id token

Co-authored-by: Tom Proctor <tomhjp@users.noreply.github.com>
@calvn calvn force-pushed the backport/docs/update-1.9.x-known-issues/partially-advanced-squirrel branch from 0663dce to 8976ca8 Compare January 19, 2022 22:42
@vercel vercel bot temporarily deployed to Preview – vault-storybook January 19, 2022 22:42 Inactive
Copy link
Copy Markdown
Contributor

@mladlow mladlow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the extra digging!

So one problem is that I'm still not sure how to get the CLA to realize that this account has signed it...

@calvn
Copy link
Copy Markdown
Contributor

calvn commented Jan 19, 2022

I'm pretty sure it's due to how backport-assistant makes that no-op commit. Linked you the source offline.

"path": "upgrading/upgrade-to-1.9.0",
"title": "Upgrade to 1.9.x",
"path": "upgrading/upgrade-to-1.9.x",
"hidden": true
Copy link
Copy Markdown
Contributor

@calvn calvn Jan 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mladlow I wonder if we should remove the hidden attribute. Otherwise, the docs might not show when 1.9.x is versioned.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I might leave it out of this PR since I want to keep the result from the diff the same from the resulting 3 cherry-picks that I did.

@calvn calvn merged commit 27107d6 into release/1.9.x Jan 20, 2022
pull bot pushed a commit to NOUIY/vault that referenced this pull request Apr 7, 2026
hashicorp#13713)

Signed-off-by: Ryan Cragun <me@ryan.ec>
Co-authored-by: Ryan Cragun <me@ryan.ec>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants