mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-03-03 05:01:30 -05:00
53 lines
1.8 KiB
Plaintext
53 lines
1.8 KiB
Plaintext
---
|
|
sidebar_position: 99
|
|
sidebar_label: OCI container image
|
|
description: |-
|
|
Use official OCI container image available on GitHub Container Registry.
|
|
---
|
|
|
|
import CodeBlock from '@theme/CodeBlock';
|
|
import DockerPullScript from '!!raw-loader!./examples/docker-pull.sh'
|
|
import DockerRunScript from '!!raw-loader!./examples/docker-run.sh'
|
|
|
|
# Use OpenTofu as Docker Image
|
|
|
|
OpenTofu is available as [OCI container images](https://github.com/opentofu/opentofu/pkgs/container/opentofu),
|
|
and distributed via public GitHub Packages registry.
|
|
|
|
## Versions
|
|
|
|
Images are hosted as packages in the OpenTofu GitHub organization. See the list
|
|
of available versions [here](https://github.com/opentofu/opentofu/pkgs/container/opentofu/versions?filters%5Bversion_type%5D=tagged).
|
|
|
|
The multi platform images are available using the following tags:
|
|
|
|
- `latest`: latest overall version of OpenTofu,
|
|
- `Major`: a specific major version of OpenTofu,
|
|
- `Major`.`Minor`: a specific minor version of OpenTofu,
|
|
- `Major`.`Minor`.`Patch`: a specific patch version of OpenTofu.
|
|
|
|
To pull platform-specific images (`amd64`, `arm`, `arm64`, `386`) use:
|
|
|
|
- `<Version>`-`<Platform>`: a platform specific version of OpenTofu.
|
|
|
|
## Usage
|
|
|
|
:::note
|
|
If you run into rate limiting issues with GitHub, create a
|
|
[Personal Access Token](https://github.com/settings/tokens) and
|
|
[log in](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry)
|
|
to the registry.
|
|
:::
|
|
|
|
:::note
|
|
In the examples below you should have at least one `.tf` file located in the folder you are running the `docker` command.
|
|
:::
|
|
|
|
To pull the image from GitHub Packages registry:
|
|
|
|
<CodeBlock language="bash">{DockerPullScript}</CodeBlock>
|
|
|
|
To run OpenTofu as a Docker container:
|
|
|
|
<CodeBlock language="bash">{DockerRunScript}</CodeBlock>
|