HackMD
  • Beta
    Beta  Get a sneak peek of HackMD’s new design
    Turn on the feature preview and give us feedback.
    Go → Got it
      • Create new note
      • Create a note from template
    • Beta  Get a sneak peek of HackMD’s new design
      Beta  Get a sneak peek of HackMD’s new design
      Turn on the feature preview and give us feedback.
      Go → Got it
      • Sharing Link copied
      • /edit
      • View mode
        • Edit mode
        • View mode
        • Book mode
        • Slide mode
        Edit mode View mode Book mode Slide mode
      • Note Permission
      • Read
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • Write
        • Only me
        • Signed-in users
        • Everyone
        Only me Signed-in users Everyone
      • More (Comment, Invitee)
      • Publishing
        Please check the box to agree to the Community Guidelines.
        Everyone on the web can find and read all notes of this public team.
        After the note is published, everyone on the web can find and read this note.
        See all published notes on profile page.
      • Commenting Enable
        Disabled Forbidden Owners Signed-in users Everyone
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Invitee
      • No invitee
      • Options
      • Versions and GitHub Sync
      • Transfer ownership
      • Delete this note
      • Template
      • Save as template
      • Insert from template
      • Export
      • Dropbox
      • Google Drive Export to Google Drive
      • Gist
      • Import
      • Dropbox
      • Google Drive Import from Google Drive
      • Gist
      • Clipboard
      • Download
      • Markdown
      • HTML
      • Raw HTML
    Menu Sharing Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Versions and GitHub Sync Transfer ownership Delete this note
    Export
    Dropbox Google Drive Export to Google Drive Gist
    Import
    Dropbox Google Drive Import from Google Drive Gist Clipboard
    Download
    Markdown HTML Raw HTML
    Back
    Sharing
    Sharing Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    More (Comment, Invitee)
    Publishing
    Please check the box to agree to the Community Guidelines.
    Everyone on the web can find and read all notes of this public team.
    After the note is published, everyone on the web can find and read this note.
    See all published notes on profile page.
    More (Comment, Invitee)
    Commenting Enable
    Disabled Forbidden Owners Signed-in users Everyone
    Permission
    Owners
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Invitee
    No invitee
       owned this note    owned this note      
    Published Linked with GitHub
    Like BookmarkBookmarked
    Subscribed
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    Subscribe
    # OCI Artifact Search Requirements **Note:** This doc is a continuation of [Registries To Become Cloud Native Artifact Stores](https://hackmd.io/Jk2XCLP2S2y8AfdXJdRLrw) As registries support multiple artifact types, a search/catalog API that supports filtering on the artifact type will be needed. The docker v1 registry spec supported Docker Search. While some vendors like Quay.io implemented the v1 search API, the majority of vendors require the v2 registry api which dropped search. We beleive revisiting the search api will support client CLIs that span registries, such as `helm search`, `duffle search` (CNAB), `docker search`, and other evolving artifact types. By supporting a common search API across all registries, users could consistently use these new artifact CLIs across all registries. ## Use Cases Search is a generic capability used across several different use cases. - [Artifact Tool Specific Searches](#Tool-Specific-Searches) - [Registry Specific Searchs](Regisry-Specific-Search) - [Registry Tools Searches](#Registry-Tool-Search---Scanners) ### Tool Specific Searches Helm, CNAB, Docker, Terraform and other tools will need to query their specific artifact types across various regisries. **Example:** The helm cli would need to query a registry for charts that match a specific name. The result should return helm only artifacts. ``` helm search demo42.azurecr.io hello-world Results -------------------------------------- samples/hello-world marketing/products/hello-world-sample dev/prototypes/sample-hello-world ``` Version specific searches: ``` helm search --versions demo42.azurecr.io samples/hello-world Results -------------------------------------- samples/hello-world 1.0 samples/hello-world 1.1 samples/hello-world 1.2 ``` ### Regisry Specific Search Users want to query registries for the artifacts that match a specific name or list artifacts wihtin a given path. In this case, the results contain multiple artifact types. Today, regisries have created unique client APIs and server APIs. Until we have a generic registry client, it's expected registries will have vendor specific APIs. However, having common registry server side APIs expands the possibility for common tooling across registries. A registry search API would include - repo listings - tag/version listings - limit by artifact type - query by date range, such as what's changed/added since a given timestamp - as results may be paged, sorting the results by name and/or version with ascending and decending options #### Existing examples **Azure Container Registry list repo example:** Without a common search/catalog API, cloud vendors have had to implement vendor specific experiences: ``` az acr repository list -n demo42 Name ----------------------------- samples/demo42/queueworker samples/demo42/quotes-api samples/demo42/web samples/demo42/deploy/chart samples/demo42/deploy/cnab samples/demo42/deploy/arm ``` **Azure Container Registry list tags example, w/ *future* type added:** ``` az acr repository show-tags -n demo42 --repository samples/demo42/deploy/chart Result Type ------------- 1.0 chart 1.1 chart 1.1.1 chart 2.0 chart 3.0 chart ``` A repo could contain multiple artifact types ``` az acr repository show-tags -n demo42 --repository samples/demo42/deploy Result Type ------------ ---------------- helm-1.0 chart helm-1.1 chart helm-1.1.1 chart cnab-1.0 cnab arm-1.0 arm cft-1.0 cloud-formation ``` Rather than each registry vendor having to offer unique APIs, the goal would be to offer a common API. ### Registry Tool Search - Scanners Vendors and the community have attempted to build tools atop registries. - [Image Layers](https://imagelayers.io/) - [Dive – A tool for exploring each layer in a Docker image | Hacker News](https://news.ycombinator.com/item?id=18528423) - [Analyze And Explore The Contents Of Docker Images](https://www.ostechnix.com/how-to-analyze-and-explore-the-contents-of-docker-images/) - [10+ top open-source tools for Docker security | TechBeacon](https://techbeacon.com/security/10-top-open-source-tools-docker-security) Without a common search/catalog API, these tools must work with individual images. One of the most common registriy tools include image scanning tools like [Aqua](https://aquasec.com), [Twistlock](https://twistlock.com), [Neuvector](https://neuvector.com/) and [Clair](https://github.com/coreos/clair). While the scanning tools protect runtime nodes, they all pre-scan registries to understand image vulnerabilities before they're run. Scanners evaluate images in registries with a combination of a search/catalog API and events. These vulnerability scanners need the following: - list all repos and tags for the inital scan evaluation - get paged results as they may contain thousands of images - periodically list all new and update images and tags, to keep a registry up to date - register for events to scan images as they arrive. Possibly using [The Container Quarantine Pattern](https://github.com/AzureCR/QuarantinePattern-Spec/) - filter, or at least understand the different artifact types - as new [CVEs](https://cve.mitre.org/) are found, re-scan the registry Today, scanners assume all artifacts in a registry are a container image. As a registry stores new artifact types, scanners will either need to know how to scan these new artifacts, or at least filter the results to artifacts they support. ## Artifact Types A registry must know the types it hosts for it to provide meaningful search results. Artifact types will be internally identified by an expanded set of [OCI Media Types](https://github.com/SteveLasker/RegistryArtifactTypes/blob/master/mediaTypes.md). However, displaying `application/vnd.cncf.helm.index.v3+json` does not make for a good user experience. To provide clean user experiences, a list of artifact types, a short description, and info on the artifact tooling will be maintained. [Media Type Short Names](https://github.com/SteveLasker/RegistryArtifactTypes/blob/master/mediaTypes.md#media-type-short-names ) | Media Type | Display Name | Info | |-|-|-| |`application/vnd.oci.image.index.v1+json` | OCI Image | [Docker](https://www.docker.com/products/docker-desktop) *| |`application/vnd.oci.image.manifest.v1+json` | OCI Image | [Docker](https://www.docker.com/products/docker-desktop) * | |`application/vnd.cncf.helm.index.v3+json` | Helm | [Helm](https://helm.sh) |`application/vnd.oci.cnab.index.v1+json` | CNAB | [Duffle](https://cnab.io), [Docker-application](https://www.docker.com/search/node?keys=docker-application)| \* most registry providers automatically convert `oci.image` manifests to the format requested by the client. ## Registry Search Requirements ### Listing repos ### Listing artifacts ### Listing versions ### Filtering by artifacts ### Filtering by date ranges Search queries may specify date ranges, enabling the return of artifacts that have been created or changed since a given date:time ### Paging Results may be paged, to provide a full list of artifacts. A default page size of 100, with the abiliyt to change the paging size. ### Sorting As results may be paged, being able to sort provides the ability to get the top n results, based on a given sort order. Sorting includes ascending and decending. ### Role Based Access Control Search results shall be limited to the artifacts the user has read access control. The user may be a person or service account. ## Possible Technologies & Solutions Stephen Day suggested: [graphql](https://graphql.org/)

    Import from clipboard

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lost their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template is not available.


    Upgrade

    All
    • All
    • Team
    No template found.

    Create custom template


    Upgrade

    Delete template

    Do you really want to delete this template?

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password

    or

    By clicking below, you agree to our terms of service.

    Sign in via Facebook Sign in via Twitter Sign in via GitHub Sign in via Dropbox

    New to HackMD? Sign up

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Tutorials

    Book Mode Tutorial

    Slide Mode Tutorial

    YAML Metadata

    Contacts

    Facebook

    Twitter

    Feedback

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions

    Versions and GitHub Sync

    Sign in to link this note to GitHub Learn more
    This note is not linked with GitHub Learn more
     
    Add badge Pull Push GitHub Link Settings
    Upgrade now

    Version named by    

    More Less
    • Edit
    • Delete

    Note content is identical to the latest version.
    Compare with
      Choose a version
      No search result
      Version not found

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub

        Please sign in to GitHub and install the HackMD app on your GitHub repo. Learn more

         Sign in to GitHub

        HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Available push count

        Upgrade

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Upgrade

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully