registries

Creates, updates, deletes, gets or lists a registries resource.

Overview

Name	registries
Type	Resource
Id	ovh.cloud_ai.registries

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	string	Registry Id
created_at	string (date-time)	Registry creation date (wire: createdAt)
password	string (password)	Docker registry password
region	string	Region where the registry is available
updated_at	string (date-time)	Registry update date (wire: updatedAt)
url	string	Docker registry URL
user	string	Registry user creator
username	string	Docker registry username

list

Representation of a registry

Name	Datatype	Description
id	string	Registry Id
created_at	string (date-time)	Registry creation date (wire: createdAt)
password	string (password)	Docker registry password
region	string	Region where the registry is available
updated_at	string (date-time)	Registry update date (wire: updatedAt)
url	string	Docker registry URL
user	string	Registry user creator
username	string	Docker registry username

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	registry_id, service_name		Get information about a Docker registry
list	select	service_name		List Docker registries
create	insert	service_name, password, region, url, username		Create a Docker registry
update	update	registry_id, service_name		Update a Docker registry
delete	delete	registry_id, service_name		Delete a Docker registry

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
registry_id	string	Registry ID (wire: registryId)
service_name	string	The Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.

SELECT examples

get

Get information about a Docker registry

SELECT
id,
created_at,
password,
region,
updated_at,
url,
user,
username
FROM ovh.cloud_ai.registries
WHERE registry_id = '{{ registry_id }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

list

List Docker registries

SELECT
id,
created_at,
password,
region,
updated_at,
url,
user,
username
FROM ovh.cloud_ai.registries
WHERE service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;

INSERT examples

create

Create a Docker registry

INSERT INTO ovh.cloud_ai.registries (
password,
region,
url,
username,
service_name
)
SELECT 
'{{ password }}' /* required */,
'{{ region }}' /* required */,
'{{ url }}' /* required */,
'{{ username }}' /* required */,
'{{ service_name }}'
RETURNING
id,
created_at,
password,
region,
updated_at,
url,
user,
username
;

Manifest

# Description fields are for documentation purposes
- name: registries
props:
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the registries resource.
  - name: password
    value: "{{ password }}"
    description: |
      Docker registry password
  - name: region
    value: "{{ region }}"
    description: |
      Region where the registry is available
  - name: url
    value: "{{ url }}"
    description: |
      Docker registry URL
  - name: username
    value: "{{ username }}"
    description: |
      Docker registry username

UPDATE examples

update

Update a Docker registry

UPDATE ovh.cloud_ai.registries
SET 
password = '{{ password }}',
url = '{{ url }}',
username = '{{ username }}'
WHERE 
registry_id = '{{ registry_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set;

DELETE examples

delete

Delete a Docker registry

DELETE FROM ovh.cloud_ai.registries
WHERE registry_id = '{{ registry_id }}' --required
AND service_name = '{{ service_name }}' --required unless OVH_CLOUD_PROJECT_SERVICE is set
;