Skip to content

Adding sections for new terraform config#1147

Merged
ianf77 merged 5 commits into
ansible:mainfrom
EMcWhinn:ACA-1187
May 9, 2024
Merged

Adding sections for new terraform config#1147
ianf77 merged 5 commits into
ansible:mainfrom
EMcWhinn:ACA-1187

Conversation

@EMcWhinn

Copy link
Copy Markdown
Contributor

Create product docs for terraform-provider-aap

https://issues.redhat.com/browse/ACA-1187

Affects controller-user-guide

@EMcWhinn EMcWhinn added documentation Improvements or additions to documentation Controller Content applies to automation controller 2.5 Content applies to AAP 2.5 labels Mar 21, 2024
@EMcWhinn EMcWhinn marked this pull request as draft March 21, 2024 10:06
@EMcWhinn EMcWhinn marked this pull request as ready for review April 2, 2024 13:20
@EMcWhinn EMcWhinn marked this pull request as draft April 2, 2024 13:20
@EMcWhinn EMcWhinn marked this pull request as ready for review April 3, 2024 08:48
. From the navigation panel, select {MenuAEProjects}.
. On the *Projects* page, click btn:[Create project] to start the *Create Project* window.
** Enter the appropriate details according to the steps in xref:proc-controller-adding-a-project[Adding a new project].
** Use the configuration files at link:https://github.com/hakbailey/terraform-aap-demo[terraform-aap-demo].

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We probably don't want to link to my personal repo here. Which configuration files are being referenced?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Removed this sub-step.

+
//The current 2.5 test environment does not have the following option yet:
. Select an *Execution Environment* that has a Terraform binary.
This is required for the inventory plugin to run the Terraform commands that read inventory data from the Terraform state file.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

We could optionally link here to the example terraform EE configuration repo: https://github.com/ansible-cloud/terraform_ee

.Additional resources
For more information, see the link:https://github.com/ansible-cloud/terraform_ee[Terraform EE] readme that has an example {ExecEnvShort} configuration with a Terraform binary.

== Terraform provider for {PlatformNameShort}

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@hakbailey I've added a sub-section here for the Terraform provider, does this work? And are there steps I can grab from somewhere to document here?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think rather than providing steps here we likely just want to say something along the lines of "Inventories and hosts can also be created within Terraform configuration using the Terraform provider for AAP." and then link to the provider documentation. Ultimately that will live in the Terraform Provider registry but since we haven't published the initial release yet, we may need to just link to the Github repo. @gravesm thoughts or anything to add?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Got it, thanks @hakbailey.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I believe we should have docs we can link to on the Hashi registry in ~2 weeks. I'm not sure what the timing looks like for docs publishing for AAP. If possible, I think pausing this for a couple weeks until we have the official provider docs published that we can link to would be best.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Thanks @gravesm, docs hardening is June 4th - June 18th (2 wks) with publishing on June 18th, so ~2 weeks to confirm the docs here should be fine.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Provider has been released! Here's the official docs link: https://registry.terraform.io/providers/ansible/aap/latest/docs

sayjadha pushed a commit to sayjadha/aap-docs that referenced this pull request Apr 23, 2024
* Fixed icon size (ansible#1147)

* Fixed icon size

Changed size to 10,25

https://issues.redhat.com/browse/AAP-13667

* Fixed icon size

Removed git artifact

Duplicated content and unscaled icons need fixing

https://issues.redhat.com/browse/AAP-13667
Inventories created this way are managed by Terraform and you must not edit them in {PlatformNameShort} as it can introduce drift to the Terraform deployment.

You can create inventories and hosts within the Terraform configuration by using the Terraform provider for {PlatformNameShort}.
For more information, see the link:https://registry.terraform.io/providers/ansible/aap/latest/docs[AAP Provider] section of the Terraform documentation.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Great thanks @hakbailey, I've added the info. Does it all look good to you?

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Looks great!

@ianf77 ianf77 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@ianf77 ianf77 merged commit 82bd6c1 into ansible:main May 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

2.5 Content applies to AAP 2.5 Controller Content applies to automation controller documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants