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.

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

CHAOS-7285 VMware permissions #9085

Merged
merged 5 commits into from
Jan 27, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -96,17 +96,17 @@ permissions:
<tr>
<td> FILESYSTEM_UTILIZATION_PERCENTAGE </td>
<td> Specify the size as a percentage of free space on the file system.</td>
<td> Default: 10 %. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-io-stress/#filesystem-utilization-percentage">file system utilization percentage.</a> </td>
<td> Default: 10 %. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/linux/vmware-io-stress/#filesystem-utilization-percentage">file system utilization percentage.</a> </td>
</tr>
<tr>
<td> FILESYSTEM_UTILIZATION_BYTES </td>
<td> Specify the size of the files used per worker (in GB). <code>FILESYSTEM_UTILIZATION_PERCENTAGE</code> and <code>FILESYSTEM_UTILIZATION_BYTES</code> are mutually exclusive. </td>
<td>If both are provided, <code>FILESYSTEM_UTILIZATION_PERCENTAGE</code> takes precedence. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/VMware-io-stress#filesystem-utilization-bytes"> file system utilization bytes.</a></td>
<td>If both are provided, <code>FILESYSTEM_UTILIZATION_PERCENTAGE</code> takes precedence. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/linux/VMware-io-stress#filesystem-utilization-bytes"> file system utilization bytes.</a></td>
</tr>
<tr>
<td> CPU </td>
<td> Number of cores of the CPU that will be used. </td>
<td> Default: 1. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-cpu-hog/#cpu_cores"> CPU cores.</a></td>
<td> Default: 1. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/linux/vmware-cpu-hog/#cpu_cores"> CPU cores.</a></td>
</tr>
<tr>
<td> NUMBER_OF_WORKERS </td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,45 +38,31 @@ The faults have been tested for compatibility in the following Linux OS distribu
<tr>
<th> Chaos agent deployment model </th>
<td><b>Native Chaos Agent on Each VM (system service within Target Linux Machine) </b></td>
<th> Centralized Chaos agent on Kubernetes (leverage VMware Tools to inject chaos processes inside guest VM ) </th>
</tr>
<tr>
<th> Connectivity requirements from agent </th>
<td> <ul><li>Outbound over port 443 to Harness from VM. </li>
<li> Outbound to application health endpoints (ones which will be used for resilience validation) from VM </li></ul></td>
<td> <ul><li>Outbound over port 443 to Harness from Kubernetes cluster</li>
<li>Outbound over 443 to vCenter from Kubernetes cluster</li>
<li>Outbound to application health endpoints (ones which will be used for resilience validation) from kubernetes cluster. </li></ul></td>
</tr>
<tr>
<th> Connectivity requirements from VM/cluster/app </th>
<td><ul><li> Application and chaos agent co-exist on the same VM. </li></ul></td>
<td><ul><li> Inbound over port 443 on ESX Host (from Kubernetes chaos agent) </li></ul></td>
</tr>
<tr>
<th> Access requirements for agent install </th>
<td> <ul><li>Install agent as root user. </li></ul> </td>
<td><ul><li>Install agent as a cluster-admin or as a user mapped to cluster role with <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/permissions/Kubernetes%20chaos%20agent%20installation%20access%20requirements"> these</a> permissions. </li></ul></td>
</tr>
<tr>
<th> Access requirements for basic chaos experiments </th>
<td> <ul><li>Run experiments with non-root user. </li></ul> </td>
<td><ul><li>vCenter user should be mapped to a predefined <a href="https://hce-docs.github.io/platform-wise-chaos-info/VMware/vcenter-based-chaos-user-access-requirements.md"> chaos </a> role. </li>
<li> VMware tools should be setup on the VM. </li>
<li>Remote command injection can be performed with non-root user. </li></ul></td>
</tr>
<tr>
<th> Access requirements for advanced chaos experiments </th>
<td><ul><li>Run experiments with non-root user. </li></ul> </td>
<td><ul><li>vCenter user should be mapped to a predefined <a href="https://hce-docs.github.io/platform-wise-chaos-info/VMware/vcenter-based-chaos-user-access-requirements.md"> chaos </a> role. </li>
<li> VMware tools should be setup on the VM. </li>
<li>Remote command injection can be performed with non-root user. </li></ul></td>
</tr>
<tr>
<th> Supported chaos faults </th>
<td><ul><li> <a href="https://github.com/hce-docs/platform-wise-chaos-info/blob/main/VMware/LinuxOS/basic-chaos-faults-supported-by-linux-infra-running-as-non-root.md"> Basic faults with non-root agent </a> </li>
<li> <a href="https://github.com/hce-docs/platform-wise-chaos-info/blob/main/VMware/LinuxOS/all-supported-chaos-faults-by-linux-infra-running-as-root.md">Basic and advanced faults with root agent </a></li></ul></td>
<td><ul><li> <a href= "https://github.com/hce-docs/platform-wise-chaos-info/blob/main/VMware/LinuxOS/basic-chaos-supported-by-kubernetes-infra-performing-remote-command-injection-with-non-root-user.md"> Basic faults via remote command injection with non-root user </a> </li>
<li> <a href="https://github.com/hce-docs/platform-wise-chaos-info/blob/main/VMware/LinuxOS/all-supported-chaos-faults-by-kubernetes-infra-performing-remote-command-injection-with-root.md">Basic and advanced faults via remote command injection with root </a></li></ul></td>
</tr>
</table>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"position": 4,
"label": "VMware - Linux",
"collapsible": true,
"collapsed": true,
"link":{
"type":"generated-index",
"title":"VMware - Linux"
},
"customProps": {
"description": "VMware faults executed on Linux agent"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: VMware CPU hog
redirect_from:
- /docs/chaos-engineering/technical-reference/chaos-faults/vmware/vmware-cpu-hog
- /docs/chaos-engineering/chaos-faults/vmware/vmware-cpu-hog
- /docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-cpu-hog
---

VMware CPU hog applies stress on the CPU resources on Linux OS based VMware VM. It checks the performance of the application running on the VMware VMs.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ stringData:
<tr>
<td> CPU_CORES </td>
<td> Number of CPU cores that are subject to CPU stress.</td>
<td> Defaults to 1. For more information, go to <a href="https://developer.harness.io/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-cpu-hog/#cpu_cores"> CPU cores. </a></td>
<td> Defaults to 1. For more information, go to <a href="https://developer.harness.io/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/linux/vmware-cpu-hog/#cpu_cores"> CPU cores. </a></td>
</tr>
<tr>
<td> TOTAL_CHAOS_DURATION </td>
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,107 @@
---
title: Permissions Required
sidebar_position: 1
---

The table below describes the permissions required to inject fault into VMware.

<table>
<tr>
<th> Chaos agent deployment model </th>
<th> Centralized chaos agent on Kubernetes (leverage VMware tools to inject chaos processes inside the guest VM) </th>
</tr>
<tr>
<th> Connectivity requirements from agent </th>
<td> <ul><li>Outbound over port 443 to Harness from Kubernetes cluster</li>
<li>Outbound over 443 to vCenter from Kubernetes cluster</li>
<li>Outbound to application health endpoints (ones which will be used for resilience validation) from kubernetes cluster. </li></ul></td>
</tr>
<tr>
<th> Connectivity requirements from VM/cluster/app </th>
<td> <ul><li>Inbound over port 443 on ESX Host (from Kubernetes chaos agent).</li></ul> </td>
</tr>
<tr>
<th> Access requirements for agent install </th>
<td><ul><li>Install agent as a cluster-admin or as a user mapped to cluster role with <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/kubernetes/permissions/Kubernetes%20chaos%20agent%20installation%20access%20requirements"> these </a> permissions. </li></ul></td>
</tr>

<tr>
<th> Access requirements for basic chaos experiments </th>
<td> <ul> <li>vCenter user should be mapped to a predefined <a href="https://hce-docs.github.io/platform-wise-chaos-info/VMware/vcenter-based-chaos-user-access-requirements.md"> chaos </a> role </li>
<li> VMware tools should be setup on the VM </li>
<li>Remote command injection can be performed with non-administrator user</li></ul></td>
</tr>
<tr>
<th> Access requirements for advanced chaos experiments </th>
<td> <ul> <li>vCenter user should be mapped to a predefined <a href="https://hce-docs.github.io/platform-wise-chaos-info/VMware/vcenter-based-chaos-user-access-requirements.md"> chaos </a> role </li>
<li> VMware tools should be setup on the VM </li>
<li>Remote command injection can be performed with administrator user</li></ul></td>
</tr>
<tr>
<th> Supported chaos faults </th>
<td> <ul><li> <a href="https://github.com/hce-docs/platform-wise-chaos-info/blob/main/VMware/WindowsOS/basic-faults-supported-by-kubernetes-infra-performing-remote-command-injection-with-non-administrator-user.md">Basic faults via remote command injection with non-administrator user </a></li>
<li> <a href="https://github.com/hce-docs/platform-wise-chaos-info/blob/main/VMware/WindowsOS/all-supported-faults-by-kubernetes-infra-performing-remote-command-injection-with-administrator.md"> Basic and advanced faults via remote command injection with administrator </a></li></ul></td>
</tr>
</table>


## vCenter Based Chaos User-Access Requirements

- **Datastore**
- Browse datastore

- **Global**
- Cancel task

- **Scheduled task**
- Create tasks
- Modify task
- Remove task
- Run task

- **vApp**
- Power off
- Power on

- **Virtual machine**
- Change Configuration
- Acquire disk lease
- Add existing disk
- Add new disk
- Add or remove device
- Advanced configuration
- Change CPU count
- Change Memory
- Change Settings
- Change resource
- Modify device settings
- Remove disk
- Rename
- Reset guest information
- Upgrade virtual machine compatibility

- **Guest operations**
- Guest operation alias modification
- Guest operation alias query
- Guest operation modifications
- Guest operation program execution
- Guest operation queries

- **Interaction**
- Answer question
- Configure CD media
- Configure floppy media
- Connect devices
- Console interaction
- Guest operating system management by VIX API
- Install VMware Tools
- Power off
- Power on
- Reset
- Suspend

- **Snapshot management**
- Create snapshot
- Remove snapshot
- Rename snapshot
- Revert to snapshot
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"position": 2,
"label": "VMware - vCenter",
"collapsible": true,
"collapsed": true,
"link":{
"type":"generated-index",
"title":"VMware - vCenter "
},
"customProps": {
"description": "VMware faults executed on vCenter"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@ title: VMware disk loss
redirect_from:
- /docs/chaos-engineering/technical-reference/chaos-faults/vmware/vmware-disk-loss
- /docs/chaos-engineering/chaos-faults/vmware/vmware-disk-loss
- /docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-disk-loss
---

VMware disk loss detaches the disks that are attached to a Linux OS based VMware VM.

![VMware Disk Loss](./static/images/vmware-disk-loss.png)

:::info note
HCE doesn't support injecting VMWare Windows faults on Bare metal server.
Harness CE doesn't support injecting VMWare Windows faults on Bare metal server.
:::

## Use cases
Expand Down Expand Up @@ -50,7 +51,7 @@ stringData:
<tr>
<td> APP_VM_MOIDS </td>
<td> MOIDs of the VMware instance. After you open the VM in VCenter WebClient, you can find the MOID in the address field (VirtualMachine:vm-5365). Alternatively you can use the CLI to fetch the MOID. </td>
<td> For example, <code>vm-5365</code>. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/VMware-vm-power-off#stoppoweroff-the-vm-by-moid"> MOIDs of the VMware instance.</a></td>
<td> For example, <code>vm-5365</code>. For more information, go to <a href="/docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vCenter/VMware-vm-power-off#stoppoweroff-the-vm-by-moid"> MOIDs of the VMware instance.</a></td>
</tr>
<tr>
<td> VIRTUAL_DISK_NAMES </td>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ title: VMware host reboot
redirect_from:
- /docs/chaos-engineering/technical-reference/chaos-faults/vmware/vmware-host-reboot
- /docs/chaos-engineering/chaos-faults/vmware/vmware-host-reboot
- /docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-host-reboot
---
VMware host reboot reboots a VMware host that is attached to the Vcenter.
- It helps determine the VMware infrastructure resilience when the host reboots.
Expand All @@ -12,7 +13,7 @@ VMware host reboot reboots a VMware host that is attached to the Vcenter.
![VMware Host Reboot](./static/images/vmware-host-reboot.png)

:::info note
HCE doesn't support injecting VMWare Windows faults on Bare metal server.
Harness CE doesn't support injecting VMWare Windows faults on Bare metal server.
:::

## Use cases
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,15 @@ redirect_from:
- /docs/chaos-engineering/technical-reference/chaos-faults/vmware/vmware-vm-power-off
- /docs/chaos-engineering/technical-reference/chaos-faults/vmware/vm-poweroff
- /docs/chaos-engineering/chaos-faults/vmware/vmware-vm-power-off
- /docs/chaos-engineering/use-harness-ce/chaos-faults/vmware/vmware-vm-power-off
---

VMware VM power off stops (or powers off) the VMware VMs for a specific duration. After the duration, the VMs are back to original state. It checks the performance of the application running on the VMware VMs.

![VMware VM Power off](./static/images/vmware-vm-poweroff.png)

:::info note
HCE doesn't support injecting VMWare Windows faults on Bare metal server.
Harness CE doesn't support injecting VMWare Windows faults on Bare metal server.
:::

## Use cases
Expand Down
Loading
Loading