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.

Sign up for GitHub

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

Bugfix/info datacenters in documentation #118

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
+8 −0
Open

Bugfix/info datacenters in documentation #118

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eedcd5f
added info_datacenters documentation
OrrBG Dec 22, 2024
089d77a
added info_datacenters changelog
OrrBG Dec 22, 2024
35bbb20
Changed confusing description
OrrBG Dec 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelogs/118-bugfix-info_datacenters-in-documentation
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think this file should be added to "changelogs/fragments/", not to "changelogs" itself.

Copy link
Collaborator

Choose a reason for hiding this comment

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

also missing the .yml extension

minor_changes:
- info - added info_datacenters var in documentation to info role
5 changes: 5 additions & 0 deletions roles/info/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ An abbreviated example of the data returned can be found below:
- File where to store the gathered data. Default is `/tmp/vmware_ops_info_cluster`
- If set to an empty string, the data is not written to a file.

- **info_datacenters** (list(str))
- A list of datacenter names used to specify the clusters for which to gather information.
- If this variable is not set, information on all vSphere vCenter clusters is gathered (TODO: is this correct?)
Copy link
Collaborator

Choose a reason for hiding this comment

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

your right but the phrasing is a little confusing. maybe like
"A list of datacenter names that will be searched when gathering information about clusters."
"If this variable is not set, information on all vSphere vCenter clusters in all datacenters is gathered"


### Storage

- **info_storage** (bool)
Expand Down Expand Up @@ -192,6 +196,7 @@ An abbreviated example of the data returned can be found below:
info_license: true
info_storage: true
info_appliance: true
info_datacenters: ["datacenter1", "datacenter2"]

roles:
- role: cloud.vmware_ops.info
Expand Down
Loading