Skip to content

Backport of docs: Update K8s TGW tutorial to reliably obtain role ID into release/1.15.x#18507

Merged
hc-github-team-consul-core merged 1 commit into
release/1.15.xfrom
backport/docs/k8s-tgw-tutorial-role-id-fix/promptly-active-flea
Aug 17, 2023
Merged

Backport of docs: Update K8s TGW tutorial to reliably obtain role ID into release/1.15.x#18507
hc-github-team-consul-core merged 1 commit into
release/1.15.xfrom
backport/docs/k8s-tgw-tutorial-role-id-fix/promptly-active-flea

Conversation

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator

Backport

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

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


The grep command used to obtain the ID for the terminating gateway role is not reliable in all scenarios. For example, if there is a similarly named role, the command may return the wrong role ID for the active terminating gateway instance.

This commit updates the command to use jq to obtain the role ID. If multiple roles are found, jq will raise an error informing the user that it cannot reliably determine the role ID.

Description

Testing & Reproduction steps

Links

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

Overview of commits

@hc-github-team-consul-core hc-github-team-consul-core requested a review from a team as a code owner August 17, 2023 15:42
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/k8s-tgw-tutorial-role-id-fix/promptly-active-flea branch from 8b5e103 to 8a80c79 Compare August 17, 2023 15:42
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/docs/k8s-tgw-tutorial-role-id-fix/promptly-active-flea branch from 5a65ed1 to 805c308 Compare August 17, 2023 15:42
@github-actions github-actions Bot added the type/docs Documentation needs to be created/updated/clarified label Aug 17, 2023
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@hc-github-team-consul-core
Copy link
Copy Markdown
Collaborator Author

🤔 This PR has changes in the website/ directory but does not have a type/docs-cherrypick label. If the changes are for the next version, this can be ignored. If they are updates to current docs, attach the label to auto cherrypick to the stable-website branch after merging.

@vercel vercel Bot temporarily deployed to Preview – consul August 17, 2023 15:53 Inactive
@hc-github-team-consul-core hc-github-team-consul-core merged commit 31c928c into release/1.15.x Aug 17, 2023
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/docs/k8s-tgw-tutorial-role-id-fix/promptly-active-flea branch August 17, 2023 16:33
@atlassian atlassian Bot mentioned this pull request Aug 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants