[WIP] Add notes running vmware simulator #532

kbrock · 2023-11-27T22:38:03Z

Here are notes on running the vmware simulator

not sure if we want this in the providers or developer_setup directory

kbrock · 2023-11-27T22:40:48Z

Had tried to default the historical intervals via vmware/govmomi#3191 but wasn't able to get that working.

miq-bot · 2023-11-27T22:45:41Z

Checked commit kbrock@98c2777 with ruby 2.7.8, rubocop 1.56.3, haml-lint 0.51.0, and yamllint
0 files checked, 0 offenses detected
Everything looks fine. ⭐

kbrock · 2023-12-07T21:23:29Z

I put in a fix for the editing for the file, but the reset remains

vmware/govmomi#3303

agrare · 2023-12-07T21:32:41Z

@kbrock testing historical metrics collection is probably more "niche" compared with what the average developer would use this for?
What if the primary documentation is to go install github.com/vmware/govmomi/govc@latest and then vcsim -username root -password vmware ... ? Maybe we put the instructions for historical intervals in the manageiq-providers-vmware README?

agrare · 2023-12-07T21:33:53Z

providers/vmware_simulator.md

+# creating simulator provider
+
+```bash
+echo "127.0.0.1 vc91" > /etc/hosts


Is this necessary? You can just use localhost or 127.0.0.1 when adding the provider

(I know you were trying to avoid hostname collisions with >1 vcsim but that's also more advanced than the typical UI dev will need)

in the end of the day, vc91 (even if in /etc/hosts) was freaking out, so I just use localhost.

Fryguy · 2023-12-07T21:34:05Z

providers/vmware_simulator.md

+# run
+
+```bash
+# I dumped to a local directory to add historical capture support


Let's try to make the doc less of a brain dump and more of a guide to others. I'm not sure what this is supposed to me as an outside reader.

Fryguy · 2023-12-07T21:35:37Z

providers/vmware_simulator.md

@@ -0,0 +1,98 @@
+# installing vmware simulator


I think we need an introduction of some sort.

Suggested change

# installing vmware simulator

# VMware Simulator

This guide explains general usage of the VMware simulator, `vcsim`. This simulator can be used when developing the VMware provider.

## Installing VMware Simulator

Note the title case change at the end too.

Fryguy · 2023-12-07T21:36:55Z

providers/vmware_simulator.md

+ln -s ~/go/bin/govc ~/bin  # or /usr/local/bin
+```
+
+# creating simulator provider


Suggested change

# creating simulator provider

## Generating data for a simulated provider

Fryguy · 2023-12-07T21:37:30Z

providers/vmware_simulator.md

+kill %1 # or fg ; control-c
+```
+
+# adding historicals


Thinking this should be another level deep under the "Running a simulator"

Suggested change

# adding historicals

### Including historical metrics data

Fryguy · 2023-12-07T21:37:37Z

providers/vmware_simulator.md

+# adding historicals
+
+```xml
+<!--


Suggested change

<!--

<!--

Fryguy · 2023-12-07T21:37:43Z

providers/vmware_simulator.md

+
+export GOVC_URL=https://root:vmware@vc91:9191/sdk GOVC_INSECURE=true
+govc object.save -d my-vcenter
+# stop stop temporary simulator


Suggested change

# stop stop temporary simulator

# stop temporary simulator

Fryguy · 2023-12-07T21:38:42Z

providers/vmware_simulator.md

+    </val>
+  </propSet>
+```
+# better editing of historicals


I'm not sure what this title means - feels like this is part of the previous section, so thinking it should just be removed. The TODO also make it clear of the intentions.

Suggested change

# better editing of historicals

Fryguy · 2023-12-07T21:38:59Z

providers/vmware_simulator.md

+```
+# better editing of historicals
+
+TODO: please figure out a way to add historicals without editing the files.


Suggested change

TODO: please figure out a way to add historicals without editing the files.

TODO: Figure out a way to add historicals without editing the files.

Fryguy · 2023-12-07T21:40:02Z

providers/vmware_simulator.md

+  govc object.collect -s -dump PerformanceManager:PerfMgr perfCounter
+```
+
+# run


Suggested change

# run

## Running the simulated provider from the generated data

agrare · 2023-12-07T21:40:03Z

providers/vmware_simulator.md

+vcsim -username root -password vmware -app 2 -cluster 2 -dc 1 -ds 2 -folder 2 \
+      -host 2 -nsx 2 -pg 2 -pg-nsx 2 -pod 2 -pool 1 -standalone-host 2 -vm 2 \
+      -l vc91:9191 &


Why run in the backround? Seems much simpler to leave it running in the foreground and let people ctrl-c to exit than telling them to do kill %1 later

It's run in the background so it can be dumped to a directory in the next step. Then it can be reused in future runs of the simulator.

I've made a few comments around this to beef up the comments/titles, which would make that clearer.

Right but that's only necessary so that you can hack in historical metrics, for normal vcsim running it isn't needed

this is all moot now. vcsim out of the box properly creates those entries

Fryguy · 2023-12-07T21:41:37Z

providers/vmware_simulator.md

+export GOVC_URL=https://root:vmware@vc91:9191/sdk GOVC_INSECURE=true
+govc object.save -d my-vcenter


Suggested change

export GOVC_URL=https://root:vmware@vc91:9191/sdk GOVC_INSECURE=true

govc object.save -d my-vcenter

# dump simulator contents to a directory for later reuse

export GOVC_URL=https://root:vmware@vc91:9191/sdk GOVC_INSECURE=true

govc object.save -d my-vcenter

Fryguy · 2023-12-07T21:42:02Z

providers/vmware_simulator.md

+```xml
+<!--
+  edit my-vcenter/0009-PerformanceManager-PerfMgr.xml
+  find nistoricalInterval


Suggested change

find nistoricalInterval

find historicalInterval

Fryguy · 2023-12-07T21:46:07Z

providers/vmware_simulator.md

+vcsim -username root -password vmware -app 2 -cluster 2 -dc 1 -ds 2 -folder 2 \
+      -host 2 -nsx 2 -pg 2 -pg-nsx 2 -pod 2 -pool 1 -standalone-host 2 -vm 2 \
+      -l vc91:9191 &


Not required, but I tend to find guides more readable if they are one param per line (at least for very long sets of options). It also allows easier modification for things like removing lines.

Suggested change

vcsim -username root -password vmware -app 2 -cluster 2 -dc 1 -ds 2 -folder 2 \

-host 2 -nsx 2 -pg 2 -pg-nsx 2 -pod 2 -pool 1 -standalone-host 2 -vm 2 \

-l vc91:9191 &

vcsim \

-username root \

-password vmware \

-app 2 \

-cluster 2 \

-dc 1 \

-ds 2 \

-folder 2 \

-host 2 \

-nsx 2 \

-pg 2 \

-pg-nsx 2 \

-pod 2 \

-pool 1 \

-standalone-host 2 \

-vm 2 \

-l vc91:9191 &

Fryguy · 2023-12-07T21:49:40Z

providers/vmware_simulator.md

+ln -s ~/go/bin/vcsim ~/bin # or /usr/local/bin
+ln -s ~/go/bin/govc ~/bin  # or /usr/local/bin


Personal preference, so not required for merge, but this format always messes with my head cause it makes me think the entire bin dir is going to be pointing to the target. I like it more explicit...something like:

Suggested change

ln -s ~/go/bin/vcsim ~/bin # or /usr/local/bin

ln -s ~/go/bin/govc ~/bin # or /usr/local/bin

ln -s ~/go/bin/vcsim ~/bin/vcsim # or /usr/local/bin/vcsim

ln -s ~/go/bin/govc ~/bin/govc # or /usr/local/bin/govc

Wouldn't it make more sense to either change your GOPATH or add ~/go/bin/ to your PATH?

Fryguy · 2023-12-07T21:50:48Z

providers/vmware_simulator.md

+git clone https://github.com/kbrock/govmomi
+cd govmomi
+git remote add upstream  https://github.com/vmware/govmomi
+git checkout miq_counters_kb


Should we be linking a personal fork/branch in the guides? Is this a missing feature on upstream?

agreed. we can now use master now that this is all merged

agrare · 2023-12-07T21:52:29Z

@Fryguy @kbrock high level I'm wondering if we're trying to show devs how to run a vmware simulator, or show them how to patch in @kbrock 's metrics fix?

This all would be drastically simpler and I think cover 90% of the use cases if we just say go install ... and vcsim ... and when his fix is merged upstream then we don't need to do anything to be able to support metrics.

Fryguy · 2023-12-08T00:57:42Z

Oh yeah I thought this was "how to use VMware simulator" with an added "and dump to a directory that can be reused".

Fryguy · 2023-12-08T01:00:31Z

Actually now that you said that, I'm thinking this entire doc should probably be in the VMware repo in the Readme or in a docs dir, and then here maybe only a link to it from a "testing providers" doc or something.

agrare · 2023-12-08T01:01:58Z

#532 (comment) 😉

Fryguy · 2023-12-08T14:33:06Z

Oh yeah I saw that, but I read it as "leave the base one here and puts the metrics one over there", whereas I'm saying, "put the entire doc over there with the metrics too"

kbrock · 2023-12-08T17:19:34Z

Any time I locally run metrics, I hit a gap which is historical, so it blows up.
Once they merge Add default Historical Intervals to the simulator vmware/govmomi#3303 - we will be running master version of vimsim. I really want to run their container version.

kbrock · 2024-02-23T19:59:44Z

WIP:
TODO: change to drop the editing of files, dumping of entries, and using non standard git location.

miq-bot · 2024-05-27T00:00:08Z

This pull request has been automatically marked as stale because it has not been updated for at least 3 months.

If these changes are still valid, please remove the stale label, make any changes requested by reviewers (if any), and ensure that this issue is being looked at by the assigned/reviewer(s).

miq-bot · 2024-09-09T00:00:47Z

This pull request has been automatically marked as stale because it has not been updated for at least 3 months.

If these changes are still valid, please remove the stale label, make any changes requested by reviewers (if any), and ensure that this issue is being looked at by the assigned/reviewer(s).

vmware_simulator

98c2777

kbrock added the developer label Nov 27, 2023

Fryguy assigned agrare Dec 6, 2023

agrare reviewed Dec 7, 2023

View reviewed changes

Fryguy reviewed Dec 7, 2023

View reviewed changes

providers/vmware_simulator.md

# adding historicals

```xml

<!--

Copy link

Member

Fryguy Dec 7, 2023

Choose a reason for hiding this comment

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

Suggested change

<!--

<!--

Fryguy reviewed Dec 7, 2023

View reviewed changes

agrare reviewed Dec 7, 2023

View reviewed changes

Fryguy reviewed Dec 7, 2023

View reviewed changes

kbrock changed the title ~~Add notes running vmware simulator~~ [WIP] Add notes running vmware simulator Feb 23, 2024

kbrock added the wip label Feb 23, 2024

miq-bot added the stale label May 27, 2024

-# installing vmware simulator
+# VMware Simulator
+This guide explains general usage of the VMware simulator, `vcsim`.  This simulator can be used when developing the VMware provider.
+## Installing VMware Simulator

	# creating simulator provider
	## Generating data for a simulated provider

	TODO: please figure out a way to add historicals without editing the files.
	TODO: Figure out a way to add historicals without editing the files.

	# run
	## Running the simulated provider from the generated data

		export GOVC_URL=https://root:vmware@vc91:9191/sdk GOVC_INSECURE=true
		govc object.save -d my-vcenter

-vcsim -username root -password vmware -app 2 -cluster 2 -dc 1 -ds 2 -folder 2 \
-      -host 2 -nsx 2 -pg 2 -pg-nsx 2 -pod 2 -pool 1 -standalone-host 2 -vm 2 \
-      -l vc91:9191 &
+vcsim \
+   -username root \
+   -password vmware \
+   -app 2 \
+   -cluster 2 \
+   -dc 1 \
+   -ds 2 \
+   -folder 2 \
+   -host 2 \
+   -nsx 2 \
+   -pg 2 \
+   -pg-nsx 2 \
+   -pod 2 \
+   -pool 1 \
+   -standalone-host 2 \
+   -vm 2 \
+   -l vc91:9191 &

		ln -s ~/go/bin/vcsim ~/bin # or /usr/local/bin
		ln -s ~/go/bin/govc ~/bin # or /usr/local/bin

[WIP] Add notes running vmware simulator #532

Are you sure you want to change the base?

[WIP] Add notes running vmware simulator #532

Conversation

kbrock commented Nov 27, 2023

kbrock commented Nov 27, 2023

miq-bot commented Nov 27, 2023

kbrock commented Dec 7, 2023

agrare commented Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fryguy Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Fryguy Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fryguy Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Fryguy Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fryguy Dec 7, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

agrare commented Dec 7, 2023

Fryguy commented Dec 8, 2023 • edited Loading

Fryguy commented Dec 8, 2023

agrare commented Dec 8, 2023

Fryguy commented Dec 8, 2023 • edited Loading

kbrock commented Dec 8, 2023

kbrock commented Feb 23, 2024

miq-bot commented May 27, 2024

miq-bot commented Sep 9, 2024

agrare commented Dec 7, 2023 •

edited

Loading

Fryguy Dec 7, 2023 •

edited

Loading

Fryguy Dec 7, 2023 •

edited

Loading

Fryguy Dec 7, 2023 •

edited

Loading

Fryguy Dec 7, 2023 •

edited

Loading

Fryguy Dec 7, 2023 •

edited

Loading

Fryguy commented Dec 8, 2023 •

edited

Loading

Fryguy commented Dec 8, 2023 •

edited

Loading