Skip to content

Commit 9f1b99e

Browse files
committed
change terraform references to opentofu in docs
1 parent d317920 commit 9f1b99e

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

docs/openondemand.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ See the [ansible/roles/openondemand/README.md](../ansible/roles/openondemand/REA
3333
The following variables have been given default values to allow Open OnDemand to work in a newly created environment without additional configuration, but generally should be overridden in `environment/site/inventory/group_vars/all/` with site-specific values:
3434
- `openondemand_servername` - this must be defined for both `openondemand` and `grafana` hosts (when Grafana is enabled). Default is `ansible_host` (i.e. the IP address) of the first host in the `openondemand` group.
3535
- `openondemand_auth` and any corresponding options. Defaults to `basic_pam`.
36-
- `openondemand_desktop_partition` and `openondemand_jupyter_partition` if the corresponding inventory groups are defined. Defaults to the first compute group defined in the `compute` Terraform variable in `environments/$ENV/terraform`.
36+
- `openondemand_desktop_partition` and `openondemand_jupyter_partition` if the corresponding inventory groups are defined. Defaults to the first compute group defined in the `compute` OpenTofu variable in `environments/$ENV/tofu`.
3737

3838
It is also recommended to set:
3939
- `openondemand_dashboard_support_url`

docs/operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ This is a usually a two-step process:
5757

5858
- If new nodes are required, define a new node group by adding an entry to the `compute` mapping in `environments/$ENV/tofu/main.tf` assuming the default OpenTofu configuration:
5959
- The key is the partition name.
60-
- The value should be a mapping, with the parameters defined in `environments/$SITE_ENV/terraform/compute/variables.tf`, but in brief will need at least `flavor` (name) and `nodes` (a list of node name suffixes).
60+
- The value should be a mapping, with the parameters defined in `environments/$SITE_ENV/tofu/compute/variables.tf`, but in brief will need at least `flavor` (name) and `nodes` (a list of node name suffixes).
6161
- Add a new partition to the partition configuration as described under [Modifying Slurm Partition-specific Configuration](#Modifying-Slurm-Partition-specific-Configuration).
6262

63-
Deploying the additional nodes and applying these changes requires rerunning both Terraform and the Ansible site.yml playbook - follow [Deploying a Cluster](#Deploying-a-Cluster).
63+
Deploying the additional nodes and applying these changes requires rerunning both OpenTofu and the Ansible site.yml playbook - follow [Deploying a Cluster](#Deploying-a-Cluster).
6464

6565
# Adding Additional Packages
6666
By default, the following utility packages are installed during the StackHPC image build:

docs/persistent-state.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,14 @@ If using the `environments/common/layout/everything` Ansible groups template (wh
1313

1414
Note that if `appliances_state_dir` is defined, the path it gives must exist and should be owned by root. Directories will be created within this with appropriate permissions for each item of state defined above. Additionally, the systemd units for the services listed above will be modified to require `appliances_state_dir` to be mounted before service start (via the `systemd` role).
1515

16-
A new cookiecutter-produced environment supports persistent state in the default Terraform (see `environments/skeleton/{{cookiecutter.environment}}/terraform/`) by:
16+
A new cookiecutter-produced environment supports persistent state in the default OpenTofu (see `environments/skeleton/{{cookiecutter.environment}}/tofu/`) by:
1717

18-
- Defining a volume with a default size of 150GB - this can be controlled by the Terraform variable `state_volume_size`.
18+
- Defining a volume with a default size of 150GB - this can be controlled by the OpenTofu variable `state_volume_size`.
1919
- Attaching it to the control node.
2020
- Defining cloud-init userdata for the control node which formats and mounts this volume at `/var/lib/state`.
21-
- Defining `appliances_state_dir: /var/lib/state` for the control node in the (Terraform-templated) `inventory/hosts` file.
21+
- Defining `appliances_state_dir: /var/lib/state` for the control node in the (OpenTofu-templated) `inventory/hosts` file.
2222

23-
**NB: The default Terraform is provided as a working example and for internal CI use - therefore this volume is deleted when running `terraform destroy` - this may not be appropriate for a production environment.**
23+
**NB: The default OpenTofu is provided as a working example and for internal CI use - therefore this volume is deleted when running `tofu destroy` - this may not be appropriate for a production environment.**
2424

2525
In general, the Prometheus data is likely to be the only sizeable state stored. The size of this can be influenced through [Prometheus role variables](https://github.com/cloudalchemy/ansible-prometheus#role-variables), e.g.:
2626
- `prometheus_storage_retention` - [default](../environments/common/inventory/group_vars/all/prometheus.yml) 31d

docs/production.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ and referenced from the `site` and `production` environments, e.g.:
4141
- OpenTofu configurations should be defined in the `site` environment and used
4242
as a module from the other environments. This can be done with the
4343
cookie-cutter generated configurations:
44-
- Delete the *contents* of the cookie-cutter generated `terraform/` directories
44+
- Delete the *contents* of the cookie-cutter generated `tofu/` directories
4545
from the `production` and `staging` environments.
46-
- Create a `main.tf` in those directories which uses `site/terraform/` as a
46+
- Create a `main.tf` in those directories which uses `site/tofu/` as a
4747
[module](https://opentofu.org/docs/language/modules/), e.g. :
4848

4949
```
5050
...
5151
module "cluster" {
52-
source = "../../site/terraform/"
52+
source = "../../site/tofu/"
5353

5454
cluster_name = "foo"
5555
...
@@ -61,7 +61,7 @@ and referenced from the `site` and `production` environments, e.g.:
6161
into the module block.
6262
- Environment-independent variables (e.g. maybe `cluster_net` if the
6363
same is used for staging and production) should be set as *defaults*
64-
in `environments/site/terraform/variables.tf`, and then don't need to
64+
in `environments/site/tofu/variables.tf`, and then don't need to
6565
be passed in to the module.
6666
6767
- Vault-encrypt secrets. Running the `generate-passwords.yml` playbook creates

0 commit comments

Comments
 (0)