Registry

A registry is where image repositories are hosted. The repository can be either from DockerHub, Quay.io, or a custom private registry.

Resource Fields

Writeable Fields

Field Type Create Update Default Notes
description string Optional Yes -  
name string Optional Yes -  
serverAddress string Yes - -  

Read Only Fields

Field Type Notes
blockDevicePath string  
driverName string  
externalId string  
id int The unique identifier for the registry
volumeAccessMode string  
volumeCapabilities array[string]  


Please read more about the common resource fields. These fields are read only and applicable to almost every resource. We have segregated them from the list above.

Operations

CreatePOST: /v2-beta/projects/${PROJECT_ID}/registries

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
-H 'Content-Type: application/json' \
-d '{
	"description": "string",
	"name": "string",
	"serverAddress": "string"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/registries'

DeleteDELETE: /v2-beta/projects/${PROJECT_ID}/registries/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X DELETE \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/registries/${ID}'

UpdatePUT: /v2-beta/projects/${PROJECT_ID}/registries/${ID}

curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X PUT \
-H 'Content-Type: application/json' \
-d '{
	"description": "string",
	"name": "string"
}' 'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/registries/${ID}'

Actions

activate POST: /v2-beta/projects/${PROJECT_ID}/registries/${ID}?action=activate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/registries/${ID}?action=activate'


Output: An updated copy of the storagePool resource

deactivate POST: /v2-beta/projects/${PROJECT_ID}/registries/${ID}?action=deactivate


Input:This action has no inputs


curl -u "${RANCHER_ACCESS_KEY}:${RANCHER_SECRET_KEY}" \
-X POST \
'http://${RANCHER_URL}:8080/v2-beta/projects/${PROJECT_ID}/registries/${ID}?action=deactivate'


Output: An updated copy of the storagePool resource