2018-06-11 13:13:19 +00:00
package registries
import (
2020-07-07 21:57:52 +00:00
"errors"
2018-06-11 13:13:19 +00:00
"net/http"
2018-09-10 10:01:38 +00:00
httperror "github.com/portainer/libhttp/error"
"github.com/portainer/libhttp/request"
"github.com/portainer/libhttp/response"
2021-01-18 00:59:57 +00:00
portainer "github.com/portainer/portainer/api"
2020-07-07 21:57:52 +00:00
bolterrors "github.com/portainer/portainer/api/bolt/errors"
2021-07-14 09:15:21 +00:00
httperrors "github.com/portainer/portainer/api/http/errors"
"github.com/portainer/portainer/api/http/security"
2018-06-11 13:13:19 +00:00
)
type registryUpdatePayload struct {
2021-07-14 09:15:21 +00:00
// Name that will be used to identify this registry
Name * string ` validate:"required" example:"my-registry" `
// URL or IP address of the Docker registry
URL * string ` validate:"required" example:"registry.mydomain.tld:2375" `
// BaseURL is used for quay registry
BaseURL * string ` json:",omitempty" example:"registry.mydomain.tld:2375" `
// Is authentication against this registry enabled
Authentication * bool ` example:"false" validate:"required" `
// Username used to authenticate against this registry. Required when Authentication is true
Username * string ` example:"registry_user" `
// Password used to authenticate against this registry. required when Authentication is true
Password * string ` example:"registry_password" `
RegistryAccesses * portainer . RegistryAccesses
Quay * portainer . QuayRegistryData
2018-06-11 13:13:19 +00:00
}
func ( payload * registryUpdatePayload ) Validate ( r * http . Request ) error {
return nil
}
2021-02-23 03:21:39 +00:00
// @id RegistryUpdate
// @summary Update a registry
// @description Update a registry
// @description **Access policy**: administrator
// @tags registries
// @security jwt
// @accept json
// @produce json
// @param id path int true "Registry identifier"
// @param body body registryUpdatePayload true "Registry details"
// @success 200 {object} portainer.Registry "Success"
// @failure 400 "Invalid request"
// @failure 404 "Registry not found"
// @failure 409 "Another registry with the same URL already exists"
// @failure 500 "Server error"
// @router /registries/{id} [put]
2018-06-11 13:13:19 +00:00
func ( handler * Handler ) registryUpdate ( w http . ResponseWriter , r * http . Request ) * httperror . HandlerError {
2021-07-14 09:15:21 +00:00
securityContext , err := security . RetrieveRestrictedRequestContext ( r )
2018-06-11 13:13:19 +00:00
if err != nil {
2021-07-14 09:15:21 +00:00
return & httperror . HandlerError { http . StatusInternalServerError , "Unable to retrieve info from request context" , err }
}
if ! securityContext . IsAdmin {
return & httperror . HandlerError { http . StatusForbidden , "Permission denied to update registry" , httperrors . ErrResourceAccessDenied }
2018-06-11 13:13:19 +00:00
}
2021-07-14 09:15:21 +00:00
registryID , err := request . RetrieveNumericRouteVariableValue ( r , "id" )
2018-06-11 13:13:19 +00:00
if err != nil {
2021-07-14 09:15:21 +00:00
return & httperror . HandlerError { http . StatusBadRequest , "Invalid registry identifier route variable" , err }
2018-06-11 13:13:19 +00:00
}
2020-05-20 05:23:15 +00:00
registry , err := handler . DataStore . Registry ( ) . Registry ( portainer . RegistryID ( registryID ) )
2020-07-07 21:57:52 +00:00
if err == bolterrors . ErrObjectNotFound {
2018-06-11 13:13:19 +00:00
return & httperror . HandlerError { http . StatusNotFound , "Unable to find a registry with the specified identifier inside the database" , err }
} else if err != nil {
return & httperror . HandlerError { http . StatusInternalServerError , "Unable to find a registry with the specified identifier inside the database" , err }
}
2021-07-14 09:15:21 +00:00
var payload registryUpdatePayload
err = request . DecodeAndValidateJSONPayload ( r , & payload )
if err != nil {
return & httperror . HandlerError { http . StatusBadRequest , "Invalid request payload" , err }
}
2019-09-09 22:55:27 +00:00
if payload . Name != nil {
registry . Name = * payload . Name
2018-06-11 13:13:19 +00:00
}
2019-09-09 22:55:27 +00:00
2021-07-14 09:15:21 +00:00
shouldUpdateSecrets := false
2018-06-11 13:13:19 +00:00
2021-07-01 02:57:15 +00:00
if registry . Type == portainer . ProGetRegistry && payload . BaseURL != nil {
registry . BaseURL = * payload . BaseURL
}
2019-09-09 22:55:27 +00:00
if payload . Authentication != nil {
if * payload . Authentication {
registry . Authentication = true
2021-07-14 09:15:21 +00:00
shouldUpdateSecrets = shouldUpdateSecrets || ( payload . Username != nil && * payload . Username != registry . Username ) || ( payload . Password != nil && * payload . Password != registry . Password )
2019-09-09 22:55:27 +00:00
if payload . Username != nil {
registry . Username = * payload . Username
}
2018-06-11 13:13:19 +00:00
2021-01-18 00:59:57 +00:00
if payload . Password != nil && * payload . Password != "" {
2019-09-09 22:55:27 +00:00
registry . Password = * payload . Password
}
} else {
registry . Authentication = false
registry . Username = ""
registry . Password = ""
}
2018-06-11 13:13:19 +00:00
}
2021-07-14 09:15:21 +00:00
if payload . URL != nil {
shouldUpdateSecrets = shouldUpdateSecrets || ( * payload . URL != registry . URL )
registry . URL = * payload . URL
registries , err := handler . DataStore . Registry ( ) . Registries ( )
if err != nil {
return & httperror . HandlerError { http . StatusInternalServerError , "Unable to retrieve registries from the database" , err }
}
for _ , r := range registries {
if r . ID != registry . ID && handler . registriesHaveSameURLAndCredentials ( & r , registry ) {
return & httperror . HandlerError { http . StatusConflict , "Another registry with the same URL and credentials already exists" , errors . New ( "A registry is already defined for this URL and credentials" ) }
}
}
2019-05-24 06:04:58 +00:00
}
2021-07-14 09:15:21 +00:00
if shouldUpdateSecrets {
for endpointID , endpointAccess := range registry . RegistryAccesses {
endpoint , err := handler . DataStore . Endpoint ( ) . Endpoint ( endpointID )
if err != nil {
return & httperror . HandlerError { http . StatusInternalServerError , "Unable to update access to registry" , err }
}
if endpoint . Type == portainer . KubernetesLocalEnvironment || endpoint . Type == portainer . AgentOnKubernetesEnvironment || endpoint . Type == portainer . EdgeAgentOnKubernetesEnvironment {
err = handler . updateEndpointRegistryAccess ( endpoint , registry , endpointAccess )
if err != nil {
return & httperror . HandlerError { http . StatusInternalServerError , "Unable to update access to registry" , err }
}
}
}
2019-05-24 06:04:58 +00:00
}
2021-03-12 23:47:35 +00:00
if payload . Quay != nil {
registry . Quay = * payload . Quay
}
2020-05-20 05:23:15 +00:00
err = handler . DataStore . Registry ( ) . UpdateRegistry ( registry . ID , registry )
2018-06-11 13:13:19 +00:00
if err != nil {
return & httperror . HandlerError { http . StatusInternalServerError , "Unable to persist registry changes inside the database" , err }
}
return response . JSON ( w , registry )
}
2020-06-04 06:50:02 +00:00
2021-07-14 09:15:21 +00:00
func ( handler * Handler ) updateEndpointRegistryAccess ( endpoint * portainer . Endpoint , registry * portainer . Registry , endpointAccess portainer . RegistryAccessPolicies ) error {
cli , err := handler . K8sClientFactory . GetKubeClient ( endpoint )
if err != nil {
return err
}
for _ , namespace := range endpointAccess . Namespaces {
err := cli . DeleteRegistrySecret ( registry , namespace )
if err != nil {
return err
}
err = cli . CreateRegistrySecret ( registry , namespace )
if err != nil {
return err
}
2020-06-04 06:50:02 +00:00
}
2021-07-14 09:15:21 +00:00
return nil
2020-06-04 06:50:02 +00:00
}