Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CLI Cmds for trust policy management - phase 1 #548

Closed
yizha1 opened this issue Feb 10, 2023 · 2 comments · Fixed by #568 or #593
Closed

CLI Cmds for trust policy management - phase 1 #548

yizha1 opened this issue Feb 10, 2023 · 2 comments · Fixed by #568 or #593
Assignees
Labels
enhancement New feature or request triage Need to triage
Milestone

Comments

@yizha1
Copy link
Contributor

yizha1 commented Feb 10, 2023

What is the areas you would like to add the new feature to?

Notation CLI

Is your feature request related to a problem?

Today the UX of trust policy management is cumbersome and error prone.

  • Users need to manually create and edit a JSON file, and there are several parameters user need to properly configure. See trust policy spec.
  • The name for the JSON file MUST be trustpolicy.json, and this file needs to be stored in Notation configuration directory, which is different for different OS, see directory structure. It's hard to remember the directory path for different OS.
  • The JSON file encoding MUST be utf-8 without BOM. However, for some environments it is not by default. It is error prone.

What solution do you propose?

To improve the UX of managing trust policy and meet Notation v1.0 release goal, a phased approach is proposed. This issue will address the solution for the first phase. The scope for first phase:

  • Import trust policy: User can import a trust policy configuration file with arbitrary name into notation, so that users don't need to consider where this file should go to, and what is the name of trust policy file.
  • Export trust policy: User can export the trust policy configuration file to local disk, so that user can update it and import it afterwards.
  • View trust policy: User can easily view the content of trust policy file.
  • template file: Provide a template file of trust policy configuration for users to get started. The template file could be packaged with notation binary together.

What alternatives have you considered?

No

Any additional context?

No response

@yizha1 yizha1 added enhancement New feature or request triage Need to triage labels Feb 10, 2023
@yizha1 yizha1 added this to the RC-3 milestone Feb 10, 2023
@yizha1
Copy link
Contributor Author

yizha1 commented Feb 10, 2023

As discussed in the slack, update the milestone to RC-3.

@yizha1 yizha1 linked a pull request Feb 25, 2023 that will close this issue
@vaninrao10 vaninrao10 modified the milestones: RC-3, RC-4 Mar 1, 2023
@yizha1 yizha1 self-assigned this Mar 13, 2023
@yizha1 yizha1 moved this from Todo to In Progress in Notary Project Planning Board Mar 13, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in Notary Project Planning Board Mar 17, 2023
@yizha1
Copy link
Contributor Author

yizha1 commented Mar 22, 2023

Reopen this issue since implementation is not completed yet. The previous closure is due to spec was merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request triage Need to triage
Projects
Status: Done
2 participants