0
Fork 0
mirror of https://github.com/project-zot/zot.git synced 2024-12-16 21:56:37 -05:00
zot/pkg/extensions
Ramkumar Chinchani 6461b661f1
chore: fix dependabot alerts (#1797)
Signed-off-by: Ramkumar Chinchani <rchincha@cisco.com>
2023-09-11 20:21:56 -07:00
..
config refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
imagetrust fix: add retry logic to recreate existing trustpolicy secret (#1776) 2023-09-11 10:13:22 +03:00
lint refactor(storage): refactor storage into a single ImageStore (#1656) 2023-09-01 10:54:39 -07:00
monitoring fix: DATA RACE in TestNewExporter (#1766) 2023-09-08 15:00:16 +03:00
scrub feat(scheduler): pass the shutdown/reload ctx to running tasks (#1671) 2023-09-05 09:48:56 -07:00
search chore: fix dependabot alerts (#1797) 2023-09-11 20:21:56 -07:00
sync refactor: Reduce binary size of zot-minimal; Added CI check for binary size (#1758) 2023-09-06 19:58:00 +03:00
_zot.md refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_image_trust.go feat: upload cosign public key and notation certificates to cloud (#1744) 2023-09-08 10:03:58 +03:00
extension_image_trust_disabled.go feat: upload cosign public key and notation certificates to cloud (#1744) 2023-09-08 10:03:58 +03:00
extension_image_trust_disabled_test.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_image_trust_test.go feat: upload cosign public key and notation certificates to cloud (#1744) 2023-09-08 10:03:58 +03:00
extension_metrics.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_metrics_disabled.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_mgmt.go feat(authn): add generic oidc and allow customizable name (#1691) 2023-08-24 12:33:35 +03:00
extension_mgmt_disabled.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_scrub.go refactor(storage): refactor storage into a single ImageStore (#1656) 2023-09-01 10:54:39 -07:00
extension_scrub_disabled.go initial design for task scheduler (#700) 2022-09-22 22:27:56 -07:00
extension_search.go feat(scheduler): pass the shutdown/reload ctx to running tasks (#1671) 2023-09-05 09:48:56 -07:00
extension_search_disabled.go feat(refator): refactoring repodb into meta (#1626) 2023-07-18 10:27:26 -07:00
extension_search_test.go feat(refator): refactoring repodb into meta (#1626) 2023-07-18 10:27:26 -07:00
extension_sync.go feat(refator): refactoring repodb into meta (#1626) 2023-07-18 10:27:26 -07:00
extension_sync_disabled.go feat(refator): refactoring repodb into meta (#1626) 2023-07-18 10:27:26 -07:00
extension_ui.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_ui_disabled.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_ui_test.go test(refactor): change upload image function signature (#1655) 2023-07-28 17:53:46 +03:00
extension_userprefs.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_userprefs_disable.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extension_userprefs_test.go refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
extensions_lint.go image level lint: enforce manifest mandatory annotations 2022-07-27 11:48:04 +03:00
extensions_lint_disabled.go feat: propagate detailed error msgs to client (OCI dist-spec format) (#1681) 2023-08-23 20:59:52 +03:00
extensions_test.go feat(authn): add generic oidc and allow customizable name (#1691) 2023-08-24 12:33:35 +03:00
get_extensions.go feat: upload cosign public key and notation certificates to cloud (#1744) 2023-09-08 10:03:58 +03:00
get_extensions_disabled_test.go test(refactor): refactor tests that use zot-test to use smaller images (#1690) 2023-08-18 11:46:11 +03:00
README.md refactor: split AuthZ mdw in 2 different parts, each for a specific purpose (#1542) 2023-07-05 09:37:52 -07:00
README_imagetrust.md feat: upload cosign public key and notation certificates to cloud (#1744) 2023-09-08 10:03:58 +03:00
README_mgmt.md refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00
README_userprefs.md refactor(extensions)!: refactor the extensions URLs and errors (#1636) 2023-08-02 21:58:34 +03:00

Adding new extensions

As new requirements come and build time extensions need to be added, there are a few things that you have to make sure are present before commiting :

  • files that should be included in the binary only with a specific extension must contain the following syntax at the beginning of the file :

//go:build sync will be added automatically by the linter, so only the second line is mandatory .

NOTE: the third line in the example should be blank, otherwise the build tag would be just another comment.

//go:build sync
// +build sync

package extensions
...................
  • when adding a new tag, specify the new order in which multiple tags should be used (bottom of this page)

  • for each and every new file that contains functions (functionalities) specific to an extension, one should create a corresponding file that must contain the exact same functions, but no functionalities included. This file must begin with an "anti-tag" (e.g. // +build !sync) which will include this file in binaries that don't include this extension ( in this example, the file won't be used in binaries that include sync extension ). See extension-sync-disabled.go for an example.

  • each extension is responsible with implementing authorization for newly added HTTP endpoints. zot will provide the necessary data, including user permissions, to the extension, but actual enforcement of these permissions is the responsibility of each extension. Each extension http.Handler has access to a context previously populated by BaseAuthzHandler with relevant user info. That info has the following structure:

    type AccessControlContext struct {
      // read method action
      ReadGlobPatterns map[string]bool
      // detectManifestCollision behaviour action
      DmcGlobPatterns map[string]bool
      IsAdmin         bool
      Username        string
      Groups          []string
      } 
    

    This data can then be accessed from the request context so that every extension can apply its own authorization logic, if needed .

  • when a new extension comes out, the developer should also write some blackbox tests, where a binary that contains the new extension should be tested in a real usage scenario. See test/blackbox folder for multiple extensions examples.

  • newly added blackbox tests should have targets in Makefile. You should also add them as Github Workflows, in .github/workflows/ecosystem-tools.yaml

  • with every new extension, you should modify the EXTENSIONS variable in Makefile by adding the new extension. The EXTENSIONS variable represents all extensions and is used in Make targets that require them all (e.g make test).

  • the available extensions that can be used at the moment are: sync, scrub, metrics, search . NOTE: When multiple extensions are used, they should be listed in the above presented order.