Skip to content
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

Jump to bottom

📖 Update VM crypto docs on rekey #857

Merged
merged 1 commit into from
Jan 13, 2025
Merged

📖 Update VM crypto docs on rekey #857

merged 1 commit into from
Jan 13, 2025

Conversation

akutz
Copy link
Collaborator

@akutz akutz commented Jan 13, 2025 •
edited by github-actions bot
Loading

This patch adds more documentation around rekeying an encrypted VM to explain that rekeying requires the encryption classes to have different provider and/or key IDs.

What does this PR do, and why is it needed?

This patch adds more documentation around rekeying an encrypted VM to explain that rekeying requires the encryption classes to have different provider and/or key IDs.

Which issue(s) is/are addressed by this PR? (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):

Fixes NA

Are there any special notes for your reviewer:

Please add a release note if necessary:

Update docs for rekeying encrypted VM

📚 Documentation preview 📚: https://vm-operator--857.org.readthedocs.build/en/857/

@github-actions github-actions bot added the size/L Denotes a PR that changes 100-499 lines. label Jan 13, 2025
@akutz
Update VM crypto docs on rekey
026e589 
This patch adds more documentation around rekeying an
encrypted VM to explain that rekeying requires the
encryption classes to have different provider and/or key IDs.
@akutz akutz force-pushed the doc/crypto-class-must-have-diff-key-or-provider branch from 06631f0 to 026e589 Compare January 13, 2025 17:23
@github-actions github-actions bot added size/M Denotes a PR that changes 30-99 lines. and removed size/L Denotes a PR that changes 100-499 lines. labels Jan 13, 2025
@akutz akutz merged commit 92bec24 into vmware-tanzu:main Jan 13, 2025
10 checks passed
@github-actions GitHub Actions
Copy link

Code Coverage

Package Line Rate Health
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/clustercontentlibraryitem 82% ➖
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/contentlibraryitem 86% ➖
github.com/vmware-tanzu/vm-operator/controllers/contentlibrary/utils 97% ✔
github.com/vmware-tanzu/vm-operator/controllers/infra/capability/configmap 86% ➖
github.com/vmware-tanzu/vm-operator/controllers/infra/capability/crd 93% ✔
github.com/vmware-tanzu/vm-operator/controllers/infra/configmap 71% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/node 77% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/secret 77% ❌
github.com/vmware-tanzu/vm-operator/controllers/infra/validatingwebhookconfiguration 85% ➖
github.com/vmware-tanzu/vm-operator/controllers/infra/zone 76% ❌
github.com/vmware-tanzu/vm-operator/controllers/storageclass 95% ✔
github.com/vmware-tanzu/vm-operator/controllers/storagepolicyquota 97% ✔
github.com/vmware-tanzu/vm-operator/controllers/util/encoding 73% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/storagepolicyusage 99% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/virtualmachine 84% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/volume 88% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineclass 75% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinepublishrequest 81% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinereplicaset 67% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice 82% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice/providers 92% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinesetresourcepolicy 82% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest 72% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest/v1alpha1 72% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest/v1alpha1/conditions 88% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinewebconsolerequest/v1alpha1/patch 78% ❌
github.com/vmware-tanzu/vm-operator/pkg/bitmask 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/builder 95% ✔
github.com/vmware-tanzu/vm-operator/pkg/conditions 90% ✔
github.com/vmware-tanzu/vm-operator/pkg/config 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/config/capabilities 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/config/env 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/context/generic 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/context/operation 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/patch 78% ❌
github.com/vmware-tanzu/vm-operator/pkg/prober 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/prober/probe 90% ✔
github.com/vmware-tanzu/vm-operator/pkg/prober/worker 77% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere 72% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/client 80% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/clustermodules 71% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/config 89% ✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/contentlibrary 74% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/credentials 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/network 80% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/placement 80% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/session 71% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/storage 44% ❌
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/sysprep 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vcenter 81% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/virtualmachine 84% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vmlifecycle 65% ❌
github.com/vmware-tanzu/vm-operator/pkg/record 87% ➖
github.com/vmware-tanzu/vm-operator/pkg/topology 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/util 88% ➖
github.com/vmware-tanzu/vm-operator/pkg/util/cloudinit 89% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/cloudinit/validate 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/image 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube 89% ➖
github.com/vmware-tanzu/vm-operator/pkg/util/kube/cource 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube/internal 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/kube/proxyaddr 73% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/kube/spq 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/netplan 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/ovfcache 75% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/ovfcache/internal 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/paused 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/ptr 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/resize 97% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/vmopv1 80% ➖
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/client 64% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/library 100% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm 79% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/watcher 87% ➖
github.com/vmware-tanzu/vm-operator/pkg/vmconfig 95% ✔
github.com/vmware-tanzu/vm-operator/pkg/vmconfig/crypto 98% ✔
github.com/vmware-tanzu/vm-operator/pkg/webconsolevalidation 100% ✔
github.com/vmware-tanzu/vm-operator/services/vm-watcher 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/common 100% ✔
github.com/vmware-tanzu/vm-operator/webhooks/persistentvolumeclaim/validation 95% ✔
github.com/vmware-tanzu/vm-operator/webhooks/unifiedstoragequota/validation 89% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachine/mutation 87% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachine/validation 95% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineclass/mutation 62% ❌
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineclass/validation 89% ➖
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinepublishrequest/validation 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinereplicaset/validation 90% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineservice/mutation 67% ❌
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachineservice/validation 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinesetresourcepolicy/validation 89% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinewebconsolerequest/v1alpha1/validation 92% ✔
github.com/vmware-tanzu/vm-operator/webhooks/virtualmachinewebconsolerequest/validation 92% ✔
Summary 83% (10945 / 13256) ➖

Minimum allowed line rate is 79%

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dougm dougm dougm approved these changes

Assignees
No one assigned
Labels
cla-not-required size/M Denotes a PR that changes 30-99 lines.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@akutz @dougm @vmwclabot