eab6920d7e
The recent addition of "aws login" to AWS CLI finally gives a user-friendly best practice way to acquire AWS credentials for use in interactive workflows. Combined with the pre-existing support for authenticating using JSON web tokens (by "web identity", as AWS calls it), there's no longer any good reason for most users of this backend to explicitly configure AWS credentials. Now that OpenTofu itself supports using credentials issued by "aws login", this reorganizes our documentation to begin with opinionated recommendations for how to provide credentials for the S3 backend in both interactive and non-interactive settings, and explicitly documents the inline static configuration settings as an absolute last resort not recommended in any cases. This new documentation also includes links to the relevant parts of the AWS CLI documentation, since there's a lot of extra detail there which may be useful for someone trying to debug why their setup isn't working. Signed-off-by: Martin Atkins <mart@degeneration.co.uk> |
||
|---|---|---|
| .. | ||
| data | ||
| docs | ||
| .eslintrc.js | ||
| docker-compose.build-non-main.yml | ||
| docker-compose.build.yml | ||
| docker-compose.yml | ||
| Dockerfile | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
OpenTofu Documentation
This directory contains the portions of the OpenTofu website that pertain to the core functionality, excluding providers and the overall configuration.
Development server
You can start a local development server with Docker by running the following command from this (the website) directory:
docker compose up --build
The development server will be available on http://localhost:3000/docs/main/ .
Under Docs in the navigation bar, select Development version to see local changes.
Suggesting Changes
You can submit an issue with documentation requests or submit a pull request with suggested changes.
Click Edit this page at the bottom of any OpenTofu website page to go directly to the associated markdown file in GitHub.
Modifying Sidebar Navigation
You must update the sidebar navigation when you add or delete documentation .mdx files. If you do not update the navigation, the website deploy preview fails.
To update the sidebar navigation, you must edit the appropriate nav-data.json file. This repository contains the sidebar navigation files for the following documentation sets:
- OpenTofu Language:
language-nav-data.json - OpenTofu CLI:
cli-nav-data.json - Introduction to OpenTofu:
intro-nav-data.json
Previewing Changes
Currently, you can preview your changes through the opentofu/opentofu.org repository.
Follow the Getting Started guide.
Copyright headers for code examples
In order to not include copyright headers for code examples used in docs, please, add the files under examples folder. This way, it will be ignored on automated copyright headers check.