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

Section on init is confusing to newcomer #107

Open
cprivitere opened this issue Aug 9, 2022 · 1 comment
Open

Section on init is confusing to newcomer #107

cprivitere opened this issue Aug 9, 2022 · 1 comment
Milestone

Comments

@cprivitere
Copy link
Member

"An alternative to using git clone, with the same affect of copying all of the Terraform config files into an empty directory, is terraform init -from-module=equinix/multiarch-k8s/metal"."

It would be better to just tell a new user to run terraform init, THEN go into the philosophical options about cloning or using init to just download files.

@displague
Copy link
Member

With recent changes, https://github.com/equinix/terraform-metal-multiarch-k8s#getting-started is going to need additional changes, similar to those called out in the OP.

When using terraform init --from-module, the user may also need to create a provider.tf and versions.tf defining the Equinix provider version and auth token to use.

For users that want the simplest path to get started, users should run from examples/simple where the provider is already defined and a token and project_id are all that's needed. examples/simple should include a README.md that explains this and the root README.md should defer to the example's README.

@displague displague added this to the v0.6.0 milestone Oct 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants