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

Docs: Add repository tutorial based on metadata API #1685

Merged
merged 2 commits into from
Nov 29, 2021

Commits on Nov 29, 2021

  1. doc: add repository example based on metadata API

    As 'repository_tool' and 'repository_lib' are being deprecated,
    repository metadata must to be created and maintained manually
    using the low-level Metadata API. The added example code shall
    serve as temporary replacement until a new repository tool is
    available.
    
    The sample code contains the following repo workflows:
     - creation of top-level metadata
     - target file handling
     - consistent snapshots
     - key management
     - top-level delegation and signing thresholds
     - target delegation
     - in-band and out-of-band metadata signing
     - writing and reading metadata files
     - root key rotation
    
    Co-authored-by: Teodora Sechkova <[email protected]>
    Co-authored-by: Joshua Lock <[email protected]>
    Co-authored-by: Jussi Kukkonen <[email protected]>
    
    Signed-off-by: Lukas Puehringer <[email protected]>
    lukpueh committed Nov 29, 2021
    Configuration menu
    Copy the full SHA
    190c21b View commit details
    Browse the repository at this point in the history
  2. test: add test module for basic repo example

    Adds new test module that executes the basic repo example
    Python script and checks that it created certain (metadata)
    files.
    
    The test module is tailored for testing similar example scripts.
    
    Co-authored-by: Joshua Lock <[email protected]>
    Co-authored-by: Jussi Kukkonen <[email protected]>
    
    Signed-off-by: Lukas Puehringer <[email protected]>
    lukpueh committed Nov 29, 2021
    Configuration menu
    Copy the full SHA
    a1531d8 View commit details
    Browse the repository at this point in the history