-
Notifications
You must be signed in to change notification settings - Fork 547
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
[WIP] Unpin rstcheck dependency and update to version 6.x #2344
base: devel
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,7 +18,7 @@ Once installed, you can reference a collection content by its fully qualified co | |
|
||
This works for roles or any type of plugin distributed within the collection: | ||
|
||
.. code-block:: yaml | ||
.. code-block:: ini | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shouldn't this be There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Exactly. |
||
|
||
- name: Reference collections contents using their FQCNs | ||
hosts: all | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -90,7 +90,7 @@ A collection skeleton is a directory that looks like a collection directory but | |
|
||
An example ``galaxy.yml.j2`` file that accepts an optional dictionary variable ``dependencies`` could look like this: | ||
|
||
.. code-block:: yaml | ||
.. code-block:: ini | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this should be |
||
|
||
namespace: {{ namespace }} | ||
name: {{ collection_name }} | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -113,7 +113,7 @@ Be sure to fully understand the security implications of enabling this option. T | |||||
|
||||||
Before running ``ansible-playbook`` run the following commands to enable logging: | ||||||
|
||||||
.. code-block:: text | ||||||
.. code-block:: shell | ||||||
|
||||||
# Specify the location for the log file | ||||||
export ANSIBLE_LOG_PATH=~/ansible.log | ||||||
|
@@ -140,7 +140,7 @@ To make this a global setting, add the following to your ``ansible.cfg`` file: | |||||
|
||||||
or enable the environment variable `ANSIBLE_PERSISTENT_LOG_MESSAGES`: | ||||||
|
||||||
.. code-block:: text | ||||||
.. code-block:: shell | ||||||
|
||||||
# Enable device interaction logging | ||||||
export ANSIBLE_PERSISTENT_LOG_MESSAGES=True | ||||||
|
@@ -168,9 +168,9 @@ For Ansible this can be done by ensuring you are only running against one remote | |||||
|
||||||
`ad hoc` refers to running Ansible to perform some quick command using ``/usr/bin/ansible``, rather than the orchestration language, which is ``/usr/bin/ansible-playbook``. In this case we can ensure connectivity by attempting to execute a single command on the remote device: | ||||||
|
||||||
.. code-block:: text | ||||||
.. code-block:: shell | ||||||
|
||||||
ansible -m arista.eos.eos_command -a 'commands=?' -i inventory switch1.example.net -e 'ansible_connection=ansible.netcommon.network_cli' -u admin -k | ||||||
ansible -m arista.eos.eos_command -a 'commands=?' -i inventory switch1.example.net -e 'ansible_connection=ansible.netcommon.network_cli' -u admin -k | ||||||
|
||||||
In the above example, we: | ||||||
|
||||||
|
@@ -184,7 +184,7 @@ If you have SSH keys configured correctly, you don't need to specify the ``-k`` | |||||
|
||||||
If the connection still fails you can combine it with the enable_network_logging parameter. For example: | ||||||
|
||||||
.. code-block:: text | ||||||
.. code-block:: shell | ||||||
|
||||||
# Specify the location for the log file | ||||||
export ANSIBLE_LOG_PATH=~/ansible.log | ||||||
|
@@ -208,7 +208,7 @@ The ``Socket path does not exist or cannot be found`` and ``Unable to connect t | |||||
|
||||||
For example: | ||||||
|
||||||
.. code-block:: none | ||||||
.. code-block:: json | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
fatal: [spine02]: FAILED! => { | ||||||
"changed": false, | ||||||
|
@@ -221,7 +221,7 @@ For example: | |||||
|
||||||
or | ||||||
|
||||||
.. code-block:: none | ||||||
.. code-block:: json | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
fatal: [spine02]: FAILED! => { | ||||||
"changed": false, | ||||||
|
@@ -240,13 +240,13 @@ Suggestions to resolve: | |||||
|
||||||
If the identified error message from the log file is: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:19:05,670 p=18591 u=fred | command timeout triggered, timeout value is 30 secs | ||||||
|
||||||
or | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:19:05,670 p=18591 u=fred | persistent connection idle timeout triggered, timeout value is 30 secs | ||||||
|
||||||
|
@@ -267,7 +267,7 @@ The ``unable to open shell`` message means that the ``ansible-connection`` daemo | |||||
|
||||||
For example: | ||||||
|
||||||
.. code-block:: none | ||||||
.. code-block:: console | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
TASK [prepare_eos_tests : enable cli on remote device] ************************************************** | ||||||
fatal: [veos01]: FAILED! => {"changed": false, "failed": true, "msg": "unable to open shell"} | ||||||
|
@@ -276,7 +276,7 @@ For example: | |||||
or: | ||||||
|
||||||
|
||||||
.. code-block:: none | ||||||
.. code-block:: console | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
TASK [ios_system : configure name_servers] ************************************************************* | ||||||
task path: | ||||||
|
@@ -303,7 +303,7 @@ Indicates that the remote host you are trying to connect to can not be reached | |||||
|
||||||
For example: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 11:39:48,147 p=15299 u=fred | control socket path is /home/fred/.ansible/pc/ca5960d27a | ||||||
2017-04-04 11:39:48,147 p=15299 u=fred | current working directory is /home/fred/git/ansible-inc/stable-2.3/test/integration | ||||||
|
@@ -332,7 +332,7 @@ Occurs if the credentials (username, passwords, or ssh keys) passed to ``ansible | |||||
|
||||||
For example: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
<ios01> ESTABLISH CONNECTION FOR USER: cisco on PORT 22 TO ios01 | ||||||
<ios01> Authentication failed. | ||||||
|
@@ -342,7 +342,7 @@ Suggestions to resolve: | |||||
|
||||||
If you are specifying credentials through ``password:`` (either directly or through ``provider:``) or the environment variable `ANSIBLE_NET_PASSWORD` it is possible that ``paramiko`` (the Python SSH library that Ansible uses) is using ssh keys, and therefore the credentials you are specifying are being ignored. To find out if this is the case, disable "look for keys". This can be done like this: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: shell | ||||||
|
||||||
export ANSIBLE_PARAMIKO_LOOK_FOR_KEYS=False | ||||||
|
||||||
|
@@ -363,7 +363,7 @@ When using persistent connections with Paramiko, the connection runs in a backgr | |||||
|
||||||
For example: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:06:03,486 p=17981 u=fred | using connection plugin network_cli | ||||||
2017-04-04 12:06:04,680 p=17981 u=fred | connecting to host veos01 returned an error | ||||||
|
@@ -412,7 +412,7 @@ Error: "No authentication methods available" | |||||
|
||||||
For example: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:19:05,670 p=18591 u=fred | creating new control socket for host veos01:None as user admin | ||||||
2017-04-04 12:19:05,670 p=18591 u=fred | control socket path is /home/fred/.ansible/pc/ca5960d27a | ||||||
|
@@ -451,15 +451,15 @@ Persistent connection idle timeout | |||||
|
||||||
By default, ``ANSIBLE_PERSISTENT_CONNECT_TIMEOUT`` is set to 30 (seconds). You may see the following error if this value is too low: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:19:05,670 p=18591 u=fred | persistent connection idle timeout triggered, timeout value is 30 secs | ||||||
|
||||||
Suggestions to resolve: | ||||||
|
||||||
Increase value of persistent connection idle timeout: | ||||||
|
||||||
.. code-block:: sh | ||||||
.. code-block:: shell | ||||||
|
||||||
export ANSIBLE_PERSISTENT_CONNECT_TIMEOUT=60 | ||||||
|
||||||
|
@@ -477,7 +477,7 @@ By default, ``ANSIBLE_PERSISTENT_COMMAND_TIMEOUT`` is set to 30 (seconds). Prior | |||||
You may see the following error if this value is too low: | ||||||
|
||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:19:05,670 p=18591 u=fred | command timeout triggered, timeout value is 30 secs | ||||||
|
||||||
|
@@ -486,7 +486,7 @@ Suggestions to resolve: | |||||
* Option 1 (Global command timeout setting): | ||||||
Increase value of command timeout in configuration file or by setting environment variable. | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: shell | ||||||
|
||||||
export ANSIBLE_PERSISTENT_COMMAND_TIMEOUT=60 | ||||||
|
||||||
|
@@ -510,7 +510,7 @@ Suggestions to resolve: | |||||
Suggestions to resolve: | ||||||
|
||||||
Some modules support a ``timeout`` option, which is different to the ``timeout`` keyword for tasks. | ||||||
|
||||||
.. code-block:: yaml | ||||||
|
||||||
- name: save running-config | ||||||
|
@@ -521,7 +521,7 @@ Suggestions to resolve: | |||||
|
||||||
|
||||||
Suggestions to resolve: | ||||||
|
||||||
If the module does not support the ``timeout`` option directly, most networking connection plugins can enable similar functionality with the ``ansible_command_timeout`` variable. | ||||||
|
||||||
.. code-block:: yaml | ||||||
|
@@ -543,7 +543,7 @@ Persistent connection retry timeout | |||||
|
||||||
By default, ``ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT`` is set to 15 (seconds). You may see the following error if this value is too low: | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: text | ||||||
|
||||||
2017-04-04 12:19:35,708 p=18591 u=fred | connect retry timeout expired, unable to connect to control socket | ||||||
2017-04-04 12:19:35,709 p=18591 u=fred | persistent_connect_retry_timeout is 15 secs | ||||||
|
@@ -555,7 +555,7 @@ Note: This value should be greater than the SSH timeout value (the timeout value | |||||
section in the configuration file) and less than the value of the persistent | ||||||
connection idle timeout (connect_timeout). | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: shell | ||||||
|
||||||
export ANSIBLE_PERSISTENT_CONNECT_RETRY_TIMEOUT=30 | ||||||
|
||||||
|
@@ -668,7 +668,7 @@ network device by first connecting to the host specified in | |||||
|
||||||
You can also set the proxy target for all hosts by using environment variables. | ||||||
|
||||||
.. code-block:: sh | ||||||
.. code-block:: shell | ||||||
|
||||||
export ANSIBLE_SSH_ARGS='-o ProxyCommand="ssh -W %h:%p -q bastion01"' | ||||||
|
||||||
|
@@ -693,7 +693,7 @@ from the given custom ssh file path | |||||
Example ssh config file (~/.ssh/config) | ||||||
--------------------------------------- | ||||||
|
||||||
.. code-block:: ini | ||||||
.. code-block:: shell | ||||||
|
||||||
Host jumphost | ||||||
HostName jumphost.domain.name.com | ||||||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -53,7 +53,7 @@ The following table shows an example of how an initial resource configuration ch | |||||
+-----------------------------------------+------------------------------------+-----------------------------------------+ | ||||||
| Resource starting configuration | task-provided configuration (YAML) | Final resource configuration on device | | ||||||
+=========================================+====================================+=========================================+ | ||||||
| .. code-block:: text | .. code-block:: yaml | *merged* | | ||||||
| .. code-block:: text | .. code-block:: ini | *merged* | | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Avoid trailing whitespaces. Also, it's not ini, just like in many places Felix marked.
Suggested change
|
||||||
| | | .. code-block:: text | | ||||||
| interface loopback100 | config: | | | ||||||
| ip address 10.10.1.100 255.255.255.0 | - ipv6: | interface loopback100 | | ||||||
|
@@ -88,7 +88,7 @@ Network resource modules return the following details: | |||||
* The *after* state - the new resource configuration that exists on the network device after the task was executed. | ||||||
* Commands - any commands configured on the device. | ||||||
|
||||||
.. code-block:: yaml | ||||||
.. code-block:: ini | ||||||
|
||||||
ok: [nxos101] => | ||||||
result: | ||||||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not really
console
. Console is for snippets copied from terminal output, featuring a prompt followed by its command and then the output.