registry_credentials

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

Overview

Name	registry_credentials
Type	Resource
Id	nvidia.nvcf_deployments.registry_credentials

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
nca_id	string (UTF-8)	NVIDIA Cloud Account Id owning the Registry Credential (wire: ncaId)
registry_credential_id	string (uuid)	Registry Credential Id (wire: registryCredentialId)
registry_credential_name	string (UTF-8)	Registry Credential name (wire: registryCredentialName)
registry_name	string (UTF-8)	Recognized registry name (wire: registryName)
artifact_types	array	Registry type (wire: artifactTypes)
created_at	string (date_time)	Timestamp for registry credential creation (wire: createdAt)
description	string (UTF-8)	Registry credential description
key_type	string (UTF-8)	Optional registry credential key type (wire: keyType)
last_updated_at	string (date_time)	Timestamp for last registry credential update (wire: lastUpdatedAt)
provisioned_by	string (UTF-8)	Registry credential provisioned by system or user (SYSTEM, USER) (wire: provisionedBy)
registry_hostname	string (UTF-8)	Registry hostname (wire: registryHostname)
tags	array	Optional set of tags

list

Name	Datatype	Description
nca_id	string (UTF-8)	NVIDIA Cloud Account Id owning the Registry Credential (wire: ncaId)
registry_credential_id	string (uuid)	Registry Credential Id (wire: registryCredentialId)
registry_credential_name	string (UTF-8)	Registry Credential name (wire: registryCredentialName)
registry_name	string (UTF-8)	Recognized registry name (wire: registryName)
artifact_types	array	Registry type (wire: artifactTypes)
created_at	string (date_time)	Timestamp for registry credential creation (wire: createdAt)
description	string (UTF-8)	Registry credential description
key_type	string (UTF-8)	Optional registry credential key type (wire: keyType)
last_updated_at	string (date_time)	Timestamp for last registry credential update (wire: lastUpdatedAt)
provisioned_by	string (UTF-8)	Registry credential provisioned by system or user (SYSTEM, USER) (wire: provisionedBy)
registry_hostname	string (UTF-8)	Registry hostname (wire: registryHostname)
tags	array	Optional set of tags

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	registry_credential_id		Retrieves detailed information of the specified registry credential associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.
list	select		artifact_type, provisioned_by	Lists all the registry credentials associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.
create	insert	artifact_types, registry_hostname, secret		Adds a new registry credential to the account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.
update	update	registry_credential_id		Updates the secret and/or the artifact types associated with the specified registry credential. Artifact types specified in the request body are added to the set of artifact types that already exist for the specified registry credential. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.
delete	delete	registry_credential_id		Deletes the specified registry credential associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.

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
registry_credential_id	string (uuid)	Registry Credential id
artifact_type	array	Filters registry credentials using the specified 'artifactType' query param. (wire: artifactType)
provisioned_by	array	Filters registry credentials using the specified 'provisionedBy' query param. (wire: provisionedBy)

SELECT examples

get

Retrieves detailed information of the specified registry credential associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.

SELECT
nca_id,
registry_credential_id,
registry_credential_name,
registry_name,
artifact_types,
created_at,
description,
key_type,
last_updated_at,
provisioned_by,
registry_hostname,
tags
FROM nvidia.nvcf_deployments.registry_credentials
WHERE registry_credential_id = '{{ registry_credential_id }}' -- required
;

list

Lists all the registry credentials associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.

SELECT
nca_id,
registry_credential_id,
registry_credential_name,
registry_name,
artifact_types,
created_at,
description,
key_type,
last_updated_at,
provisioned_by,
registry_hostname,
tags
FROM nvidia.nvcf_deployments.registry_credentials
WHERE artifact_type = '{{ artifact_type }}'
AND provisioned_by = '{{ provisioned_by }}'
;

INSERT examples

create

Adds a new registry credential to the account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.

INSERT INTO nvidia.nvcf_deployments.registry_credentials (
artifact_types,
description,
registry_hostname,
secret,
tags
)
SELECT 
'{{ artifact_types }}' /* required */,
'{{ description }}',
'{{ registry_hostname }}' /* required */,
'{{ secret }}' /* required */,
'{{ tags }}'
RETURNING
registry_credential
;

Manifest

# Description fields are for documentation purposes
- name: registry_credentials
props:
  - name: artifact_types
    value:
      - "{{ artifact_types }}"
    description: |
      Artifact types that can be retrieved using this credential
  - name: description
    value: "{{ description }}"
    description: |
      Optional registry credential description
  - name: registry_hostname
    value: "{{ registry_hostname }}"
    description: |
      Registry hostname
  - name: secret
    description: |
      Registry credential - secret value must be base64 encoded string in username:password format
    value:
      name: "{{ name }}"
      value: "{{ value }}"
  - name: tags
    value:
      - "{{ tags }}"
    description: |
      Optional set of tags

UPDATE examples

update

Updates the secret and/or the artifact types associated with the specified registry credential. Artifact types specified in the request body are added to the set of artifact types that already exist for the specified registry credential. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.

UPDATE nvidia.nvcf_deployments.registry_credentials
SET 
artifact_type_enums = '{{ artifact_type_enums }}',
secret = '{{ secret }}'
WHERE 
registry_credential_id = '{{ registry_credential_id }}' --required
RETURNING
registry_credential;

DELETE examples

delete

Deletes the specified registry credential associated with the authenticated NVIDIA Cloud Account. Requires a bearer token in the HTTP Authorization header with 'manage_registries' scope.

DELETE FROM nvidia.nvcf_deployments.registry_credentials
WHERE registry_credential_id = '{{ registry_credential_id }}' --required
;