-
Notifications
You must be signed in to change notification settings - Fork 55
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
feat(terraform): create detailed documentation #2323
Conversation
Aaron-Ritter
commented
Jul 15, 2023
•
edited by alex-fusionauth
Loading
edited by alex-fusionauth
- This solves Terraform example #2213 by addressing Terraform Initialisation, Management of existing Resources (Import, Data Source), Creation, Update, Removal
- Delivers some insights in how certain scenarios, resources and attributes need to be handled in context of FusionAuth and Terraform
- Restructures admin-guide/configuration-management
- To see the specific tasks where the Asana app for GitHub is being used, see below:
- https://app.asana.com/0/0/1205281000171133
…d move some details in to terraform
- added configuration strategies table overview - added subject to change - added lifecycle ignore_changes to update section - reformat all source sections with same indents
- Terraform Remove - Terraform Destroy - Indentation - Provider Version
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
General comments:
- use you instead of we
- run through a google docs english spell and grammar checker. that will catch some typos
- check objects are capitalized (Tenant, Application) if they are referring to FusionAuth configuration.
- it isn't not super useful to have a list of docs each time in the forum example. Maybe say something like 'you probably want to have the provider documentation open so you can consult it for the various properties.
- no need to use
link:
on any absolute links - is this in a example repo. If not, can you please create one and have all the example HCL pulled from it?
site/docs/v1/tech/admin-guide/configuration-management/index.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
site/docs/v1/tech/admin-guide/configuration-management/terraform.adoc
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
General feedback:
- use you instead of we
- run through a google docs english spell and grammar checker which will catch typos
- check objects are capitalized (Tenant, Application) when referring to FusionAuth configuration (as opposed to a web application, etc)
- not super useful to have a list of docs each time in the forum example. Maybe say something like 'you probably want to have the provider documentation open so you can consult it for the various properties'.
- no need to use
link:
on any absolute links - is this in a example repo. If not, can we add it and pull in the code examples using a remote include?
# Conflicts: # site/_layouts/doc.liquid
Please let me know when this is ready for re-review, @Aaron-Ritter . |
How is this going, @Aaron-Ritter ? |
@mooreds I am on track with your review suggestions. And we streamlined the language model and spellchecking in our IDEs. As discussed, while creating the example repo I was using https://www.terraform-best-practices.com/examples/terraform/small-size-infrastructure for the examples. Based on that I introduce input variables and sensitive input variables, especially with the API key having a lot if not often all of the permissions. In addition I add a example script on how to manipulate application data, to practically show the A very simple stage/prod example is something I will look in to once the other examples are completed. I plan to finish this weekend. |
Thanks for the update @Aaron-Ritter ! |
@Aaron-Ritter when do you think this will be done? |
# Conflicts: # site/_layouts/doc.liquid
…dd missing commas
@mooreds it is again ready for review and the example repository is available at https://github.com/sonderformat-llc/fusionauth-terraform-examples The missing API Key Screenshot will be added on Monday. |
Looking forward to this lovely doc PR. Thanks a lot @mooreds and @Aaron-Ritter for the invaluable doc, I just wanna add the point that it is really a pity to not be able to configure a fusionauth instance purely with terraform. Although have no idea if this is intentional. |
Closing under #2691 |