Gateway
To facilitate the installation of Kubernetes cluster into private data centers without a direct incoming connection from the management console, a gateway is necessary. Users can install the gateway by deploying an OVF in vSphere vCenter, retrieved from the controller
Prerequisites¶
Assure to have the below pre-requisites
- Resource pool configured
- VMware account permissions
- Network segment and Datastore availability
VMware Account Permissions¶
| S.No | Object | Permissions |
|---|---|---|
| 1 | Datastore | AllocateSpace |
| Browse | ||
| FileManagement (Low level file operations) | ||
| UpdateVirtualMachineFiles | ||
| UpdateVirtualMachineMetadata | ||
| Remove file | ||
| 2 | Network | Assign |
| 3 | Resource | AssignVMToPool |
| 4 | Virtual Machine | Config (All) |
| GuestOperations (All) | ||
| Interact (All) | ||
| Inventory (All) | ||
| Provisioning (All) | ||
| 5 | Folder | Create Folder |
| Delete Folder | ||
| Move Folder | ||
| Rename Folder | ||
| 6 | Tasks | Create Task |
| Update Task | ||
| 7 | vApp | Import |
| Export | ||
| View OVF environment | ||
| vApp application configuration | ||
| vApp instance configuration |
Important
Ensure the firewall allows the gateway VM to communicate with vCenter API
Step 1: Create Gateway¶
- Click Gateway on the left panel under the Infrastructure. Gateway page appears
- Click New Gateway
- Provide a name and description
- Gateway Type Vmware is selected by default
- Click Create
Once created, you can view the gateway listed as shown below.
- Click View Details (or) download the file to get the OVF URL and the other details. Copy the OVF URL to deploy the gateway in vCenter
Next step is to install the gateway by deploying this OVF in vSphere vCenter
Step 2: Deploy OVF in Vcenter¶
Perform the below steps to deploy the OVF in vCenter, and create a connection between the vCenter and controller to create VMware clusters
- Login to the vCenter and right-click on the datacenter
- Select Deploy OVF Template
- Copy/paste the OVF URL in the URL field and click Next
- Click Yes for the source verification and proceed
- Provide a name for the VM and select a location to deploy this VM. Below is an example of location with workload
- Click Next
- Select a Compute Resource to allocate the resource pool for the VM and click Next
- Review Details screen appears showing the disk size and other details. Click Next
- Select the required storage to store the VM related resources and click Next
- Click the drop-down and select the required network (or) click Browse to view all the available networks and select one to deploy the VM
- Click Next
-
Customize Template screen appears with a form, asking for the below details:
- Gateway Agent ID
- Console endpoint (example: https://console.rafay.dev)
- Gateway Token
- Bootstrap Repo URL, the repo path where the bootstrap files are present
These three (4) pieces of information authorize the connectivity between vCenter and controller.
- Copy/paste the details from the controller
- Provide VM Static IP Configuration as shown below
- Add the proxy configuration details if required
- Click Next
- A preview of all the information provided appears. Click Finish to complete the process
- The progress of VM deployment appears in the Recent Tasks as shown in the below example
This completes the process