-
Notifications
You must be signed in to change notification settings - Fork 617
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
doc: add terraform instructions to public cloud platforms in aws, azure and gcp #10376
base: main
Are you sure you want to change the base?
Conversation
@@ -0,0 +1,67 @@ | |||
# How to Deploy Talos Cluster in Public Cloud Platforms | |||
|
|||
In his guide, we will learn how to deploy Talos resources by using Terraform with cloud platforms. |
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.
I think it's easier to just link to contrib repository since it has much more examples with different providers, and probbaly update README there if anything's missing
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.
The thing is, the docs lack Terraform and there are nothing covering it to begin with, and it took weeks to literally figure it out @frezbo
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.
yeh agree, but don;t think it makes sense to put TF commands in talos code, this can link to examples in contrib
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.
@frezbo Is there a way I can add the docs so that it's easier to understand and accessible for developers while having docs for Terraform too
It seems like a good idea to link the contrib repo from the docs but we should encourage all updates and changes to be in contrib and not explicitly in the docs because they'll always be out of date. What if we put a page under talos-guides/install/cloud-platforms/ and named it something generic such as "Infrastructure as Code" and explain in a couple paragraphs that community maintained examples are available in the contrib repo. We could mention it contains some Pulumi and Terraform examples and people are encouraged to use those examples as a starting point and contribute fixes and documentation directly to the contrib repo |
@rothgar can I do it for you guys if possible as I actually started the first version of it and complete it by changing the PR title and with another commit? |
Yes, that's fine with me. You don't have to list all of the IaC and platforms supported in the contrib repo but you could mention some of them. I suspect it'll get out of date quickly but at least letting people know the repo exists is a good thing. |
@rothgar, @frezbo, I'm taking the original to "What if we put a page under talos-guides/install/cloud-platforms/ and named it something generic such as "Infrastructure as Code" and explain in a couple paragraphs that community maintained examples are available in the contrib repo. We could mention it contains some Pulumi and Terraform examples and people are encouraged to use those examples as a starting point and contribute fixes and documentation directly to the contrib repo" Sounds good? |
Note to the Contributor
Added Terraform page to the documentation to make developers have easier to access to Terraform module information and learning to create and deploy Talos Cluster in AWS, Azure and GCP.
What? (description)
It is a basic documentation for developers to create and deploy Talos Clusters by using Terraform.
Why? (reasoning)
Because there were no official documentation on Terraform and had to rely on other sources even though Terraform module was there and it was insufficient to totally understand creating and deploying clusters and may add other things such as management if needed