Skip to content

Commit

Permalink
update comments and docs for opentofu
Browse files Browse the repository at this point in the history
  • Loading branch information
sjpb committed Jan 17, 2024
1 parent 2bee2bd commit 6c6934c
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
6 changes: 3 additions & 3 deletions bin/seed-ssh
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,14 @@ export PATH="$terraform_binary_directory:$PATH"
work_dir="$(ansible_variable work_directory)/seed-ssh"
mkdir -p "$work_dir"

# Initialise the Terraform backend
# Initialise the OpenTofu backend
terraform_backend_type="$(ansible_variable terraform_backend_type)"
if [ "$terraform_backend_type" = "local" ]; then
# If the Terraform backend is local, that means the provisioning is run on the current host
# If the OpenTofu backend is local, that means the provisioning is run on the current host
# Hence there should be a pre-existing Terraform project directory we can point at
terraform_dir="$(ansible_variable terraform_project_path)"
else
# If the Terraform backend type is something other than local, make a terraform
# If the OpenTofu backend type is something other than local, make an OpenTofu project
# directory containing a backend configuration that specifies the type and config
terraform_dir="$work_dir"
cat <<EOF > "$terraform_dir/backend.tf"
Expand Down
12 changes: 6 additions & 6 deletions docs/best-practice.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ It is recommended to use a
[feature branch workflow](./repository/index.md#making-changes-to-your-configuration)
to make changes to your Azimuth configuration in a controlled way.

## Terraform state
## OpenTofu state

Azimuth deployments use [Terraform](https://www.terraform.io/) to manage some parts of
Azimuth deployments use [OpenTofu](https://opentofu.org/) to manage some parts of
the infrastructure.

A [Terraform remote state store](./repository/terraform.md#remote-state) must be configured
in order to persist the Terraform state across playbook executions. If GitLab is being
An [OpenTofu remote state store](./repository/opentofu.md#remote-state) must be configured
in order to persist the OpenTofu state across playbook executions. If GitLab is being
used for the repository, it is recommended to use
[GitLab-managed Terraform state](./repository/terraform.md#gitlab). If not,
[S3](./repository/terraform.md#s3) is the preferred approach.
[GitLab-managed OpenTofu state](./repository/opentofu.md#gitlab). If not,
[S3](./repository/opentofu.md#s3) is the preferred approach.

## Environments

Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/02-deployment-method.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

## Single node

In this deployment method, a single node is provisioned with [Terraform](https://www.terraform.io/)
In this deployment method, a single node is provisioned with [OpenTofu](https://opentofu.org/)
and configured as a [K3S](https://k3s.io/) cluster. The full Azimuth stack is then deployed
onto this cluster.

Expand Down Expand Up @@ -44,7 +44,7 @@ infra_data_volume_size: 100
## Highly-available (HA)
For the HA deployment method, Terraform is also used to provision a single node that is
For the HA deployment method, OpenTofu is also used to provision a single node that is
configured as a K3S cluster. However rather than hosting the Azimuth components, as in
the single node case, this K3S cluster is only configured as a
[Cluster API management cluster](https://cluster-api.sigs.k8s.io/user/concepts.html#management-cluster).
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/12-caas.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Cluster-as-a-Service (CaaS) in Azimuth allows self-service platforms to be provided to
users that are deployed and configured using a combination of [Ansible](https://www.ansible.com/),
[Terraform](https://www.terraform.io/) and [Packer](https://www.packer.io/), stored in
[OpenTofu](https://opentofu.org/) and [Packer](https://www.packer.io/), stored in
a [git](https://git-scm.com/) repository.

CaaS support in Azimuth is implemented by the
Expand Down
6 changes: 3 additions & 3 deletions docs/deployment/automation.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ set up continuous delivery for an Azimuth configuration repository.
!!! tip

If you are using GitLab for your configuration repository, make sure you have
[configured it to use GitLab-managed Terraform state](../repository/terraform.md#gitlab).
[configured it to use GitLab-managed OpenTofu state](../repository/opentofu.md#gitlab).

!!! warning "Runner configuration"

Expand All @@ -60,8 +60,8 @@ environment in your repository. This is a one-to-one relationship except for
[per-branch dynamic review environments](#per-branch-dynamic-review-environments),
where multiple GitLab environments will use a single configuration environment.

If you are using GitLab-managed Terraform state, each *GitLab environment* (not
configuration environment) will get it's own independent Terraform state.
If you are using GitLab-managed OpenTofu state, each *GitLab environment* (not
configuration environment) will get it's own independent OpenTofu state.

The sample configuration defines the following deployment jobs:

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Option 1 is useful for development or demo deployments, but is not suitable for
deployment.

Option 2 is the recommended deployment mechanism for most deployments. In this mode,
[Terraform](https://www.terraform.io/) is used to provision a single-node K3S cluster
[OpenTofu](https://opentofu.org/) is used to provision a single-node K3S cluster
that is configured as a [Cluster API](https://cluster-api.sigs.k8s.io/) management
cluster. Cluster API is then used to provision a highly-available Kubernetes cluster in
the same OpenStack project onto which Azimuth is deployed.
Expand Down

0 comments on commit 6c6934c

Please sign in to comment.