Puppet Class: profile::docker_registry
- Defined in:
- modules/profile/manifests/docker_registry.pp
Overview
SPDX-License-Identifier: Apache-2.0
Class profile::docker_registry
This provisions a highly available docker registry, served at <docker-registry.wikimedia.org/>.
See also <wikitech.wikimedia.org/wiki/Docker-registry>.
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'modules/profile/manifests/docker_registry.pp', line 8
class profile::docker_registry(
# The following variables might be useful elsewhere too
String $ci_restricted_user_password = lookup('profile::docker_registry::ci_restricted_user_password'),
String $kubernetes_user_password = lookup('profile::docker_registry::kubernetes_user_password'),
String $ci_build_user_password = lookup('profile::docker_registry::ci_build_user_password'),
String $prod_build_user_password = lookup('profile::docker_registry::prod_build_user_password'),
String $password_salt = lookup('profile::docker_registry::password_salt'),
# Which machines are allowed to build images.
Optional[Array[Stdlib::Host]] $image_builders = lookup('profile::docker_registry::image_builders', { 'default_value' => undef }),
# Storage configuration
String $certname = lookup('profile::docker_registry::certname'),
Array[Cfssl::Common_name] $alt_names = lookup('profile::docker_registry::alt_names'),
Hash[String, Hash[String, String]] $swift_accounts = lookup('profile::swift::accounts'),
Stdlib::Httpsurl $swift_auth_url = lookup('profile::docker_registry::swift_auth_url'),
# By default, the password will be extracted from swift, but can be overridden
Hash[String, Hash] $global_swift_account_keys = lookup('profile::swift::global_account_keys'),
Optional[String] $swift_container = lookup('profile::docker_registry::swift_container', { 'default_value' => undef }),
String $swift_replication_configuration = lookup('profile::docker_registry::swift_replication_configuration'),
String $swift_replication_key = lookup('profile::docker_registry::swift_replication_key'),
Optional[String] $swift_password = lookup('profile::docker_registry::swift_password', { 'default_value' => undef }),
Optional[Stdlib::Host] $redis_host = lookup('profile::docker_registry::redis_host', { 'default_value' => undef }),
Optional[Stdlib::Port] $redis_port = lookup('profile::docker_registry::redis_port', { 'default_value' => undef }),
Optional[String] $redis_password = lookup('profile::docker_registry::redis_password', { 'default_value' => undef }),
Optional[String] $docker_registry_shared_secret = lookup('profile::docker_registry::shared_secret', { 'default_value' => undef }),
Boolean $registry_read_only_mode = lookup('profile::docker_registry::read_only_mode', { 'default_value' => false }),
Array[Stdlib::Host] $deployment_hosts = lookup('deployment_hosts', { 'default_value' => [] }),
Boolean $nginx_blob_cache = lookup('profile::docker_registry::nginx_blob_cache', { 'default_value' => true }),
Boolean $nginx_auth_cache = lookup('profile::docker_registry::nginx_auth_cache', { 'default_value' => true }),
# Hosts allowed to authenticate using JSON Web Tokens issued by our GitLab instance
Array[Stdlib::IP::Address] $jwt_allowed_ips = lookup('profile::docker_registry::jwt_allowed_ips', { 'default_value' => [] }),
# Which k8s clusters should be able to pull restricted images
Array[String] $authorized_k8s_clusters = lookup('profile::docker_registry::authorized_k8s_clusters', { 'default_value' => [] }),
Optional[Integer] $catalog_maxentries = lookup('profile::docker_registry::catalog_maxentries', { 'default_value' => 50}),
Hash[String, Hash] $apus_credentials = lookup('profile::ceph::s3::client::apus_keys'),
) {
require network::constants
# Hiera configurations
if !$image_builders {
$builders = $deployment_hosts
} else {
$builders = $image_builders
}
$swift_account = $swift_accounts['docker_registry']
# Get the local site's swift credentials
$swift_account_keys = $global_swift_account_keys[$::site]
if !$swift_password {
$password = $swift_account_keys['docker_registry']
}
else {
$password = $swift_password
}
# Install all the required stuff
class { 'docker_registry': }
# Get our swift registry started
docker_registry::instance { 'swift':
backend => 'swift',
backend_config => {
username => $swift_account['user'],
password => $password,
authurl => $swift_auth_url,
container => $swift_container,
},
swift_replication_key => $swift_replication_key,
swift_replication_configuration => $swift_replication_configuration,
redis_config => {
addr => "${redis_host}:${redis_port}",
password => $redis_password,
db => 0,
},
registry_shared_secret => $docker_registry_shared_secret,
catalog_maxentries => $catalog_maxentries,
port => 5000,
debug_port => 5001,
}
# Keep it named after the intended user for now
docker_registry::instance { 'restricted':
backend => 's3',
backend_config => {
accesskey => $apus_credentials['docker-registry']['access_key'],
secretkey => $apus_credentials['docker-registry']['secret_key'],
bucket => 'registry-restricted', # The bucket should be around beforehand
regionendpoint => 'https://apus.discovery.wmnet',
secure => true, # use HTTPS
encrypt => false, # but don't encrypt the data
region => 'us-west-1', # This is useless but required
# Valid values are: off (default), debug, debugwithsigning, debugwithhttpbody, debugwithrequestretries,
# debugwithrequesterrors and debugwitheventstreambody
# loglevel => 'off',
},
redis_config => {
addr => "${redis_host}:${redis_port}",
password => $redis_password,
db => 1,
},
registry_shared_secret => $docker_registry_shared_secret,
catalog_maxentries => $catalog_maxentries,
port => 5002,
debug_port => 5003,
}
$k8s_groups = k8s::fetch_cluster_groups()
# Get a list of all nodes (without control planes) in the authorized clusters
$kubernetes_hosts = $authorized_k8s_clusters.map |$cluster_name| {
$k8s_groups[$cluster_name].values.map |$x| {
$x['cluster_nodes'].filter |$n| { !($n in $x['control_plane_nodes']) }
}
}.flatten.unique
# Nginx frontend
$ssl_paths = profile::pki::get_cert('discovery', $certname, {
'notify_services' => ['nginx'],
'outdir' => '/etc/nginx/ssl',
'hosts' => $alt_names,
})
class { 'sslcert::dhparam': }
class { 'docker_registry::web':
ci_restricted_user_password => $ci_restricted_user_password,
kubernetes_user_password => $kubernetes_user_password,
ci_build_user_password => $ci_build_user_password,
prod_build_user_password => $prod_build_user_password,
password_salt => $password_salt,
allow_push_from => $image_builders,
ssl_settings => ssl_ciphersuite('nginx', 'mid'),
ssl_paths => $ssl_paths,
read_only_mode => $registry_read_only_mode,
nginx_blob_cache => $nginx_blob_cache,
nginx_auth_cache => $nginx_auth_cache,
deployment_hosts => $deployment_hosts,
kubernetes_hosts => $kubernetes_hosts,
jwt_allowed_ips => $jwt_allowed_ips,
}
# T209709
nginx::status_site { 'status':
port => 10080,
}
ferm::service { 'docker_registry_https':
proto => 'tcp',
port => 443,
srange => '$DOMAIN_NETWORKS',
}
# Monitoring
# This will test both nginx and the docker registry application
monitoring::service { 'check_docker_registry_https':
description => 'Docker registry HTTPS interface',
check_command => "check_https_url_for_string!${::fqdn}!/v2/bullseye/manifests/latest!schemaVersion",
notes_url => 'https://wikitech.wikimedia.org/wiki/Docker',
migration_task => 'T384321',
}
monitoring::service { 'check_docker_registry_https_expiry':
description => 'Docker registry HTTPS interface certificate expiry',
check_command => "check_https_expiry!${facts['networking']['fqdn']}!443",
notes_url => 'https://wikitech.wikimedia.org/wiki/Docker',
migration_task => 'T367065',
}
# This will query /debug/health registry endpoint on 5001 debug server
monitoring::service { 'check_docker_registry_health':
description => 'Docker registry health',
check_command => "check_http_url_for_regexp_on_port!${::fqdn}:5001!5001!/debug/health!\\\\{\\\\}",
notes_url => 'https://wikitech.wikimedia.org/wiki/Docker',
migration_task => 'T384321',
}
}
|