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

o*: style adjustments #9526

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jan 4, 2025

SUMMARY

Second round of doc adjustments. Output width has been slightly reduced in andebox, and a couple of other style improvements have been added (like replacing id with ID)

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/modules/ocapi_command.py
plugins/modules/ocapi_info.py
plugins/modules/oci_vcn.py
plugins/modules/office_365_connector_card.py
plugins/modules/ohai.py
plugins/modules/one_host.py
plugins/modules/one_image.py
plugins/modules/one_image_info.py
plugins/modules/one_service.py
plugins/modules/one_template.py
plugins/modules/one_vm.py
plugins/modules/one_vnet.py
plugins/modules/oneandone_firewall_policy.py
plugins/modules/oneandone_load_balancer.py
plugins/modules/oneandone_monitoring_policy.py
plugins/modules/oneandone_server.py
plugins/modules/onepassword_info.py
plugins/modules/oneview_datacenter_info.py
plugins/modules/oneview_enclosure_info.py
plugins/modules/oneview_ethernet_network_info.py
plugins/modules/oneview_logical_interconnect_group.py
plugins/modules/oneview_network_set_info.py
plugins/modules/oneview_san_manager.py
plugins/modules/open_iscsi.py
plugins/modules/openbsd_pkg.py
plugins/modules/opendj_backendprop.py
plugins/modules/openwrt_init.py
plugins/modules/opkg.py
plugins/modules/osx_defaults.py
plugins/modules/ovh_ip_failover.py
plugins/modules/ovh_ip_loadbalancing_backend.py

@ansibullbot ansibullbot added docs module module plugins plugin (any type) labels Jan 4, 2025
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Jan 4, 2025
plugins/modules/office_365_connector_card.py Outdated Show resolved Hide resolved
plugins/modules/one_vm.py Outdated Show resolved Hide resolved
plugins/modules/one_vm.py Outdated Show resolved Hide resolved
plugins/modules/openbsd_pkg.py Outdated Show resolved Hide resolved
for details.
- Wait for the instance to reach its desired state before returning. Keep in mind if you are waiting for instance to
be in running state it does not mean that you will be able to SSH on that machine only that boot process have started
on that instance. See the example using the M(ansible.builtin.wait_for_instance) for details.
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
on that instance. See the example using the M(ansible.builtin.wait_for_instance) for details.
on that instance. See the example using the M(ansible.builtin.wait_for) for details.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no example using wait_for. There is only one using wait_for_instance. So I guess the example needs to be fixed as well.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe you mean this one:

- name: Wait for SSH to come up
  ansible.builtin.wait_for_connection:
  delegate_to: '{{ vm.instances[0].networks[0].ip }}'

Which should be, in theory, if not in practice:

- name: Wait for SSH to come up
  ansible.builtin.wait_for:
    port: 22  # it says SSH ^
    host: '{{ vm.instances[0].networks[0].ip }}'  # ??? not sure

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, I meant that one.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The right form is probably:

- name: Wait for SSH to come up
  ansible.builtin.wait_for:
  delegate_to: '{{ vm.instances[0].networks[0].ip }}'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch check-before-release PR will be looked at again shortly before release and merged if possible. docs module module plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants