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

feat(terraform): create detailed documentation #2323

Closed
wants to merge 40 commits into from

Conversation

Aaron-Ritter
Copy link
Collaborator

@Aaron-Ritter Aaron-Ritter commented Jul 15, 2023

  • 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

@mooreds mooreds added the content large piece of content label Jul 26, 2023
Copy link
Contributor

@mooreds mooreds left a 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?

Copy link
Contributor

@mooreds mooreds left a 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?

@mooreds
Copy link
Contributor

mooreds commented Aug 18, 2023

Please let me know when this is ready for re-review, @Aaron-Ritter .

@mooreds
Copy link
Contributor

mooreds commented Sep 11, 2023

How is this going, @Aaron-Ritter ?

@Aaron-Ritter
Copy link
Collaborator Author

@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 ignore_changes example.

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.

@mooreds
Copy link
Contributor

mooreds commented Sep 15, 2023

Thanks for the update @Aaron-Ritter !

@mooreds
Copy link
Contributor

mooreds commented Sep 23, 2023

@Aaron-Ritter when do you think this will be done?

@Aaron-Ritter
Copy link
Collaborator Author

@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.

@kasir-barati
Copy link

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.

@mooreds
Copy link
Contributor

mooreds commented Nov 21, 2023

Closing under #2691

@mooreds mooreds closed this Nov 21, 2023
@Aaron-Ritter Aaron-Ritter deleted the terraform branch February 28, 2024 13:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content large piece of content
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants