0
Fork 0
mirror of https://github.com/project-zot/zot.git synced 2024-12-16 21:56:37 -05:00
zot/pkg/extensions/README_mgmt.md
Andrei Aaron 4e5db84cb1
chore: update image-spec and dist spec to 1.1.0 (#2255)
BREAKING CHANGE: the dist spec version in the config files needs to be bumped to 1.1.0
in order for the config verification to pass without warnings.

Also fix 1 dependabot alert for helm.

Signed-off-by: Andrei Aaron <aaaron@luxoft.com>
2024-02-20 13:27:21 +02:00

1.1 KiB

mgmt

mgmt component provides an endpoint for configuration management

Response depends on the user privileges:

  • unauthenticated and authenticated users will get a stripped config
  • admins will get full configuration with passwords hidden (not implemented yet)
Supported queries Input Output Description
Get current configuration None config json Get current zot configuration

Get current configuration

Sample request

curl http://localhost:8080/v2/_zot/ext/mgmt | jq

Sample response

{
  "distSpecVersion": "1.1.0",
  "binaryType": "-sync-search-scrub-metrics-lint-ui-mgmt",
  "http": {
    "auth": {
      "htpasswd": {},
      "bearer": {
        "realm": "https://auth.myreg.io/auth/token",
        "service": "myauth"
      }
    }
  }
}

If ldap or htpasswd are enabled mgmt will return {"htpasswd": {}} indicating that clients can authenticate with basic auth credentials.

If any key is present under 'auth' key, in the mgmt response, it means that particular authentication method is enabled.