0
Fork 0
mirror of https://github.com/project-zot/zot.git synced 2024-12-23 22:27:35 -05:00
zot/pkg/extensions
Andrei Aaron 78feb4b495
docs(graphql): rewrote search.md (#1130)
* docs(graphql): rewrote search.md
docs(graphql): added pagination and filter docs for gql

Squash of both commits:
(cherry picked from commit 2268fa0510b32b27f2c1f71e9889ec769877553b)
(cherry picked from commit c96adc88b2fb9edff90e7e4b01a8885511ceb0df)
Signed-off-by: Catalin Hofnar <catalin.hofnar@gmail.com>

Some additional updates by Andrei Aaron to keep up with the changes on main.
Also add more comments to schema.graphql

Signed-off-by: Andrei Aaron <aaaron@luxoft.com>

* style: run a graphql schemma linter as a github workflow

Signed-off-by: Andrei Aaron <aaaron@luxoft.com>

---------

Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
Co-authored-by: Catalin Hofnar <catalin.hofnar@gmail.com>
2023-02-02 12:46:35 -08:00
..
config fix(ci): do not use "ghcr.io/aquasecurity/trivy-db" for ci (#1107) 2023-01-18 14:18:03 -08:00
lint refactor: Cleanup/simplify testcases in /pkg/extensions (#1116) 2023-01-19 08:54:05 -08:00
monitoring refactor: Cleanup/simplify testcases in /pkg/extensions (#1116) 2023-01-19 08:54:05 -08:00
scrub refactor: Cleanup/simplify testcases in /pkg/extensions (#1116) 2023-01-19 08:54:05 -08:00
search docs(graphql): rewrote search.md (#1130) 2023-02-02 12:46:35 -08:00
sync fix(test): update the zot tests not to use test/data as rootDir (use a temporary folder instead) (#1162) 2023-02-02 11:39:03 -08:00
_zot.md use zot as an extension name, ext as a component and search as a module 2022-05-24 19:12:40 -07:00
extension_metrics.go chore(lint): gci to separate zot from other imports (#870) 2022-10-20 09:39:20 -07:00
extension_metrics_disabled.go chore(lint): gci to separate zot from other imports (#870) 2022-10-20 09:39:20 -07:00
extension_scrub.go add enable/disable option for scrub extension (#827) 2022-09-27 18:06:50 -07:00
extension_scrub_disabled.go initial design for task scheduler (#700) 2022-09-22 22:27:56 -07:00
extension_search.go fix(ci): do not use "ghcr.io/aquasecurity/trivy-db" for ci (#1107) 2023-01-18 14:18:03 -08:00
extension_search_disabled.go feat(repodb): Implement RepoDB for image specific information using boltdb/dynamodb (#979) 2023-01-09 12:37:44 -08:00
extension_sync.go feat(sync,s3): added s3 logic for ORAS and OCI artifacts (#985) 2022-11-14 22:21:49 -08:00
extension_sync_disabled.go feat(sync,s3): added s3 logic for ORAS and OCI artifacts (#985) 2022-11-14 22:21:49 -08:00
extensions_lint.go image level lint: enforce manifest mandatory annotations 2022-07-27 11:48:04 +03:00
extensions_lint_disabled.go image level lint: enforce manifest mandatory annotations 2022-07-27 11:48:04 +03:00
extensions_test.go refactor: Cleanup/simplify testcases in /pkg/extensions (#1116) 2023-01-19 08:54:05 -08:00
README.md build(tags): remove redundant build tag ui_base (#857) 2022-10-10 15:05:55 +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.

  • 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 enlisted in the above presented order.