Skip to content

Commit

Permalink
Update main userdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 11, 2024
1 parent d2881fb commit 66a8b98
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 30 deletions.
28 changes: 14 additions & 14 deletions public/docs/user/main/_sources/docker_and_oci.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,17 @@ To make use of the API limits under a Docker Hub account, or to access
private containers, you'll need to authenticate to Docker Hub. There are
a number of ways to do this with {Project}.

{Project} CLI Remote Command
------------------------------
{Project} CLI ``registry`` Command
------------------------------------

The ``{command} remote login`` command supports logging into Docker
The ``{command} registry login`` command supports logging into Docker
Hub and other OCI registries. For Docker Hub, the registry hostname is
``docker.io``, so you will need to login as below, specifying your
username:

.. code::
$ {command} remote login --username myuser docker://docker.io
$ {command} registry login --username myuser docker://docker.io
Password / Token:
INFO: Token stored in /home/myuser/.{command}/remote.yaml
Expand All @@ -139,14 +139,14 @@ which you should generate in the 'Security' section of your account
profile page on Docker Hub.

To check which Docker / OCI registries you are currently logged in to,
use ``{command} remote list``.
use ``{command} registry list``.

To logout of a registry, so that your credentials are forgotten, use
``{command} remote logout``:
``{command} registry logout``:

.. code::
$ {command} remote logout docker://docker.io
$ {command} registry logout docker://docker.io
INFO: Logout succeeded
Docker CLI Authentication
Expand Down Expand Up @@ -240,7 +240,7 @@ To pull containers from private repositories you will need to generate a
CLI token in the Quay web interface, then use it to login with
{Project}. Use the same methods as described for Docker Hub above:

- Run ``{command} remote login --username myuser docker://quay.io``
- Run ``{command} registry login --username myuser docker://quay.io``
to store your credentials for {Project}.
- Use ``docker login quay.io`` if ``docker`` is on your machine.
- Use the ``--docker-login`` flag for a one-time interactive login.
Expand Down Expand Up @@ -273,7 +273,7 @@ Use one of the following authentication methods (detailed above for
Docker Hub), with the username ``$oauthtoken`` and the password set to
your NGC API key.

- Run ``{command} remote login --username \$oauthtoken
- Run ``{command} registry login --username \$oauthtoken
docker://nvcr.io`` to store your credentials for {Project}.
- Use ``docker login nvcr.io`` if ``docker`` is on your machine.
- Use the ``--docker-login`` flag for a one-time interactive login.
Expand Down Expand Up @@ -307,7 +307,7 @@ documentation here.
Use one of the following authentication methods (detailed above for
Docker Hub), with your username and personal access token:

- Run ``{command} remote login --username myuser docker://ghcr.io``
- Run ``{command} registry login --username myuser docker://ghcr.io``
to store your credentials for {Project}.
- Use ``docker login ghcr.io`` if ``docker`` is on your machine.
- Use the ``--docker-login`` flag for a one-time interactive login.
Expand Down Expand Up @@ -348,7 +348,7 @@ username used in conjunction with this password is always ``AWS``.
Then login using one of the following methods:

- Run ``{command} remote login --username AWS
- Run ``{command} registry login --username AWS
docker://<accountid>.dkr.ecr.<region>.amazonaws.com`` to store your
credentials for {Project}.

Expand Down Expand Up @@ -381,7 +381,7 @@ will add credentials to ``.docker/config.json`` which can be read by
Service Principle accounts will have an explicit username and password,
and you should authenticate using one of the following methods:

- Run ``{command} remote login --username myuser
- Run ``{command} registry login --username myuser
docker://myregistry.azurecr.io`` to store your credentials for
{Project}.

Expand Down Expand Up @@ -542,7 +542,7 @@ stored credentials or environment variables must be available to the
environment variables through sudo to the ``root`` build process by
running ``sudo -E {command} build ...``.

- Run ``sudo {command} remote login ...`` to store your credentials
- Run ``sudo {command} registry login ...`` to store your credentials
for the ``root`` user on your system. This is separate from storing
the credentials under your own account.

Expand Down Expand Up @@ -1209,7 +1209,7 @@ If you experience problems pulling containers from a private registry,
check your credentials carefully. You can ``{command} pull`` with the
``--docker-login`` flag to perform an interactive login. This may be
useful if you are unsure whether you have stored credentials properly
via ``{command} remote login`` or ``docker login``.
via ``{command} registry login`` or ``docker login``.

OCI registries expect different values for username and password fields.
Some require a token to be generated and used instead of your account
Expand Down
30 changes: 15 additions & 15 deletions public/docs/user/main/docker_and_oci.html
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@
<li class="toctree-l3"><a class="reference internal" href="#public-containers">Public Containers</a></li>
<li class="toctree-l3"><a class="reference internal" href="#docker-hub-limits">Docker Hub Limits</a></li>
<li class="toctree-l3"><a class="reference internal" href="#authentication-private-containers">Authentication / Private Containers</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#apptainer-cli-remote-command">Apptainer CLI Remote Command</a></li>
<li class="toctree-l4"><a class="reference internal" href="#apptainer-cli-registry-command">Apptainer CLI <code class="docutils literal notranslate"><span class="pre">registry</span></code> Command</a></li>
<li class="toctree-l4"><a class="reference internal" href="#docker-cli-authentication">Docker CLI Authentication</a></li>
<li class="toctree-l4"><a class="reference internal" href="#interactive-login">Interactive Login</a></li>
<li class="toctree-l4"><a class="reference internal" href="#environment-variables">Environment Variables</a></li>
Expand Down Expand Up @@ -291,13 +291,13 @@ <h3>Authentication / Private Containers<a class="headerlink" href="#authenticati
<p>To make use of the API limits under a Docker Hub account, or to access
private containers, you’ll need to authenticate to Docker Hub. There are
a number of ways to do this with Apptainer.</p>
<div class="section" id="apptainer-cli-remote-command">
<h4>Apptainer CLI Remote Command<a class="headerlink" href="#apptainer-cli-remote-command" title="Permalink to this heading"></a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span></code> command supports logging into Docker
<div class="section" id="apptainer-cli-registry-command">
<h4>Apptainer CLI <code class="docutils literal notranslate"><span class="pre">registry</span></code> Command<a class="headerlink" href="#apptainer-cli-registry-command" title="Permalink to this heading"></a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span></code> command supports logging into Docker
Hub and other OCI registries. For Docker Hub, the registry hostname is
<code class="docutils literal notranslate"><span class="pre">docker.io</span></code>, so you will need to login as below, specifying your
username:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ apptainer remote login --username myuser docker://docker.io
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ apptainer registry login --username myuser docker://docker.io
Password / Token:
INFO: Token stored in /home/myuser/.apptainer/remote.yaml
</pre></div>
Expand All @@ -306,10 +306,10 @@ <h4>Apptainer CLI Remote Command<a class="headerlink" href="#apptainer-cli-remot
which you should generate in the ‘Security’ section of your account
profile page on Docker Hub.</p>
<p>To check which Docker / OCI registries you are currently logged in to,
use <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">list</span></code>.</p>
use <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">list</span></code>.</p>
<p>To logout of a registry, so that your credentials are forgotten, use
<code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">logout</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ apptainer remote logout docker://docker.io
<code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">logout</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$ apptainer registry logout docker://docker.io
INFO: Logout succeeded
</pre></div>
</div>
Expand Down Expand Up @@ -393,7 +393,7 @@ <h3>Quay.io<a class="headerlink" href="#quay-io" title="Permalink to this headin
CLI token in the Quay web interface, then use it to login with
Apptainer. Use the same methods as described for Docker Hub above:</p>
<ul class="simple">
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span> <span class="pre">docker://quay.io</span></code>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span> <span class="pre">docker://quay.io</span></code>
to store your credentials for Apptainer.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span> <span class="pre">quay.io</span></code> if <code class="docutils literal notranslate"><span class="pre">docker</span></code> is on your machine.</p></li>
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">--docker-login</span></code> flag for a one-time interactive login.</p></li>
Expand Down Expand Up @@ -422,7 +422,7 @@ <h3>NVIDIA NGC<a class="headerlink" href="#nvidia-ngc" title="Permalink to this
Docker Hub), with the username <code class="docutils literal notranslate"><span class="pre">$oauthtoken</span></code> and the password set to
your NGC API key.</p>
<ul class="simple">
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">\$oauthtoken</span>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">\$oauthtoken</span>
<span class="pre">docker://nvcr.io</span></code> to store your credentials for Apptainer.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span> <span class="pre">nvcr.io</span></code> if <code class="docutils literal notranslate"><span class="pre">docker</span></code> is on your machine.</p></li>
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">--docker-login</span></code> flag for a one-time interactive login.</p></li>
Expand All @@ -449,7 +449,7 @@ <h3>NVIDIA NGC<a class="headerlink" href="#nvidia-ngc" title="Permalink to this
<p>Use one of the following authentication methods (detailed above for
Docker Hub), with your username and personal access token:</p>
<ul class="simple">
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span> <span class="pre">docker://ghcr.io</span></code>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span> <span class="pre">docker://ghcr.io</span></code>
to store your credentials for Apptainer.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span> <span class="pre">ghcr.io</span></code> if <code class="docutils literal notranslate"><span class="pre">docker</span></code> is on your machine.</p></li>
<li><p>Use the <code class="docutils literal notranslate"><span class="pre">--docker-login</span></code> flag for a one-time interactive login.</p></li>
Expand Down Expand Up @@ -486,7 +486,7 @@ <h3>AWS ECR<a class="headerlink" href="#aws-ecr" title="Permalink to this headin
</div>
<p>Then login using one of the following methods:</p>
<ul class="simple">
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">AWS</span>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">AWS</span>
<span class="pre">docker://&lt;accountid&gt;.dkr.ecr.&lt;region&gt;.amazonaws.com</span></code> to store your
credentials for Apptainer.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">AWS</span>
Expand All @@ -512,7 +512,7 @@ <h3>Azure ACR<a class="headerlink" href="#azure-acr" title="Permalink to this he
<p>Service Principle accounts will have an explicit username and password,
and you should authenticate using one of the following methods:</p>
<ul class="simple">
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span>
<span class="pre">docker://myregistry.azurecr.io</span></code> to store your credentials for
Apptainer.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span> <span class="pre">--username</span> <span class="pre">myuser</span> <span class="pre">myregistry.azurecr.io</span></code> if
Expand Down Expand Up @@ -639,7 +639,7 @@ <h4>Authentication During a Build<a class="headerlink" href="#authentication-dur
<code class="docutils literal notranslate"><span class="pre">APPTAINER_DOCKER_PASSWORD</span></code> environment variables. Pass the
environment variables through sudo to the <code class="docutils literal notranslate"><span class="pre">root</span></code> build process by
running <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">-E</span> <span class="pre">apptainer</span> <span class="pre">build</span> <span class="pre">...</span></code>.</p></li>
<li><p>Run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span> <span class="pre">...</span></code> to store your credentials
<li><p>Run <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span> <span class="pre">...</span></code> to store your credentials
for the <code class="docutils literal notranslate"><span class="pre">root</span></code> user on your system. This is separate from storing
the credentials under your own account.</p></li>
<li><p>Use <code class="docutils literal notranslate"><span class="pre">sudo</span> <span class="pre">docker</span> <span class="pre">login</span></code> if <code class="docutils literal notranslate"><span class="pre">docker</span></code> is on your machine. This is
Expand Down Expand Up @@ -1218,7 +1218,7 @@ <h3>Registry Authentication Issues<a class="headerlink" href="#registry-authenti
check your credentials carefully. You can <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">pull</span></code> with the
<code class="docutils literal notranslate"><span class="pre">--docker-login</span></code> flag to perform an interactive login. This may be
useful if you are unsure whether you have stored credentials properly
via <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">remote</span> <span class="pre">login</span></code> or <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span></code>.</p>
via <code class="docutils literal notranslate"><span class="pre">apptainer</span> <span class="pre">registry</span> <span class="pre">login</span></code> or <code class="docutils literal notranslate"><span class="pre">docker</span> <span class="pre">login</span></code>.</p>
<p>OCI registries expect different values for username and password fields.
Some require a token to be generated and used instead of your account
password. Some take a generic username, and rely only on the token to
Expand Down
2 changes: 1 addition & 1 deletion public/docs/user/main/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 66a8b98

Please sign in to comment.