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

Docs terraform context #53242

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Docs terraform context #53242

wants to merge 10 commits into from

Conversation

ian-at-airbyte
Copy link
Contributor

What

Expand our Terraform stub article and add new Terraform tutorial. Resolves the docs component of #11525.

How

Expands our stub Terraform topic to be a fully-fledged Terraform tutorial. Includes new discussions and code samples, specifically around the use of JSON strings as alternatives to strongly typed configurations to help deal with Terraform drift.

Not included in this PR are two decisions we need to make about previously created resources:

  • The existing Terraform guide in the API docs
  • The exceptional YouTube series on this from our DevRel team

Both of these resources are out of date compared to this content, and I expect they will be replaced by it. This is a fuller discussion about current challenges and, unlike those other resources, should be technically correct to the latest version of the Terraform provider.

Review guide

  • /docs/terraform-documentation.md.

For the nice version, just open the linked Vercel build as usual and scroll down to Terraform Provider in the menu.

User Impact

  • An accurate, up to date Terraform tutorial, as a companion to the autogenerated reference docs.
  • A way to help deal with Terraform drift.

Can this PR be safely reverted and rolled back?

  • YES 💚
  • NO ❌

Copy link

vercel bot commented Feb 8, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
airbyte-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 8, 2025 2:27am

Copy link

@Charlesnorris509 Charlesnorris509 left a comment

Choose a reason for hiding this comment

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

Great job with pull requests your changes make the markdown file much more readable and engaging for new users like me. Now i still have a remark. I would increase the possibility for test driven development in this project and for future contributors. By a bulk test procedure for the most important feature of the project.


- **Cloud**: [An API application](using-airbyte/configuring-api-access.md) in Airbyte, your client ID, and your client secret.

- **Self-Managed**: Your username and password, and if you're running locally, your server URL (usually `http://localhost:8000/api/public/v1/`).
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought API applications were supported in OSS and SME as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

Applications are supported in SME and OSS

SME:
image

OSS:
image

I think OSS can't create multiple Applications, but it can still run with auth enabled.

1. Add your source to `main.tf`.

<Tabs>
<TabItem value="Strongly typed" label="Strongly typed" default>
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have JSON be the default rather than strongly typed?

}
```
</TabItem>
<TabItem value="Self-Managed" label="Self-Managed">
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps we can simplify these blocks so that all users use the same client_id/secret path.

</TabItem>
</Tabs>

5. In your terminal, create a file called `variables.tf`. This file stores sensitive variables you don't want to appear in `main.tf`, plus other values you'll reuse often.
Copy link
Contributor

Choose a reason for hiding this comment

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

This seems like a weird step to me, and extra noise. Why do we need to introduce touch specifically? Can we just say "create a file named ..."?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants