Skip to content

registry

registry adapters

registry adapters

Get available adapters


registry create

registry create <NAME> <URL> [OPTIONS]

Create a new registry.

Arguments

NAME
The registry name.
Type: text
Required:

URL
The registry URL string.
Type: text
Required:

Options

--credential-type <CREDENTIAL_TYPE>

Type: text

--access-key <ACCESS_KEY>
Access key, e.g. user name when credential type is 'basic'.
Type: text

--access-secret <ACCESS_SECRET>
Access secret, e.g. password when credential type is 'basic'.
Type: text

--type <TYPE>
Type of the registry, e.g. 'harbor'.
Type: text

--insecure
Disable verification of TLS certificates.
Type: boolean (flag)
Default: False

--description <DESCRIPTION>
Description of the registry.
Type: text


registry delete

registry delete <REGISTRY_ID> [OPTIONS]

Delete a registry.

Arguments

REGISTRY_ID
ID of registry to delete.
Type: integer
Required:

Options

--force
Force deletion without confirmation.
Type: boolean (flag)
Default: False


registry get

registry get <REGISTRY_ID>

Fetch a registry.

Arguments

REGISTRY_ID
ID of registry to get.
Type: integer
Required:


registry info

registry info <REGISTRY_ID>

Get information about a registry's triggers and resource filters

Arguments

REGISTRY_ID
ID of registry to get info for.
Type: integer
Required:


registry list

registry list [OPTIONS]

List registries.

Options

--query <QUERY>
Query parameters to filter the results.
See harborapi docs for more information.
Type: text

--sort <SORT>
Sorting order of the results. Example: 'name,-id' to sort by name ascending and id descending.
Type: text

--page <PAGE>
(Advanced) Page to begin fetching from.
Type: integer
Default: 1

--page-size <PAGE_SIZE>
(Advanced) Results to fetch per API call.
Type: integer
Default: 10

--limit <LIMIT>
Maximum number of results to fetch.
Type: integer


registry ping

registry ping <REGISTRY_ID> [OPTIONS]

Ping a registry to see if it's reachable.

Arguments

REGISTRY_ID
ID of registry to get status of.
Type: integer
Required:

Options

--type <TYPE>
Type of the registry, e.g. 'harbor'.
Type: text

--url <URL>
The registry URL.
Type: text

--credential-type <CREDENTIAL_TYPE>
Credential type of the registry, e.g. 'basic'.
Type: text

--access-key <ACCESS_KEY>
The registry access key.
Type: text

--access-secret <ACCESS_SECRET>
The registry access secret.
Type: text

--insecure <INSECURE>
Whether or not the certificate will be verified when Harbor tries to access the server.
Type: boolean


registry providers

registry providers

List all available registry providers


registry update

registry update <REGISTRY_ID> [OPTIONS]

Update a registry.

Arguments

REGISTRY_ID
ID of registry to update.
Type: integer
Required:

Options

--name <NAME>
The registry name.
Type: text

--url <URL>
The registry URL.
Type: text

--description <DESCRIPTION>
Description of the registry.
Type: text

--credential-type <CREDENTIAL_TYPE>
Credential type of the registry, e.g. 'basic'.
Type: text

--access-key <ACCESS_KEY>
The registry access key.
Type: text

--access-secret <ACCESS_SECRET>
The registry access secret.
Type: text

--insecure
Whether or not the certificate will be verified when Harbor tries to access the server.
Type: boolean (flag)