Skip to content

Commit

Permalink
docs: add digest search to What's New (#137)
Browse files Browse the repository at this point in the history
* docs: add digest search to What's New

Signed-off-by: mbshields <[email protected]>

* docs: add digest search to What's New - spellcheck

Signed-off-by: mbshields <[email protected]>

* docs: add digest search to What's New - OCI spec changes

Signed-off-by: mbshields <[email protected]>

* docs: add digest search to What's New - sha256

Signed-off-by: mbshields <[email protected]>

---------

Signed-off-by: mbshields <[email protected]>
  • Loading branch information
mbshields authored Nov 29, 2023
1 parent 7c51a84 commit da10085
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
1 change: 1 addition & 0 deletions .wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ discoverable
DistContentDigestKey
DN
Dockerfile
dropdown
dryRun
ExpandedRepoInfo
ExtensionList
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-guide/api-user-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ For comprehensive details of the API endpoints, see [Viewing the complete zot AP

| Endpoint | Actions | Description | Availability |
| -------- | ------- | ----------- | -------------|
| /v2/_zot/pprof/ | GET | Returns a current HTML-format profile list along with a count of currently available records for each profile. See [Performance Profiling in zot](../articles/pprof.md) for usage details. | Always enabled. |
| /v2/_zot/pprof/ | GET | Returns a current HTML-format profile list along with a count of currently available records for each profile. See [Performance Profiling in zot](../articles/pprofiling.md) for usage details. | Always enabled. |
| /v2/_zot/debug/graphql-playground# | | See [Using GraphQL](../articles/graphql.md) for details. | Enabled only in a `binary-debug` zot build or when the zot registry has been built with the `debug` extension label. |


Expand Down
12 changes: 7 additions & 5 deletions docs/general/whats-new.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,12 @@

### Updated OCI support

- Support is added for [OCI Distribution Spec v1.1.0-rc3](https://github.com/opencontainers/distribution-spec/releases/tag/v1.1.0-rc3) and [OCI Image Spec v1.1.0-rc4](https://github.com/opencontainers/image-spec/releases/tag/v1.1.0-rc4). The OCI changes are summarized [here](https://opencontainers.org/posts/blog/2023-07-07-summary-of-upcoming-changes-in-oci-image-and-distribution-specs-v-1-1/).

:warning: Support is deprecated for earlier OCI release candidates.

- Support is added for [OCI Artifacts and References](https://github.com/opencontainers/image-spec/blob/main/manifest.md#guidelines-for-artifact-usage). The OCI Image Spec v1.1.0 supports arbitrary artifact types and references so that software supply chain use cases can be supported (SBOMs, signatures, etc). Currently, [`oras`](https://github.com/oras-project/oras) and [`regclient`](https://github.com/regclient/regclient) support this spec.
- Support is added for [OCI Distribution Spec v1.1.0-rc3](https://github.com/opencontainers/distribution-spec/releases/tag/v1.1.0-rc3) and [OCI Image Spec v1.1.0-rc4](https://github.com/opencontainers/image-spec/releases/tag/v1.1.0-rc4). The OCI changes are summarized [here](https://opencontainers.org/posts/blog/2023-07-07-summary-of-upcoming-changes-in-oci-image-and-distribution-specs-v-1-1/). These specifications allow arbitrary artifact types and references so that software supply chain use cases can be supported (SBOMs, signatures, etc). Currently, [`oras`](https://github.com/oras-project/oras) and [`regclient`](https://github.com/regclient/regclient) support this spec.

- For a demonstration of an end-to-end OCI artifacts workflow, see [Software Provenance Workflow Using OCI Artifacts](../articles/workflow.md).

:warning: Support is deprecated for earlier OCI release candidates.

### Built-in UI support

- Using the new zot [GUI](../user-guides/user-guide-gui.md), you can browse a zot registry for container images and artifacts. The web interface provides the shell commands for downloading an image using popular third-party tools such as docker, podman, and skopeo.
Expand Down Expand Up @@ -56,6 +54,10 @@

- The [`zli search`](../user-guides/zli.md#_zli-search) command allows smart searching for a repository by its name or for an image by its repo:tag.

### Search by digest

- You can perform a global search for a digest (SHA hash) using either the UI or the CLI. This function is useful when an issue is found in a layer that is used by multiple images. In the UI Search box, for example, begin typing `sha256:` followed by a partial or complete digest value to see a dropdown list of images that contain the layer with the digest value.

### GraphQL support for search

- A [GraphQL backend server](../articles/graphql.md) within zot's registry search engine provides efficient and enhanced search capabilities. In addition to supporting direct GraphQL queries through the API, zot hosts the GraphQL Playground, which provides an interactive graphical environment for GraphQL queries.
Expand Down

0 comments on commit da10085

Please sign in to comment.