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

📖 Doc updates #772

Merged
merged 1 commit into from
Oct 25, 2024
Merged

📖 Doc updates #772

merged 1 commit into from
Oct 25, 2024

Conversation

akutz
Copy link
Collaborator

@akutz akutz commented Oct 25, 2024 •
edited by github-actions bot
Loading

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

This patch updates the vm documentation with information about:

  • Encryption
  • Storage quota
  • Identifiers

The patch also rewrites a bunch of the docs to be more consistent with the overall patterns/conventions of the material.

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:

Documentation on encryption, storage, identifiers

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

@github-actions github-actions bot added the size/L Denotes a PR that changes 100-499 lines. label Oct 25, 2024
dilyar85
dilyar85 reviewed Oct 25, 2024
View reviewed changes
docs/concepts/workloads/vm.md Outdated Show resolved Hide resolved
docs/concepts/workloads/vm.md Show resolved Hide resolved
docs/concepts/workloads/vm.md Outdated Show resolved Hide resolved
docs/concepts/workloads/vm.md Outdated Show resolved Hide resolved
@akutz
Doc updates
cc2ecb6 
This patch updates the vm documentation with information about:

* Encryption
* Storage quota
* Identifiers

The patch also rewrites a bunch of the docs to be more consistent
with the overall patterns/conventions of the material.
@akutz akutz force-pushed the feature/doc-updates-20241025 branch from fae13df to cc2ecb6 Compare October 25, 2024 16:39
@akutz akutz requested a review from dilyar85 October 25, 2024 16:39
dilyar85
dilyar85 approved these changes Oct 25, 2024
View reviewed changes
Copy link
Member

@dilyar85 dilyar85 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @akutz!!

@akutz akutz merged commit 9ed7fe3 into vmware-tanzu:main Oct 25, 2024
11 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 85% ➖
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 86% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachine/volume 87% ➖
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 68% ❌
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice 83% ➖
github.com/vmware-tanzu/vm-operator/controllers/virtualmachineservice/providers 92% ✔
github.com/vmware-tanzu/vm-operator/controllers/virtualmachinesetresourcepolicy 80% ➖
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/controllers/virtualmachinewebconsolerequest/v1alpha2 73% ❌
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 88% ➖
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 75% ❌
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 79% ❌
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 82% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/virtualmachine 84% ➖
github.com/vmware-tanzu/vm-operator/pkg/providers/vsphere/vmlifecycle 67% ❌
github.com/vmware-tanzu/vm-operator/pkg/record 78% ❌
github.com/vmware-tanzu/vm-operator/pkg/topology 91% ✔
github.com/vmware-tanzu/vm-operator/pkg/util 87% ➖
github.com/vmware-tanzu/vm-operator/pkg/util/annotations 100% ✔
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 88% ➖
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/spq 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 92% ✔
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/client 64% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/vm 79% ❌
github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/watcher 86% ➖
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 91% ✔
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/v1alpha2/validation 92% ✔
Summary 83% (10456 / 12577) ➖

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

@dilyar85 dilyar85 dilyar85 approved these changes

Assignees

@dilyar85 dilyar85

Labels
cla-not-required size/L Denotes a PR that changes 100-499 lines.
Projects
None yet
Milestone
No milestone
Development

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