Add docs for foreman_opentofu#4762
Conversation
github-actions
Bot
added
Needs tech review
maximiliankolb
force-pushed
the
foreman_opentofu
branch
2 times, most recently
from
59c1145 to
e20f0e5
Compare
| . From the *Server Type* list, select the server type to use for provisioning. | ||
| . From the *Location* list, select the geographical location of the {compute-resource-target-name} datacenter. |
There was a problem hiding this comment.
At the moment these values are not cross-referenced, so it might be wise to only select the server-type unless sure that the selected server-type is available in the selected Location.
Not all server-types are available in all locations on Hetzner.
| Creating backups of hosts on {compute-resource-target-name} creates additional costs. | ||
| ==== | ||
| . From the *Image* list, select the image to use for provisioning. | ||
| . From the *Network* list, select the network to use for provisioning. |
There was a problem hiding this comment.
Limitation for Hetzner: the first network interface will get the public-IPs that are assigned to the new Host by Hetzner. So selecting a Subnet for the first network-interface may result in errors during deployment of the host.
| . From the *Operating System* list, select the operating system of the image on {compute-resource-target-name}. | ||
| . From the *Architecture* list, select the architecture of the image on {compute-resource-target-name}. | ||
| . In the *Username* field, enter the user name of your golden image. | ||
| . Select *User Data* if the host image supports user data. |
There was a problem hiding this comment.
We mainly tested with this field checked. Leaving it unchecked may result in undefined behavior at the moment 😅
| . From the *Architecture* list, select the architecture of the image on {compute-resource-target-name}. | ||
| . In the *Username* field, enter the user name of your golden image. | ||
| . Select *User Data* if the host image supports user data. | ||
| . In the *Password* field, enter the password of the user on your golden image. |
There was a problem hiding this comment.
Hetzner Hint: for the Hetzner Images this usually needs to be empty (as far as our tests have shown).
| . In the {ProjectWebUI}, navigate to *Infrastructure* > *Compute Resources*. | ||
| . Select your {compute-resource-target-name} compute resource. | ||
| . On the *Virtual Machines* tab, click *Delete* from the *Actions* menu. |
There was a problem hiding this comment.
The Virtual Machines tab is currently not implemented for OpenTofu. So Host deletion at the moment only works by deleting the Host via the Hosts pages (and having the destroy_vm_on_host_delete setting enabled).
| * On your {ProjectServer}, install the {compute-resource-name} plugin: | ||
| + | ||
| [options="nowrap", subs="+quotes,verbatim,attributes"] | ||
| ---- | ||
| # {foreman-installer} --enable-foreman-plugin-opentofu | ||
| ---- |
There was a problem hiding this comment.
The RPM-Package for foreman_opentofu has a weak dependency on the tofu RPM package.
Foreman user's have to make sure the package is available from a repository enabled on the system.
The plugin needs the tofu-command to be present.
| . Click *Resolve* next to *Provisioning templates* to confirm that the host can identify its provisioning templates. | ||
| . Click the *Virtual Machine* tab and confirm that these settings are populated with details from the host group and compute profile. | ||
| ifdef::hetzner-cloud[. From the *Server Type* List, select the server type on {compute-resource-target-name}.] | ||
| ifdef::hetzner-cloud[. From the *Location* List, select the geographical location of the host on {compute-resource-target-name}.] |
There was a problem hiding this comment.
Optional; as mentioned above it might result in error if the server-type is not available in the selected location.
|
|
||
| [role="_abstract"] | ||
| {Project} integrates with several compute resource targets through {compute-resource-name}. | ||
| It provides a provisioning template for each supported {compute-resource-name} target. |
There was a problem hiding this comment.
Should we mention that the template-kind is opentofu_script?
On the ProvisioningTemplate page it makes it easier to find when searching for kind = opentofu_script.
maximiliankolb
force-pushed
the
foreman_opentofu
branch
from
41867ca to
3f68793
Compare
maximiliankolb
force-pushed
the
foreman_opentofu
branch
from
3f68793 to
b26bc27
Compare
2 participants
What changes are you introducing?
Documentation for OpenTofu plugin.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Refs https://github.com/ATIX-AG/foreman_opentofu/
Contributor checklists
Please cherry-pick my commits into: