diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 12:04:41 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-13 12:04:41 +0000 |
commit | 975f66f2eebe9dadba04f275774d4ab83f74cf25 (patch) | |
tree | 89bd26a93aaae6a25749145b7e4bca4a1e75b2be /ansible_collections/community/okd/docs/community.okd.oc_connection.rst | |
parent | Initial commit. (diff) | |
download | ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.tar.xz ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.zip |
Adding upstream version 7.7.0+dfsg.upstream/7.7.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/community/okd/docs/community.okd.oc_connection.rst')
-rw-r--r-- | ansible_collections/community/okd/docs/community.okd.oc_connection.rst | 315 |
1 files changed, 315 insertions, 0 deletions
diff --git a/ansible_collections/community/okd/docs/community.okd.oc_connection.rst b/ansible_collections/community/okd/docs/community.okd.oc_connection.rst new file mode 100644 index 000000000..14f2477cc --- /dev/null +++ b/ansible_collections/community/okd/docs/community.okd.oc_connection.rst @@ -0,0 +1,315 @@ +.. _community.okd.oc_connection: + + +**************** +community.okd.oc +**************** + +**Execute tasks in pods running on OpenShift.** + + + +.. contents:: + :local: + :depth: 1 + + +Synopsis +-------- +- Use the oc exec command to run tasks in, or put/fetch files to, pods running on the OpenShift container platform. + + + +Requirements +------------ +The below requirements are needed on the local Ansible controller node that executes this connection. + +- oc (go binary) + + +Parameters +---------- + +.. raw:: html + + <table border=0 cellpadding=0 class="documentation-table"> + <tr> + <th colspan="1">Parameter</th> + <th>Choices/<font color="blue">Defaults</font></th> + <th>Configuration</th> + <th width="100%">Comments</th> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>ca_cert</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_SSL_CA_CERT</div> + <div>var: ansible_oc_ssl_ca_cert</div> + <div>var: ansible_oc_ca_cert</div> + </td> + <td> + <div>Path to a CA certificate used to authenticate with the API.</div> + <div style="font-size: small; color: darkgreen"><br/>aliases: oc_ssl_ca_cert</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>client_cert</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_CERT_FILE</div> + <div>var: ansible_oc_cert_file</div> + <div>var: ansible_oc_client_cert</div> + </td> + <td> + <div>Path to a certificate used to authenticate with the API.</div> + <div style="font-size: small; color: darkgreen"><br/>aliases: oc_cert_file</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>client_key</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_KEY_FILE</div> + <div>var: ansible_oc_key_file</div> + <div>var: ansible_oc_client_key</div> + </td> + <td> + <div>Path to a key file used to authenticate with the API.</div> + <div style="font-size: small; color: darkgreen"><br/>aliases: oc_key_file</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_container</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_CONTAINER</div> + <div>var: ansible_oc_container</div> + </td> + <td> + <div>Container name. Required when a pod contains more than one container.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_context</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_CONTEXT</div> + <div>var: ansible_oc_context</div> + </td> + <td> + <div>The name of a context found in the K8s config file.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_extra_args</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_EXTRA_ARGS</div> + <div>var: ansible_oc_extra_args</div> + </td> + <td> + <div>Extra arguments to pass to the oc command line.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_host</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_HOST</div> + <div>env:K8S_AUTH_SERVER</div> + <div>var: ansible_oc_host</div> + <div>var: ansible_oc_server</div> + </td> + <td> + <div>URL for accessing the API.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_kubeconfig</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_KUBECONFIG</div> + <div>var: ansible_oc_kubeconfig</div> + <div>var: ansible_oc_config</div> + </td> + <td> + <div>Path to a oc config file. Defaults to <em>~/.kube/config</em></div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_namespace</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_NAMESPACE</div> + <div>var: ansible_oc_namespace</div> + </td> + <td> + <div>The namespace of the pod</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_pod</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_POD</div> + <div>var: ansible_oc_pod</div> + </td> + <td> + <div>Pod name. Required when the host name does not match pod name.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>oc_token</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + </td> + <td> + <div>env:K8S_AUTH_TOKEN</div> + <div>env:K8S_AUTH_API_KEY</div> + <div>var: ansible_oc_token</div> + <div>var: ansible_oc_api_key</div> + </td> + <td> + <div>API authentication bearer token.</div> + </td> + </tr> + <tr> + <td colspan="1"> + <div class="ansibleOptionAnchor" id="parameter-"></div> + <b>validate_certs</b> + <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a> + <div style="font-size: small"> + <span style="color: purple">-</span> + </div> + </td> + <td> + <b>Default:</b><br/><div style="color: blue">""</div> + </td> + <td> + <div>env:K8S_AUTH_VERIFY_SSL</div> + <div>var: ansible_oc_verify_ssl</div> + <div>var: ansible_oc_validate_certs</div> + </td> + <td> + <div>Whether or not to verify the API server's SSL certificate. Defaults to <em>true</em>.</div> + <div style="font-size: small; color: darkgreen"><br/>aliases: oc_verify_ssl</div> + </td> + </tr> + </table> + <br/> + + + + + + + + +Status +------ + + +Authors +~~~~~~~ + +- xuxinkun + + +.. hint:: + Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up. |