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

cleaning up azure_rm_deployment samples & return value doc #53436

Merged
merged 3 commits into from
Mar 7, 2019

Conversation

zikalino
Copy link
Contributor

@zikalino zikalino commented Mar 7, 2019

SUMMARY

Just some naming conventions, etc.
Added name parameter in every sample
Removed some unnecessary things like subscription_id
Fixed & extended return value documentation

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

azure_rm_deployment

ADDITIONAL INFORMATION

@ansibot
Copy link
Contributor

ansibot commented Mar 7, 2019

@ansibot ansibot added affects_2.8 This issue/PR affects Ansible v2.8 azure cloud community_review In order to be merged, this PR must follow the community review workflow. docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. needs_triage Needs a first human triage before being processed. owner_pr This PR is made by the module's maintainer. support:community This issue/PR relates to code supported by the Ansible community. labels Mar 7, 2019
@mattclay
Copy link
Member

mattclay commented Mar 7, 2019

CI failure in integration tests: https://app.shippable.com/github/ansible/ansible/runs/112336/87/tests

@mattclay mattclay added the ci_verified Changes made in this PR are causing tests to fail. label Mar 7, 2019
@ansibot ansibot added needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. community_review In order to be merged, this PR must follow the community review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_triage Needs a first human triage before being processed. community_review In order to be merged, this PR must follow the community review workflow. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Mar 7, 2019
instances:
description: Provides the public IP addresses for each VM instance.
type: list
returned: always
Copy link
Contributor

Choose a reason for hiding this comment

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

return always? what if my arm template doesn't contain VM?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

well, field is always returned, it may just be empty []

Copy link
Contributor

Choose a reason for hiding this comment

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

it's confusing, such as public ip marked as returned always also.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, the lists are always returned, just may be empty,
maybe we could have:
returned: always but list may be empty

or just
returned when applicable

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I actually think "instances" return value should be made obsolete.
it works only with vms.
if somebody uses ARM templates to deploy anything else than VM it's pretty much useless.
we could think of more universal approach.

Usually outputs should be sufficient to use created resources. For instance for Windows VM, outputs look like:

            "outputs": {
                "hostname": {
                    "type": "String",
                    "value": "zimsdplxxxx.eastus2.cloudapp.azure.com"
                }
            }

So it has sufficient information to use the VM.
Outputs are designed by ARM template authors so it's up to them what's important for the user.

@ansibot ansibot added needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed community_review In order to be merged, this PR must follow the community review workflow. labels Mar 7, 2019
@ansibot ansibot removed the needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html label Mar 7, 2019
@zikalino zikalino merged commit 642f759 into ansible:devel Mar 7, 2019
@zikalino zikalino deleted the deployment-doc-cleanup branch March 7, 2019 05:38
@ansible ansible locked and limited conversation to collaborators Jul 25, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.8 This issue/PR affects Ansible v2.8 azure cloud docs This issue/PR relates to or includes documentation. module This issue/PR relates to a module. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. owner_pr This PR is made by the module's maintainer. support:community This issue/PR relates to code supported by the Ansible community.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants