Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix anchor reference for setup_remote_docker link #41

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p>Although only Docker commands are <em>automatically</em> executed in the remote Docker environment, you can programmatically execute <em>any</em> set of commands in the remote Docker environment by SSHing into it and chaining any subsequent commands to your shell command.</p>
<p> </p>
<p>To SSH into the remote Docker environment, run <code>ssh remote-docker</code> while SSH'd into any CircleCI job that uses <a href="https://circleci.com/docs/2.0/configuration-reference/#setup_remote_docker" target="_self"><code>setup_remote_docker</code></a> or execute it programmatically in a <code>run</code> step. (Make sure the <code>setup_remote_docker</code> step runs first, otherwise, your SSH command will fail!)</p>
<p>To SSH into the remote Docker environment, run <code>ssh remote-docker</code> while SSH'd into any CircleCI job that uses <a href="https://circleci.com/docs/configuration-reference#setupremotedocker" target="_self"><code>setup_remote_docker</code></a> or execute it programmatically in a <code>run</code> step. (Make sure the <code>setup_remote_docker</code> step runs first, otherwise, your SSH command will fail!)</p>
<p>Chaining a command to this SSH command in a headless fashion, i.e., as part of your CircleCI job, could look something like:</p>
<pre><code>run: |
ssh remote-docker \ echo "this echo command will be executed in the remote Docker environment \ <br> rather than the initial job container itself"
Expand All @@ -11,4 +11,4 @@
<p><a href="https://stackoverflow.com/questions/4412238/what-is-the-cleanest-way-to-ssh-and-run-multiple-commands-in-bash" rel="nofollow">https://stackoverflow.com/questions/4412238/what-is-the-cleanest-way-to-ssh-and-run-multiple-commands-in-bash</a></p>
<p>These suggestions include <a href="http://tldp.org/LDP/abs/html/here-docs.html" rel="nofollow">using a "here document"</a> or save your commands to a shell script which you then pipe into your <code>ssh</code> command.</p>
<p>If you are using remote-docker commands to update your Docker storage driver, please checkout this helpful thread in our forum:</p>
<p><a href="https://discuss.circleci.com/t/changing-docker-storage-driver/36494/2" rel="noreferrer">https://discuss.circleci.com/t/changing-docker-storage-driver/36494/2</a></p>
<p><a href="https://discuss.circleci.com/t/changing-docker-storage-driver/36494/2" rel="noreferrer">https://discuss.circleci.com/t/changing-docker-storage-driver/36494/2</a></p>