Skip to content

Commit

Permalink
Address feedback from #2140 for README formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
tpdownes committed Jan 16, 2024
1 parent f7d8708 commit b466af8
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 8 deletions.
6 changes: 4 additions & 2 deletions community/modules/compute/htcondor-execute-point/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,14 +134,14 @@ will be provisioned in any of the zones available in that region, however, it
can be constrained to run in fewer zones (or a single zone) using
[var.zones](#input_zones).
By default, the VM replacement policy is set to [opportunistic]. In practice,
By default, the VM replacement policy is set to "[OPPORTUNISTIC]". In practice,
this means that the Execute Points will _NOT_ be automatically replaced by
Terraform when changes to the instance template / HTCondor configuration are
made. We recommend leaving this at the default value as it will allow the
HTCondor autoscaler to replace VMs when they become idle without disrupting
running jobs.
However, if it is desired [var.update_policy][#input_update_policy] can be set
However, if it is desired [var.update_policy](#input_update_policy) can be set
to "PROACTIVE" to enable automatic replacement. This will disrupt running jobs
and send them back to the queue. Alternatively, one can leave the setting at
"OPPORTUNISTIC" and update:
Expand All @@ -158,6 +158,8 @@ gcloud compute instance-groups managed update-instances \
--project <<PROJECT_ID>> --minimal-action replace
```

[OPPORTUNISTIC]: https://cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#type

## Known Issues

When using OS Login with "external users" (outside of the Google Cloud
Expand Down
6 changes: 3 additions & 3 deletions community/modules/scheduler/htcondor-access-point/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ A regional [MIG][mig] is used to provision the Access Point, although only
in any of the zones available in that region, however, it can be constrained to
run in fewer zones (or a single zone) using [var.zones](#input_zones).

By default, the VM replacement policy is set to [opportunistic]. In practice,
By default, the VM replacement policy is set to "[OPPORTUNISTIC]". In practice,
this means that the Access Point will _NOT_ be automatically replaced by
Terraform when changes to the instance template / HTCondor configuration are
made. The Access Point is _NOT_ safe to replace automatically as its local storage
Expand All @@ -54,7 +54,7 @@ gcloud compute instance-groups managed update-instances \
```

This mode can be switched to "PROACTIVE" (automatic) replacement by setting
[var.update_policy][#input_update_policy]. In this case we recommend the use of
[var.update_policy](#input_update_policy). In this case we recommend the use of
Filestore to store the job queue state ("spool") and setting
[var.spool_parent_dir][#input_spool_parent_dir] to its mount point:

Expand Down Expand Up @@ -82,7 +82,7 @@ Filestore to store the job queue state ("spool") and setting
spool_parent_dir: /shared
```
[opportunistic]: https://cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#type
[OPPORTUNISTIC]: https://cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#type
<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
Copyright 2023 Google LLC
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ A regional [MIG][mig] is used to provision the central manager, although only
in any of the zones available in that region, however, it can be constrained to
run in fewer zones (or a single zone) using [var.zones](#input_zones).

By default, the VM replacement policy is set to [proactive]. In practice, this
By default, the VM replacement policy is set to "[PROACTIVE]". In practice, this
means that the Central Manager will be replaced by Terraform when changes to
the instance template / HTCondor configuration are made. The Central Manager is
safe to replace automatically as it gathers its state information from periodic
messages exchanged with the rest of the HTCondor pool.

This mode can be switched to "OPPORTUNISTIC" by setting [var.update_policy][#input_update_policy].
This mode can be switched to "OPPORTUNISTIC" by setting [var.update_policy](#input_update_policy).
In this case, the Central Manager will be replaced only when:

- intentionally by issuing an update via Cloud Console or using gcloud (below)
Expand All @@ -52,7 +52,7 @@ gcloud compute instance-groups managed update-instances \
--project <<PROJECT_ID>> --minimal-action replace
```

[proactive]: https://cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#type
[PROACTIVE]: https://cloud.google.com/compute/docs/instance-groups/rolling-out-updates-to-managed-instance-groups#type

## Limiting inter-zone egress

Expand Down

0 comments on commit b466af8

Please sign in to comment.