Skip to content

Update docs for instance.disk disk_encryption field #690

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jriddle-linode merged 1 commit into from
Jul 29, 2025
Merged

Update docs for instance.disk disk_encryption field #690

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/modules/instance.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ Manage Linode Instances, Configs, and Disks.
| `authorized_keys` | <center>`list`</center> | <center>Optional</center> | A list of SSH public key parts to deploy for the root user. |
| `authorized_users` | <center>`list`</center> | <center>Optional</center> | A list of usernames. |
| `filesystem` | <center>`str`</center> | <center>Optional</center> | The filesystem to create this disk with. |
| `disk_encryption` | <center>`str`</center> | <center>Optional</center> | The disk encryption status of this disk.NOTE: Disk encryption may not currently be available to all users. **(Choices: `enabled`, `disabled`)** |
| `disk_encryption` | <center>`str`</center> | <center>Optional</center> | **READ ONLY** The disk encryption status of this disk.NOTE: Disk encryption may not currently be available to all users and is set at the Linode Level. **(Choices: `enabled`, `disabled`)** |
| `image` | <center>`str`</center> | <center>Optional</center> | An Image ID to deploy the Disk from. |
| `root_pass` | <center>`str`</center> | <center>Optional</center> | The root user’s password on the newly-created Linode. |
| `stackscript_id` | <center>`int`</center> | <center>Optional</center> | The ID of the StackScript to use when creating the instance. See the [Linode API documentation](https://techdocs.akamai.com/linode-api/reference/get-stack-scripts). |
Expand Down
5 changes: 3 additions & 2 deletions plugins/modules/instance.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,9 @@
),
"disk_encryption": SpecField(
type=FieldType.string,
description="The disk encryption status of this disk."
+ "NOTE: Disk encryption may not currently be available to all users.",
description="**READ ONLY** The disk encryption status of this disk."
+ "NOTE: Disk encryption may not currently be available to all users "
+ "and is set at the Linode Level.",
choices=["enabled", "disabled"],
),
"image": SpecField(
Expand Down