Move inventory and credential plugins docs to `awx-plugins` #27

tvo318 · 2024-09-04T04:14:17Z

Moved credential plugins and inventory plugins (inventory source) chapters from the awx user guide.

Previews:

kubectl and synchronize are now part of community.kubernetes and ansible.posix collections, respectively. This change installs these collections to a local directory to be used in inventory and isolated management playbooks. awx issue #6930

Vendor collections for isolated jobs to work in ansible 2.10 Reviewed-by: https://github.com/apps/softwarefactory-project-zuul

Remove inventory-related docs which are outdated or wrong SUMMARY Around 10% of this is updating docs for #9822 The rest of it is updating for changes that took place long ago, but docs still has stuff which is now wrong. ISSUE TYPE Docs Pull Request COMPONENT NAME API Reviewed-by: Chris Meyers <None>

Downstream fixes Reviewed-by: Rebeccah Hunter <[email protected]> Reviewed-by: Alan Rominger <[email protected]> Reviewed-by: Tiago Góes <[email protected]> Reviewed-by: Christian Adams <[email protected]>

- Made the choice not to pull in the CI tools due to the possibility of it blocking PRs. Co-Authored By: Lila Yasin <[email protected]>

Co-authored-by: Thanhnguyet Vo <[email protected]> Co-authored-by: TVo <[email protected]>

Signed-off-by: maskboyAvi <[email protected]>

…s.rst (#14527) Signed-off-by: maskboyAvi <[email protected]> Co-authored-by: Don Naro <[email protected]>

* Add TLS certificate auth for HashiCorp Vault Add support for AWX to authenticate with HashiCorp Vault using TLS client certificates. Also updates the documentation for the HashiCorp Vault secret management plugins to include both the new TLS options and the missing Kubernetes auth method options. Signed-off-by: Andrew Austin <[email protected]> * Refactor docker-compose vault for TLS cert auth Add TLS configuration to the docker-compose Vault configuration and use that method by default in vault plumbing. This ensures that the result of bringing up the docker-compose stack with vault enabled and running the plumb-vault playbook is a fully working credential retrieval setup using TLS client cert authentication. Signed-off-by: Andrew Austin <[email protected]> * Remove incorrect trailing space Co-authored-by: Hao Liu <[email protected]> * Make vault init idempotent - improve error handling for vault_initialization - ignore error if vault cert auth is already configured - removed unused register * Add VAULT_TLS option Make TLS for HashiCorp Vault optional and configurable via VAULT_TLS env var * Add retries for vault init Sometime it took longer for vault to fully come up and init will fail --------- Signed-off-by: Andrew Austin <[email protected]> Co-authored-by: Hao Liu <[email protected]> Co-authored-by: Hao Liu <[email protected]>

…#14654) * Add username and password to handle_auth and update exception message Revise naming of ldap username and password * Add url for LDAP and userpass to method_auth * Add information regarding LDAP and username and password to credential plugins documentation Revise ldap_auth to userpass_auth and revised exception to better reflect functionality * Revise method_auth to ensure certs can be used with username and ensure namespace functionality is not hindered

@thedoubl3j

* Added LDAP support for HashiCorp Vault lookup credential * Added LDAP support for HashiCorp Vault lookup credential * Replaced graphics and updated missing fields. * Added LDAP support for HashiCorp Vault lookup credential * Replaced graphics and updated missing fields. * Incorporated review feedback from @thedoubl3j and @djyasin.

* Added docs for terraform credential/inventory source * Updated screen captures for inventories and source to match wfjt example * Added docs for terraform credential/inventory source * Updated screen captures for inventories and source to match wfjt example * Update docs/docsite/rst/userguide/inventories.rst Co-authored-by: Aoki <[email protected]> * Revised per review feedback. * Update docs/docsite/rst/userguide/inventories.rst Co-authored-by: Helen Bailey <[email protected]> --------- Co-authored-by: Aoki <[email protected]> Co-authored-by: Helen Bailey <[email protected]>

* Backports previously approved corrections. * Deleted a blank line in inventories line 100

fix link to terraform_state inventory plugin

@fosterseth

* Added new OpenShift Virtualization inventory source to docs. * Incorporated review feedback from @fosterseth and @TheRealHaoLiu. * Fixed link to correct kubevirt.core.kubevirt documentation.

@oraNod

* Replaced all references of downstream docs to upstream docs. * Update README.md Co-authored-by: Don Naro <[email protected]> * Update README.md.j2 Co-authored-by: Don Naro <[email protected]> * Update README.md.j2 Co-authored-by: Don Naro <[email protected]> * Incorpor'd review feedback from @oraNod and @samccann * Updated with agreed link (for now) until further change is needed. --------- Co-authored-by: Don Naro <[email protected]>

.obsidian/app.json

docs/index.md

docs/contributing/communication.md

docs/inventory-plugins-templates.rst

webknjaz · 2024-09-04T11:11:15Z

It occurred to me that it might be a good idea to preserve some of that Git history related to the moved files. I'll see if that's possible.

.gitignore

samccann · 2024-09-04T18:35:13Z

Some files are .md and some are rst - What is the ultimate plan for docs in this repo?

webknjaz · 2024-09-04T22:14:22Z

Some files are .md and some are rst - What is the ultimate plan for docs in this repo?

@samccann I integrated MyST-parser from the very beginning. So the infrastructure supports both MyST markdown and RST. This means that we don't have to choose one or the other and both can co-exist very well. If a contributor decides to submit a Markdown document, there is no compromise on the functionality. Yet, we can keep using RST where it feels right or if we already have pre-existing documents.

chrismeyersfsu · 2024-09-09T14:19:56Z

Content looks good to me.

…into-devel

samccann · 2024-09-11T14:42:46Z

my recommendation is to remove these files from the docs build. We don't yet know how it all applies, so I would err on the side of keeping them in the repo only and not part of the awx-plugin docsite for now.

They're being moved from `awx` to `awx-plugins`. Co-authored-by: Sviatoslav Sydorenko <[email protected]>

webknjaz · 2024-09-11T14:49:09Z

@samccann I don't think it's a good idea to keep files that do nothing and aren't linted lying around in the repo. We can remove them later if that's what's needed.

webknjaz · 2024-09-11T14:51:19Z

FTR here's like this bit of history got grafted into the existing Git tree: https://asciinema.org/a/675613.

samccann · 2024-09-11T14:59:23Z

@webknjaz - I disagree. Your repo, your rules, but surfacing user documentation when we haven't decided whether there will be any gui-based user docs in this repo seems misleading imo.

tvo318 · 2024-09-11T15:25:03Z

@samccann - we aren't announcing this repo yet, as far as I know. We are still telling the community this is in transition and is subject to change. Right now, the focus is to move content from the awx repo. This is accomplished by this PR. We will open a new PR to clean up this content once we know more about how these plugins are supported (UI, API, etc). In the meantime, we will have it in place so making updates to the docs will be a lot easier.

webknjaz · 2024-09-11T16:14:05Z

@samccann I hear you, I was just pointing out that the PR wouldn't even be mergeable without integrations. Also, if the content shouldn't be here, it should be deleted rather than remain in the repo. That's someone else's call, though.

beeankha and others added 22 commits September 20, 2019 11:32

More AWX docs edits

d15f451

Add feature docs and document development tooling

a16553b

Merge pull request #6949 from fosterseth/install-collections-isolated

ba5bf61

Vendor collections for isolated jobs to work in ansible 2.10 Reviewed-by: https://github.com/apps/softwarefactory-project-zuul

Remove inventory-related docs which are outdated or wrong

94243ff

Rename managed_by_tower to managed

a167c6a

Merge pull request #10490 from shanemcd/downstream-fixes

79ab0c8

Downstream fixes Reviewed-by: Rebeccah Hunter <[email protected]> Reviewed-by: Alan Rominger <[email protected]> Reviewed-by: Tiago Góes <[email protected]> Reviewed-by: Christian Adams <[email protected]>

Spelling and codespelling corrections from community PR

3fb8b25

- Made the choice not to pull in the CI tools due to the possibility of it blocking PRs. Co-Authored By: Lila Yasin <[email protected]>

Create AWX docsite with RST content (#14328)

21ed7c5

Co-authored-by: Thanhnguyet Vo <[email protected]> Co-authored-by: TVo <[email protected]>

Fix : #14490 Fixed the required spelling errors (#14507)

f2d6d8e

Signed-off-by: maskboyAvi <[email protected]>

Fix: #14500 Added alt text to images for Userguide: credential_plugin…

d25246c

…s.rst (#14527) Signed-off-by: maskboyAvi <[email protected]> Co-authored-by: Don Naro <[email protected]>

Added missing AWS secret management lookup creds.

395cd8d

Backports previously approved corrections. (#15121)

a041c5b

* Backports previously approved corrections. * Deleted a blank line in inventories line 100

Modify the link to terraform_state inventory plugin (#15241)

a149e13

fix link to terraform_state inventory plugin

Added new OpenShift Virtualization inventory source to docs. (#15299)

e7b248b

* Added new OpenShift Virtualization inventory source to docs. * Incorporated review feedback from @fosterseth and @TheRealHaoLiu. * Fixed link to correct kubevirt.core.kubevirt documentation.

Re-do PR #14685 for alt-text inventories. (#15394)

16c7f46

tvo318 requested review from webknjaz and chrismeyersfsu September 4, 2024 04:15

webknjaz changed the title ~~Moved inventory and credential plugins docs to awx-plugins.~~ Move inventory and credential plugins docs to awx-plugins Sep 4, 2024