Skip to content

Backport of Improve ux to help users avoid overwriting fields of ACL tokens, roles and policies into release/1.15.x#16489

Merged
hc-github-team-consul-core merged 8 commits intorelease/1.15.xfrom
backport/NET-1723/update-docs/hardly-sure-earwig
Mar 2, 2023
Merged

Backport of Improve ux to help users avoid overwriting fields of ACL tokens, roles and policies into release/1.15.x#16489
hc-github-team-consul-core merged 8 commits intorelease/1.15.xfrom
backport/NET-1723/update-docs/hardly-sure-earwig

Conversation

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

Backport

This PR is auto-generated from #16288 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.


Description

  • Marking mergePolicies for deprecation and encouraging the use of -append-policy-id and -append-policy-name to reduce the ambiguity when overwriting fields on update
  • Updating docs to clarify that using: -policy-id and -policy-name will overwrite existing policies
  • Marking mergeRoles for deprecation and encouraging the use of -append-role-id and -append-role-name to reduce the ambiguity when overwriting fields on update
  • Updating docs to clarify that using: -append-role-id and -append-role-name will overwrite existing policies

TODO

  • add tests cases
  • update description
  • Do exact thing for -merge-roles as we did for -merge-policies
  • add change-log
  • de-duplicate all the logics

Testing & Reproduction steps

  • In the case of bugs, describe how to replicate
  • If any manual tests were done, document the steps and the conditions to replicate
  • Call out any important/ relevant unit tests, e2e tests or integration tests you have added or are adding

Links

PR Checklist

  • updated test coverage
  • external facing docs updated
  • 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 March 1, 2023 20:01
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/NET-1723/update-docs/hardly-sure-earwig branch from 0e1c08e to e892647 Compare March 1, 2023 20:01
@hc-github-team-consul-core hc-github-team-consul-core enabled auto-merge (squash) March 1, 2023 20:01
@hc-github-team-consul-core hc-github-team-consul-core force-pushed the backport/NET-1723/update-docs/hardly-sure-earwig branch from 5d8a711 to 74d0ff8 Compare March 1, 2023 20:01
Copy link
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

@github-actions github-actions bot added theme/cli Flags and documentation for the CLI interface type/docs Documentation needs to be created/updated/clarified labels Mar 1, 2023
@hc-github-team-consul-core hc-github-team-consul-core merged commit 8e0fd0e into release/1.15.x Mar 2, 2023
@hc-github-team-consul-core hc-github-team-consul-core deleted the backport/NET-1723/update-docs/hardly-sure-earwig branch March 2, 2023 18:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

theme/cli Flags and documentation for the CLI interface type/docs Documentation needs to be created/updated/clarified

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants