-
Notifications
You must be signed in to change notification settings - Fork 400
connection/aws_ssm - add caching and caching_ttl options to improve velocity #2278
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
base: main
Are you sure you want to change the base?
Conversation
Docs Build 📝Thank you for contribution!✨ The docsite for this PR is available for download as an artifact from this run: You can compare to the docs for the File changes:
Click to see the diff comparison.NOTE: only file modifications are shown here. New and deleted files are excluded. diff --git a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/aws_ssm_connection.html b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/aws_ssm_connection.html
index b62a732..3597fcc 100644
--- a/home/runner/work/community.aws/community.aws/docsbuild/base/collections/community/aws/aws_ssm_connection.html
+++ b/home/runner/work/community.aws/community.aws/docsbuild/head/collections/community/aws/aws_ssm_connection.html
@@ -245,6 +245,36 @@ see <a class="reference internal" href="#ansible-collections-community-aws-aws-s
</div></td>
</tr>
<tr class="row-odd"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-caching"></div><p class="ansible-option-title" id="ansible-collections-community-aws-aws-ssm-connection-parameter-caching"><strong>caching</strong></p>
+<a class="ansibleOptionLink" href="#parameter-caching" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">boolean</span></p>
+<p><em class="ansible-option-versionadded">added in community.aws 10.0.0</em></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The plugin will create a daemon starting a shell session to handle all command sent to the managed host.</p>
+<p class="ansible-option-line"><strong class="ansible-option-choices">Choices:</strong></p>
+<ul class="simple">
+<li><p><code class="ansible-option-default-bold docutils literal notranslate"><strong><span class="pre">false</span></strong></code> <span class="ansible-option-choices-default-mark">← (default)</span></p></li>
+<li><p><code class="ansible-option-choices-entry docutils literal notranslate"><span class="pre">true</span></code></p></li>
+</ul>
+<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
+<ul class="simple">
+<li><p>Variable: ansible_aws_ssm_caching</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-even"><td><div class="ansible-option-cell">
+<div class="ansibleOptionAnchor" id="parameter-caching_ttl"></div><p class="ansible-option-title" id="ansible-collections-community-aws-aws-ssm-connection-parameter-caching-ttl"><strong>caching_ttl</strong></p>
+<a class="ansibleOptionLink" href="#parameter-caching_ttl" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">integer</span></p>
+<p><em class="ansible-option-versionadded">added in community.aws 10.0.0</em></p>
+</div></td>
+<td><div class="ansible-option-cell"><p>The time (in seconds) the daemon will wait before exit when there is no incoming request.</p>
+<p class="ansible-option-line"><strong class="ansible-option-default-bold">Default:</strong> <code class="ansible-option-default docutils literal notranslate"><span class="pre">30</span></code></p>
+<p class="ansible-option-line"><strong class="ansible-option-configuration">Configuration:</strong></p>
+<ul class="simple">
+<li><p>Variable: ansible_aws_ssm_caching_ttl</p></li>
+</ul>
+</div></td>
+</tr>
+<tr class="row-odd"><td><div class="ansible-option-cell">
<div class="ansibleOptionAnchor" id="parameter-instance_id"></div><p class="ansible-option-title" id="ansible-collections-community-aws-aws-ssm-connection-parameter-instance-id"><strong>instance_id</strong></p>
<a class="ansibleOptionLink" href="#parameter-instance_id" title="Permalink to this option"></a><p class="ansible-option-type-line"><span class="ansible-option-type">string</span></p>
</div></td>
|
Build succeeded. ❌ ansible-galaxy-importer FAILURE in 5m 08s (non-voting) |
SUMMARY
The new options
ansible_aws_ssm_caching
andansible_aws_ssm_caching_ttl
will help improve the velocity of theconnection/aws_ssm
plugin.When
ansible_aws_ssm_caching=True
, the connection plugin will start a daemon with an SSM session that will be used for the allocatedansible_aws_ssm_caching_ttl
time to handle all commands to the EC2 managed node.This avoids setting a new session (along with the prepare_terminal steps) for each new command.
ISSUE TYPE
COMPONENT NAME
connection/aws_ssm