<p>This file is a regular <ahref="https://rancher.com/docs/k3s/latest/en/installation/private-registry/">k3s registries configuration file</a>, and looks like this:</p>
<p>In this example, an image with a name like <code>my.company.registry:5000/nginx:latest</code> would be
<em>pulled</em> from the registry running at <code>http://my.company.registry:5000</code>.</p>
<p>Note well there is an important limitation: <strong>this configuration file will only work with k3s >= v0.10.0</strong>. It will fail silently with previous versions of k3s, but you find in the <ahref="#k3s-old">section below</a> an alternative solution.</p>
<p>This file can also be used for providing additional information necessary for accessing some registries, like <ahref="#authenticated-registries">authentication</a> and <ahref="#secure-registries">certificates</a>.</p>
<p>When using secure registries, the <ahref="#registries-file"><code>registries.yaml</code> file</a> must include information about the certificates. For example, if you want to use images from the secure registry running at <code>https://my.company.registry</code>, you must first download a CA file valid for that server and store it in some well-known directory like <code>${HOME}/.k3d/my-company-root.pem</code>. </p>
<p>Then you have to mount the CA file in some directory in the nodes in the cluster and include that mounted file in a <code>configs</code> section in the <ahref="#registries-file"><code>registries.yaml</code> file</a>.
For example, if we mount the CA file in <code>/etc/ssl/certs/my-company-root.pem</code>, the <code>registries.yaml</code> will look like:</p>
<h2id="using-a-local-registry">Using a local registry<aclass="headerlink"href="#using-a-local-registry"title="Permanent link">¶</a></h2>
<h3id="using-the-k3d-registry">Using the k3d registry<aclass="headerlink"href="#using-the-k3d-registry"title="Permanent link">¶</a></h3>
<divclass="admonition info">
<pclass="admonition-title">Not ported yet</p>
<p>The k3d-managed registry has not yet been ported from v1.x to v3.x</p>
</div>
<h3id="using-your-own-local-registry">Using your own local registry<aclass="headerlink"href="#using-your-own-local-registry"title="Permanent link">¶</a></h3>
<p>You can start your own local registry it with some <code>docker</code> commands, like:</p>
<p>These commands will start your registry in <code>registry.localhost:5000</code>. In order to push to this registry, you will need to make it accessible as described in the next section.
Once your registry is up and running, we will need to add it to your <code>registries.yaml</code> configuration file.
Finally, you have to connect the registry network to the k3d cluster network: <codeclass="highlight">docker network connect k3d-k3s-default registry.localhost</code>. And then you can <ahref="#testing-your-registry">test your local registry</a>.</p>
<h3id="pushing-to-your-local-registry-address">Pushing to your local registry address<aclass="headerlink"href="#pushing-to-your-local-registry-address"title="Permanent link">¶</a></h3>
<p>As per the guide above, the registry will be available at <code>registry.localhost:5000</code>. All the nodes in your k3d cluster can resolve this hostname (thanks to the DNS server provided by the Docker daemon) but, in order to be able to push to this registry, this hostname also has to be resolved by your host.</p>
<p>Luckily (for Linux users), <ahref="http://man7.org/linux/man-pages/man8/nss-myhostname.8.html">NSS-myhostname</a> ships with many Linux distributions
and should resolve <code>*.localhost</code> automatically to <code>127.0.0.1</code>.<br/>
Otherwise, it’s installable using <code>sudo apt install libnss-myhostname</code>.</p>
<p>If it’s not the case, you can add an entry in your <code>/etc/hosts</code> file like this:</p>
<p>Once again, this will only work with k3s >= v0.10.0 (see the some sections below when using k3s <= v0.9.1)</p>
<h2id="testing-your-registry">Testing your registry<aclass="headerlink"href="#testing-your-registry"title="Permanent link">¶</a></h2>
<p>You should test that you can</p>
<ul>
<li>push to your registry from your local development machine.</li>
<li>use images from that registry in <code>Deployments</code> in your k3d cluster.</li>
</ul>
<p>We will verify these two things for a local registry (located at <code>registry.localhost:5000</code>) running in your development machine. Things would be basically the same for checking an external registry, but some additional configuration could be necessary in your local machine when using an authenticated or secure registry (please refer to Docker’s documentation for this).</p>
<p>First, we can download some image (like <code>nginx</code>) and push it to our local registry with:</p>
<p>```shell script
docker pull nginx:latest
docker tag nginx:latest registry.localhost:5000/nginx:latest
docker push registry.localhost:5000/nginx:latest
<divclass="highlight"><pre><span></span><code>Then we can deploy a pod referencing this image to your cluster:
```shell script
cat <<EOF | kubectl apply -f -
apiVersion: apps/v1
kind: Deployment
metadata:
name: nginx-test-registry
labels:
app: nginx-test-registry
spec:
replicas: 1
selector:
matchLabels:
app: nginx-test-registry
template:
metadata:
labels:
app: nginx-test-registry
spec:
containers:
- name: nginx-test-registry
image: registry.localhost:5000/nginx:latest
ports:
- containerPort: 80
EOF
</code></pre></div></p>
<p>Then you should check that the pod is running with <code>kubectl get pods -l "app=nginx-test-registry"</code>.</p>
<h2id="configuring-registries-for-k3s-v091">Configuring registries for k3s <= v0.9.1<aclass="headerlink"href="#configuring-registries-for-k3s-v091"title="Permanent link">¶</a></h2>
<p>k3s servers below v0.9.1 do not recognize the <code>registries.yaml</code> file as described in
the in the beginning, so you will need to embed the contents of that file in a <code>containerd</code> configuration file.
You will have to create your own <code>containerd</code> configuration file at some well-known path like <code>${HOME}/.k3d/config.toml.tmpl</code>, like this:</p>
<p>and then mount it at <code>/var/lib/rancher/k3s/agent/etc/containerd/config.toml.tmpl</code> (where <code>containerd</code> in your k3d nodes will load it) when creating the k3d cluster:</p>
<scriptsrc="../../../assets/javascripts/bundle.c1ccee15.min.js"></script><scriptid="__lang"type="application/json">{"clipboard.copy":"Copy to clipboard","clipboard.copied":"Copied to clipboard","search.config.lang":"en","search.config.pipeline":"trimmer, stopWordFilter","search.config.separator":"[\\s\\-]+","search.placeholder":"Search","search.result.placeholder":"Type to start searching","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.term.missing":"Missing"}</script>
