VM Lab Infrastructure in a Box
- A vSphere Environment
- A Class B Network
- Only required if you intend to use the automated 1:1 NAT configuration feature.
- Trunk Ports Allowing VLAN Traffic Between ESXi Hosts
- Only required if you are running a vSphere environment with multiple ESXi hosts.
- A Linux VM capable of running Docker Compose.
- Recommended to have at least 20 Gigabytes of storage.
- Read the Configuration section. Depending on how you want your installation to run, you will need to configure your environment accordingly.
- Run the following command on your Linux VM.
bash <(curl -sfL https://raw.githubusercontent.com/evanjd711/TipocaCity/main/install.sh)- Follow the prompts to configure your environment.
- Add Kamino as an Identity Source to vCenter.
- Navigate to Administration > Single Sign-On > Configuration.
- Click the Identity Sources tab.
- Click Add and choose Open LDAP for Identity Source Type.
- Set the following parameters:
- Identity source name: Kamino
- Base distinguished name for users: ou=users,dc=kamino,dc=labs
- Base distinguished name for groups: ou=groups,dc=kamino,dc=labs
- Domain Name: kamino.labs
- Username: cn=admin,dc=kamino,dc=labs
- Password: (LDAP Admin Password)
- Primary Server URL: ldap://(Kamino FQDN):389
- Click Add.
- If adding Kamino as an Identity Source fails, ensure that your LDAP Admin Password is correct and that your Kamino FQDN is resolvable from your vCenter Server.
- Give Kamino Users read-only permissions to Kamino's parent resource pool.
- Navigate to Inventory > Hosts and Clusters.
- Right click on the parent resource pool and click Add Permission.
- Select the following:
- Domain: kamino.labs
- Group: Kamino Users
- Role: Read-only
All of the following configurations are required for Kamino to function properly. If you do not configure your environment correctly, Kamino will not work as intended.
| Setting | Description | Default Value |
|---|---|---|
| Starting Port Group | The first VLAN to be used by Kamino. | 1801 |
| Ending Port Group | The last VLAN to be used by Kamino. | 4000 |
| HTTPS | Enable HTTPS for Kamino. | true |
| vCenter FQDN | The FQDN of your vCenter Server. | N/A |
| vCenter API Account | The username of the account to be used by Kamino. | N/A |
| vCenter Account Password | The password of the account to be used by Kamino. | N/A |
| vCenter Datacenter | The name of the datacenter to be used by Kamino. | N/A |
| vCenter Cluster | The name of the cluster or host to be used by Kamino. | N/A |
| vSphere Distributed Switch | The name of the distributed switch to be used by Kamino. | N/A |
| Parent Resource Pool | The name of the resource pool Kamino will use. | Kamino |
| Template Resource Pool | The name of the resource pool Kamino will use for templates. | Kamino-Templates |
| Clone Resource Pool | The name of the resource pool Kamino will use for clones. | Kamino-Clones |
| Inventory Location | The name of the folder Kamino will use for storing VMs. | Kamino |
| Datastore | The name of the datastore to be used by Kamino for VM storage. | N/A |
| WAN Port Group | The name of the port group to be used by Kamino for WAN connectivity. This port group should be able to directly access your Class B Network. | N/A |
| WAN Network ID | The network ID of your Class B Network. | N/A |
| Kamino Port Group Suffix | Port groups created by Kamino will end in this suffix preceded by an underscore. (e.g. 1801_KaminoNetwork) | KaminoNetwork |
| Maximum Pods per User | The maximum number of pods one user can deploy. | 5 |
| Template Folder | The name of the folder Kamino will use to search for VM templates. | Templates |
| LDAP Admin Password | The password of the LDAP admin account. | N/A |
| Kamino FQDN | The FQDN of the Kamino server. | N/A |
- Kamino uses four digit integers to identify deployed resources (e.g. 1801). This is for organization and easy teardown of resources. It also uses these identifiers for the VLAN IDs of the port groups it creates. This significantly reduces network traffic caused by broadcast traffic; however, if you are running a vSphere environment with multiple ESXi hosts you will need to ensure that your network is configured to allow traffic between these VLANs. The switchports your ESXi's are connected to will need to be configured as trunk ports with all of the VLANs Kamino uses allowed on them.