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

Document OpenTofu Support #594

Closed
wants to merge 6 commits into from
Closed

Document OpenTofu Support #594

wants to merge 6 commits into from

Conversation

osterman
Copy link
Member

@osterman osterman commented May 3, 2024

what

  • Document how to use OpenTofu together with Atmos

why

Gowiem
Gowiem previously approved these changes May 4, 2024
Copy link
Member

@Gowiem Gowiem left a comment

Choose a reason for hiding this comment

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

LGTM 🙌

My aside re: a new tf alias can be brought up via a GH issue if we find that we want to discuss that further.

@osterman
Copy link
Member Author

osterman commented May 4, 2024

new tf alias can be brought up via a GH issue if we find that we want to discuss that further.

@Gowiem there might be some confusion on aliases; they can be anything you want.

Here's some suggestions by @nitrocode (they're aggressively short!)

aliases:
  h: help
  v: version
  c: completion
  da: describe affected
  dcm: describe component
  dcn: describe config
  dd: describe dependents
  ds: describe stacks
  t: terraform
  tc: terraform clean
  td: terraform deploy
  tgb: terraform generate backend
  tgbs: terraform generate backends
  tgv: terraform generate varfile
  tgvs: terraform generate varfiles
  ts: terraform shell
  tw: terraform workspace
  hf: helmfile
  hgv: helmfile generate varfile
  vc: validate component
  vs: validate stacks
  vp: vendor pull
  w: workflow
  aeuk: aws eks update-kubeconfig
  agrc: atlantis generate repo-config

Then what you can do is alias a=atmos and run any of these like this: a t for atmos terraform

While defaults for everything are defined in the `atmos.yaml`, the same settings, can be overridden by Stack configurations at any level:

- `terraform`
- `components.terraform`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `components.terraform`


:::

Once you've configured Atmos to utilize `tofu`—either by adjusting the default `terraform.command` in the `atmos.yaml`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Once you've configured Atmos to utilize `tofu`either by adjusting the default `terraform.command` in the `atmos.yaml`
Once you've configured Atmos to utilize `tofu`

:::

Once you've configured Atmos to utilize `tofu`—either by adjusting the default `terraform.command` in the `atmos.yaml`
or by specifying the `command` for an individual component—provisioning any component follows the same procedure as
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
or by specifying the `command` for an individual component—provisioning any component follows the same procedure as
by specifying the `command` for an individual component—provisioning any component follows the same procedure as

Copy link
Member

@aknysh aknysh left a comment

Choose a reason for hiding this comment

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

please see comments

Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>
Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>
Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>
Co-authored-by: Andriy Knysh <aknysh@users.noreply.github.com>
@aknysh aknysh closed this in #604 May 22, 2024
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

Successfully merging this pull request may close these issues.

Docs on how to use atmos with opentofu
3 participants