Skip to content

Commit c5574ce

Browse files
committed
Updated air gap installation steps.
Signed-off-by: Ankit Agrawal <aagrawal3@vmware.com>
1 parent 46aa57d commit c5574ce

1 file changed

Lines changed: 9 additions & 8 deletions

File tree

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,8 @@ A Python virtual environment is also highly recommended.
4242
* [Install a virtual env for Python 3](https://docs.python.org/3/tutorial/venv.html)
4343

4444
### Installing Required Python Packages
45-
SDK package installation commands may differ depending on the environment where it is installed. The three installation options are provided for different environments. Be sure to upgrade to the latest pip and setuptools.
45+
SDK package installation commands may differ depending on the environment where it is being installed. The three installation options provided below are for different environments.
46+
*pip* and *setuptools* are common requirements for these installation types, upgrade to the latest *pip* and *setuptools*.
4647

4748
**NOTE:** The SDK also requires OpenSSL 1.0.1+ in order to support TLS1.1 & 1.2
4849

@@ -61,25 +62,25 @@ pip install --upgrade git+https://gitlab.eng.vmware.com/vapi-sdk/vsphere-automat
6162
##### 2. Local installation
6263
Local installation can be used in an environment which either do not have Github access or users do not want to install from Github repository.
6364

64-
Install all the wheel files from SDK lib directory
65+
Install all the wheel files from SDK's lib directory
6566
```cmd
6667
pip install -U lib/*/*.whl
6768
```
68-
Install dependencies like lxml and pyvmomi from PyPi as other requirements were installed from SDK lib directory
69+
Install dependencies like *lxml* and *pyvmomi* from PyPI as other requirements were installed from SDK's lib directory
6970
```cmd
7071
pip install -U <SDK_DIRECTORY>
7172
```
7273

7374
##### 3. Installation in an air gap environment
74-
For these type of environment an additional step is required to ensure SDK's dependencies are available.
75-
Following dependencies have to be downloaded from PyPi and transferred to the air gap environment.
75+
For this type of environment an additional step is required to ensure SDK's dependencies are available.
76+
Following dependencies have to be downloaded from PyPI and transferred to the air gap environment.
7677

77-
This step has to be done in an environment which has PyPI access.
78+
**NOTE:** This step has to be done in an environment which has PyPI access.
7879
```cmd
7980
pip download -r requirements_pypi.txt -d lib
8081
zip -r lib.zip lib/
8182
```
82-
Following on the air gap environment.
83+
Follow these steps in the air gap environment.
8384
Unzip the lib.zip under automation SDK home directory
8485
```cmd
8586
unzip lib.zip
@@ -88,7 +89,7 @@ Install all the dependencies and packages
8889
```cmd
8990
pip install -U lib/*/*.whl
9091
```
91-
This is to install the vSphere-Automation-SDK which provides an SDK version. This also ensures that everything the SDK needs is installed. If not this will fail.
92+
This is to install the "vSphere-Automation-SDK" which provides an SDK version. It also ensures that all the SDK requirements are installed. If not, the installation will fail.
9293
```cmd
9394
pip install -U `pwd`
9495
```

0 commit comments

Comments
 (0)