Skip to content

Commit 41f35e6

Browse files
authored
shore(docs): update API Token auth section (#1991)
- Added MD059 rule to .markdownlint.json for better markdown formatting. - Updated CODE_OF_CONDUCT.md to format email address as a link. - Consolidated privilege descriptions in docs/index.md for clarity. - Improved formatting in docs/resources/virtual_environment_vm.md for better readability. * add `gh` to devcontainer * remove wakatime --------- Signed-off-by: Pavel Boldyrev <[email protected]>
1 parent 60b6f5b commit 41f35e6

File tree

6 files changed

+12
-21
lines changed

6 files changed

+12
-21
lines changed

.devcontainer/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ FROM golang:1.24.4@sha256:db5d0afbfb4ab648af2393b92e87eaae9ad5e01132803d80caef91
33
ARG GOLANGCI_LINT_VERSION=2.1.6 # renovate: depName=golangci/golangci-lint datasource=github-releases
44

55
RUN apt update && apt upgrade -y && \
6-
apt-get install --no-install-recommends -y ca-certificates curl gnupg lsb-release jq zsh neovim && \
6+
apt-get install --no-install-recommends -y ca-certificates curl gnupg lsb-release jq zsh neovim gh && \
77
chsh -s $(which zsh) && \
88
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)" && \
99
rm -rf /var/lib/apt/lists/*

.markdownlint.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@
33
"MD013": false,
44
"MD025": false,
55
"MD033": false,
6-
"MD041": false
6+
"MD041": false,
7+
"MD059": false
78
}

CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This Code of Conduct applies both within project spaces and in public spaces whe
3434

3535
## Enforcement
3636

37-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at <[email protected]>. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
3838

3939
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
4040

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
[![Go Report Card](https://goreportcard.com/badge/github.com/bpg/terraform-provider-proxmox)](https://goreportcard.com/report/github.com/bpg/terraform-provider-proxmox)
88
[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-v1.0.0-ff69b4)](https://www.conventionalcommits.org/en/v1.0.0/)
99
[![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/bpg/terraform-provider-proxmox?utm_source=oss&utm_medium=github&utm_campaign=bpg%2Fterraform-provider-proxmox&color=FF570A&link=https%3A%2F%2Fcoderabbit.ai&label=CodeRabbit+Reviews)](https://www.coderabbit.ai/)
10-
[![Wakatime](https://wakatime.com/badge/github/bpg/terraform-provider-proxmox.svg)](https://wakatime.com/@a51a1a51-85c3-497b-b88a-3b310a709909/projects/vdtgmpvjom)
1110

1211
A Terraform / OpenTofu Provider that adds support for Proxmox Virtual Environment.
1312

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ You can create an API Token for a user via the Proxmox UI, or via the command li
205205
- Create a role for the user (you can skip this step if you want to use any of the existing roles):
206206

207207
```sh
208-
sudo pveum role add Terraform -privs "Datastore.Allocate Datastore.AllocateSpace Datastore.AllocateTemplate Datastore.Audit Pool.Allocate Sys.Audit Sys.Console Sys.Modify SDN.Use VM.Allocate VM.Audit VM.Clone VM.Config.CDROM VM.Config.Cloudinit VM.Config.CPU VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Network VM.Config.Options VM.Migrate VM.Monitor VM.PowerMgmt User.Modify"
208+
sudo pveum role add Terraform -privs "Mapping.Audit Mapping.Modify Mapping.Use Permissions.Modify Pool.Allocate Pool.Audit Realm.AllocateUser Realm.Allocate SDN.Allocate SDN.Audit Sys.Audit Sys.Console Sys.Incoming Sys.Modify Sys.AccessNetwork Sys.PowerMgmt Sys.Syslog User.Modify Group.Allocate SDN.Use VM.Allocate VM.Audit VM.Backup VM.Clone VM.Config.CDROM VM.Config.CPU VM.Config.Cloudinit VM.Config.Disk VM.Config.HWType VM.Config.Memory VM.Config.Network VM.Config.Options VM.Console VM.Migrate VM.Monitor VM.PowerMgmt VM.Snapshot.Rollback VM.Snapshot Datastore.Allocate Datastore.AllocateSpace Datastore.AllocateTemplate Datastore.Audit"
209209
```
210210

211211
~> The list of privileges above is only an example, please review it and adjust to your needs.

docs/resources/virtual_environment_vm.md

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -135,17 +135,13 @@ output "ubuntu_vm_public_key" {
135135
- `isa` - ISA Serial Port.
136136
- `virtio` - VirtIO (paravirtualized).
137137
- `amd_sev` - (Optional) Secure Encrypted Virtualization (SEV) features by AMD CPUs.
138-
- `type` - (Optional) Enable standard SEV with `std` or enable experimental
139-
SEV-ES with the `es` option or enable experimental SEV-SNP with the `snp` option
140-
(defaults to `std`).
138+
- `type` - (Optional) Enable standard SEV with `std` or enable experimental SEV-ES with the `es` option or enable experimental SEV-SNP with the `snp` option (defaults to `std`).
141139
- `allow_smt` - (Optional) Sets policy bit to allow Simultaneous Multi Threading (SMT)
142140
(Ignored unless for SEV-SNP) (defaults to `true`).
143-
- `kernel_hashes` - (Optional) Add kernel hashes to guest firmware for measured
144-
linux kernel launch (defaults to `false`).
141+
- `kernel_hashes` - (Optional) Add kernel hashes to guest firmware for measured linux kernel launch (defaults to `false`).
145142
- `no_debug` - (Optional) Sets policy bit to disallow debugging of guest (defaults
146143
to `false`).
147-
- `no_key_sharing` - (Optional) Sets policy bit to disallow key sharing with
148-
other guests (Ignored for SEV-SNP) (defaults to `false`).
144+
- `no_key_sharing` - (Optional) Sets policy bit to disallow key sharing with other guests (Ignored for SEV-SNP) (defaults to `false`).
149145

150146
The `amd_sev` setting is only allowed for a `root@pam` authenticated user.
151147
- `audio_device` - (Optional) An audio device.
@@ -657,6 +653,7 @@ trusts the user to set `agent.enabled` correctly and waits for
657653
`qemu-guest-agent` to start.
658654

659655
## AMD SEV
656+
660657
AMD SEV (-ES, -SNP) are security features for AMD processors. SEV-SNP support
661658
is included in Proxmox version **8.4**, see [Proxmox Wiki](
662659
https://pve.proxmox.com/wiki/Qemu/KVM_Virtual_Machines#qm_virtual_machines_settings)
@@ -665,17 +662,11 @@ for more information.
665662

666663
`amd-sev` requires root and therefore `root@pam` auth.
667664

668-
SEV-SNP requires `bios = OVMF` and a supported AMD CPU (`EPYC-v4` for instance),
669-
`machine = q35` is also advised. No EFI disk is required since SEV-SNP uses
670-
consolidated read-only firmware. A configured EFI will be ignored.
665+
SEV-SNP requires `bios = OVMF` and a supported AMD CPU (`EPYC-v4` for instance), `machine = q35` is also advised. No EFI disk is required since SEV-SNP uses consolidated read-only firmware. A configured EFI will be ignored.
671666

672-
All changes made to `amd_sev` will trigger reboots. Removing or adding the
673-
`amd_sev` block will force a replacement of the resource. Modifying the `amd_sev`
674-
block will not trigger replacements.
667+
All changes made to `amd_sev` will trigger reboots. Removing or adding the `amd_sev` block will force a replacement of the resource. Modifying the `amd_sev` block will not trigger replacements.
675668

676-
`allow_smt` is by default set to `true` even if `snp` is not the selected type.
677-
Proxmox will ignore this value when `snp` is not in use. Likewise `no_key_sharing`
678-
is `false` by default but ignored by Proxmox when `snp` is in use.
669+
`allow_smt` is by default set to `true` even if `snp` is not the selected type. Proxmox will ignore this value when `snp` is not in use. Likewise `no_key_sharing` is `false` by default but ignored by Proxmox when `snp` is in use.
679670

680671
## Important Notes
681672

0 commit comments

Comments
 (0)