# Salt Extension Modules for VMware
This is a collection of Salt-maintained extension modules for use with VMware
vSphere, vCenter, ESXi, and friends.
## Security
If you think you've found a security vulnerability, see [Salt's security guide][security].
## User Documentation
This README is more for contributing to the project. If you just want to get
started, check out the [User Documentation][docs]. Note: See the [Managing VMC SDDC with Salt][vmc-docs] section
for more information about how to configure `properties required for VMC operations`
## Contributing
The salt-ext-modules-vmware project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).
The [Salt Contributing guide][salt-contributing] has a lot of relevant information, but if you'd like to jump right in here's how to get started:
# Clone the repo
git clone --origin salt git@github.com:saltstack/salt-ext-modules-vmware.git
# Change to the repo dir
cd salt-ext-modules-vmware
# Create a new venv, after sourcing activate `python` will refer to python3.
python3 -m venv env --prompt vmw-ext
source env/bin/activate
# On mac, you may need to upgrade pip
python -m pip install --upgrade pip
# On WSL or some flavors of linux you may need to install the `enchant`
# library in order to build the docs
sudo apt-get install -y enchant
# Install extension + test/dev/doc dependencies into your environment
python -m pip install -e .\[tests,dev,docs\]
# Run tests!
python -m nox -e tests-3
# skip requirements install for next time
export SKIP_REQUIREMENTS_INSTALL=1
# Build the docs, serve, and view in your web browser:
python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)
# If you want to run tests against an actual vCenter:
# 1. Make a local salt dir
mkdir -p local/etc/salt
# 2. Make a local dir for salt state files
mkdir -p local/srv/salt
# 3. Make a local dir for salt pillar files
mkdir -p local/srv/pillar
# 4. Create a minion config
cat << EOF> local/etc/salt/minion
user: $(whoami)
root_dir: $PWD/local/
file_root: $PWD/local
master: localhost
id: saltdev
master_port: 55506
pillar_roots:
base:
- $PWD/local/srv/pillar
EOF
# 5. Make a Saltfile
cat << EOF> Saltfile
salt-call:
local: true
config_dir: local/etc/salt
EOF
# 6. Create a pillar file for you configuration
cat << EOF> local/srv/my_vsphere_conf.sls
# vCenter
saltext.vmware:
# Or use IP address, e.g. 203.0.113.42
host: vsphere.example.com
password: CorrectHorseBatteryStaple
user: BobbyTables
EOF
# 7. Create a pillar top file
cat << EOF> local/srv/pillar.sls
base:
saltdev:
- my_vsphere_conf
EOF
# 8. (deprecated but not removed yet) If you're contributing to the project and need to run the tests, create a test config file:
python tools/test_value_scraper.py -c local/vcenter.conf
# 9. (deprecated but not removed yet) Create a test config file for VMC:
python tools/test_value_scraper_vmc.py --help
This command will return the required information.
For code contributions, as part of VMware we require [a signed CLA][cla-faq].
If you've already signed the VMware CLA, you're probably good to go.
Of course, writing code isn't the only way to contribute! We value
contributions in any of these areas:
- Documentation - especially examples of how to use this module to solve
specific problems.
- Triaging [issues][issues] and participating in [discussions][discussions]
- Reviewing [Pull Requests][PRs] (we really like [Conventional
Comments][comments]!)
You could also contribute in other ways:
- Writing blog posts
- Posting on social media about how you used Salt+VMware to solve your
problems, including videos
- Giving talks at conferences
- Publishing videos
- Asking/answering questions in IRC, Slack, or email groups
Any of these things are super valuable to our community, and we sincerely
appreciate every contribution!
For more information, build the docs and head over to http://localhost:8000/ —
that's where you'll find the rest of the documentation.
[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md
[salt-contributing]: https://docs.saltproject.io/en/master/topics/development/contributing.html
[issues]: https://github.com/saltstack/salt-ext-modules-vmware/issues
[PRs]: https://github.com/saltstack/salt-ext-modules-vmware/pulls
[discussions]: https://github.com/saltstack/salt-ext-modules-vmware/discussions
[comments]: https://conventionalcomments.org/
[cla-faq]: https://cla.vmware.com/faq
[docs]: https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/index.html
[vmc-docs]: https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/vmc.html
Raw data
{
"_id": null,
"home_page": "https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/index.html",
"name": "saltext.vmware",
"maintainer": "Joey Gibson",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "joey@vmware.com",
"keywords": "salt-extension",
"author": "VMware, Inc.",
"author_email": "joey@vmware.com",
"download_url": "",
"platform": "any",
"description": "# Salt Extension Modules for VMware\n\nThis is a collection of Salt-maintained extension modules for use with VMware\nvSphere, vCenter, ESXi, and friends.\n\n## Security\n\nIf you think you've found a security vulnerability, see [Salt's security guide][security].\n\n## User Documentation\n\nThis README is more for contributing to the project. If you just want to get\nstarted, check out the [User Documentation][docs]. Note: See the [Managing VMC SDDC with Salt][vmc-docs] section\nfor more information about how to configure `properties required for VMC operations`\n\n\n## Contributing\n\nThe salt-ext-modules-vmware project team welcomes contributions from the community. If you wish to contribute code and you have not signed our contributor license agreement (CLA), our bot will update the issue when you open a Pull Request. For any questions about the CLA process, please refer to our [FAQ](https://cla.vmware.com/faq).\n\nThe [Salt Contributing guide][salt-contributing] has a lot of relevant information, but if you'd like to jump right in here's how to get started:\n\n # Clone the repo\n git clone --origin salt git@github.com:saltstack/salt-ext-modules-vmware.git\n\n # Change to the repo dir\n cd salt-ext-modules-vmware\n\n # Create a new venv, after sourcing activate `python` will refer to python3.\n python3 -m venv env --prompt vmw-ext\n source env/bin/activate\n\n # On mac, you may need to upgrade pip\n python -m pip install --upgrade pip\n\n # On WSL or some flavors of linux you may need to install the `enchant`\n # library in order to build the docs\n sudo apt-get install -y enchant\n\n # Install extension + test/dev/doc dependencies into your environment\n python -m pip install -e .\\[tests,dev,docs\\]\n\n # Run tests!\n python -m nox -e tests-3\n\n # skip requirements install for next time\n export SKIP_REQUIREMENTS_INSTALL=1\n\n # Build the docs, serve, and view in your web browser:\n python -m nox -e docs && (cd docs/_build/html; python -m webbrowser localhost:8000; python -m http.server; cd -)\n\n # If you want to run tests against an actual vCenter:\n\n # 1. Make a local salt dir\n mkdir -p local/etc/salt\n\n # 2. Make a local dir for salt state files\n mkdir -p local/srv/salt\n\n # 3. Make a local dir for salt pillar files\n mkdir -p local/srv/pillar\n\n # 4. Create a minion config\n cat << EOF> local/etc/salt/minion\n user: $(whoami)\n root_dir: $PWD/local/\n file_root: $PWD/local\n master: localhost\n id: saltdev\n master_port: 55506\n pillar_roots:\n base:\n - $PWD/local/srv/pillar\n EOF\n\n # 5. Make a Saltfile\n cat << EOF> Saltfile\n salt-call:\n local: true\n config_dir: local/etc/salt\n EOF\n\n # 6. Create a pillar file for you configuration\n cat << EOF> local/srv/my_vsphere_conf.sls\n # vCenter\n saltext.vmware:\n # Or use IP address, e.g. 203.0.113.42\n host: vsphere.example.com\n password: CorrectHorseBatteryStaple\n user: BobbyTables\n EOF\n\n # 7. Create a pillar top file\n cat << EOF> local/srv/pillar.sls\n base:\n saltdev:\n - my_vsphere_conf\n EOF\n\n # 8. (deprecated but not removed yet) If you're contributing to the project and need to run the tests, create a test config file:\n python tools/test_value_scraper.py -c local/vcenter.conf\n\n # 9. (deprecated but not removed yet) Create a test config file for VMC:\n python tools/test_value_scraper_vmc.py --help\n This command will return the required information.\n\n\nFor code contributions, as part of VMware we require [a signed CLA][cla-faq].\nIf you've already signed the VMware CLA, you're probably good to go.\n\nOf course, writing code isn't the only way to contribute! We value\ncontributions in any of these areas:\n\n- Documentation - especially examples of how to use this module to solve\n specific problems.\n- Triaging [issues][issues] and participating in [discussions][discussions]\n- Reviewing [Pull Requests][PRs] (we really like [Conventional\n Comments][comments]!)\n\nYou could also contribute in other ways:\n\n- Writing blog posts\n- Posting on social media about how you used Salt+VMware to solve your\n problems, including videos\n- Giving talks at conferences\n- Publishing videos\n- Asking/answering questions in IRC, Slack, or email groups\n\nAny of these things are super valuable to our community, and we sincerely\nappreciate every contribution!\n\n\nFor more information, build the docs and head over to http://localhost:8000/ \u2014\nthat's where you'll find the rest of the documentation.\n\n\n[security]: https://github.com/saltstack/salt/blob/master/SECURITY.md\n[salt-contributing]: https://docs.saltproject.io/en/master/topics/development/contributing.html\n[issues]: https://github.com/saltstack/salt-ext-modules-vmware/issues\n[PRs]: https://github.com/saltstack/salt-ext-modules-vmware/pulls\n[discussions]: https://github.com/saltstack/salt-ext-modules-vmware/discussions\n[comments]: https://conventionalcomments.org/\n[cla-faq]: https://cla.vmware.com/faq\n[docs]: https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/index.html\n[vmc-docs]: https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/vmc.html\n",
"bugtrack_url": null,
"license": "Apache Software License",
"summary": "Salt Extension Modules for VMware",
"version": "23.6.29.0rc1",
"project_urls": {
"Homepage": "https://docs.saltproject.io/salt/extensions/salt-ext-modules-vmware/en/latest/index.html",
"Source": "https://github.com/saltstack/salt-ext-modules-vmware",
"Tracker": "https://github.com/saltstack/salt-ext-modules-vmware/issues"
},
"split_keywords": [
"salt-extension"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d0d6daf9f360e482f863778cc9702281576f8e267c1fd821a880ee9e68f59d91",
"md5": "3834f025005bc0fcb662f3e9ceee17d4",
"sha256": "409f590c7dc91700c31c022303f449f9b80a55df924cbd52229a660a0c9b9649"
},
"downloads": -1,
"filename": "saltext.vmware-23.6.29.0rc1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "3834f025005bc0fcb662f3e9ceee17d4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 397687,
"upload_time": "2023-06-29T19:15:19",
"upload_time_iso_8601": "2023-06-29T19:15:19.004621Z",
"url": "https://files.pythonhosted.org/packages/d0/d6/daf9f360e482f863778cc9702281576f8e267c1fd821a880ee9e68f59d91/saltext.vmware-23.6.29.0rc1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 19:15:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "saltstack",
"github_project": "salt-ext-modules-vmware",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "saltext.vmware"
}
JSON
