diff --git a/doc/deployment_guide.md b/doc/deployment_guide.md index 6e20243356dead0147bd57b5a996d617ffa18567..9edfd103625fa429b94a44077a27a85415647055 100644 --- a/doc/deployment_guide.md +++ b/doc/deployment_guide.md @@ -62,6 +62,7 @@ Besides that, the network requirements are essentially the same than that requir As a reference, the other deployment solutions based on VMs assume the VM is connected to a virtual network configured with the IP range `10.0.2.0/24` and have the gateway at IP `10.0.2.1`. The VMs have the IP address `10.0.2.10`. The minimum required ports to be accessible are: + - 22/SSH : for management purposes - 80/HTTP : for the TeraFlowSDN WebUI and Grafana dashboard - 8081/HTTPS : for the CockroachDB WebUI @@ -74,32 +75,33 @@ Other ports might be required if you consider to deploy addons such as Kubernete The recommended Operating System for deploying TeraFlowSDN is [Ubuntu Server 22.04 LTS](https://releases.ubuntu.com/jammy/) or [Ubuntu Server 20.04 LTS](https://releases.ubuntu.com/focal/). Other version might work, but we have not tested them. We strongly recommend using Long Term Support (LTS) versions as they provide better stability. Below we provide some installation guidelines: -- Installation Language: English -- Autodetect your keyboard -- If asked, select "Ubuntu Server" (do not select "Ubuntu Server (minimized)"). -- Configure static network specifications (adapt them based on your particular setup): -|Interface|IPv4 Method|Subnet |Address |Gateway |Name servers |Search domains| -|---------|-----------|-----------|---------|--------|---------------|--------------| -|enp0s3 |Manual |10.0.2.0/24|10.0.2.10|10.0.2.1|8.8.8.8,8.8.4.4|<empty> | - -- Leave proxy and mirror addresses as they are -- Let the installer self-upgrade (if asked). -- Use an entire disk for the installation - - Disable setup of the disk as LVM group - - Double check that NO swap space is allocated in the partition table. Kubernetes does not work properly with SWAP. -- Configure your user and system names: - - User name: `TeraFlowSDN` - - Server's name: `tfs-vm` - - Username: `tfs` - - Password: `tfs123` -- Install Open SSH Server - - Import SSH keys, if any. -- Featured Server Snaps - - Do not install featured server snaps. It will be done manually later to illustrate how to uninstall and reinstall them in case of trouble with. -- Let the system install and upgrade the packages. - - This operation might take some minutes depending on how old is the Optical Drive ISO image you use and your Internet connection speed. -- Restart the VM when the installation is completed. + - Installation Language: English + - Autodetect your keyboard + - If asked, select "Ubuntu Server" (do not select "Ubuntu Server (minimized)"). + - Configure static network specifications (adapt them based on your particular setup): + + |Interface|IPv4 Method|Subnet |Address |Gateway |Name servers |Search domains| + |---------|-----------|-----------|---------|--------|---------------|--------------| + |enp0s3 |Manual |10.0.2.0/24|10.0.2.10|10.0.2.1|8.8.8.8,8.8.4.4|<empty> | + + - Leave proxy and mirror addresses as they are + - Let the installer self-upgrade (if asked). + - Use an entire disk for the installation + - Disable setup of the disk as LVM group + - Double check that NO swap space is allocated in the partition table. Kubernetes does not work properly with SWAP. + - Configure your user and system names: + - User name: `TeraFlowSDN` + - Server's name: `tfs-vm` + - Username: `tfs` + - Password: `tfs123` + - Install Open SSH Server + - Import SSH keys, if any. + - Featured Server Snaps + - Do not install featured server snaps. It will be done manually later to illustrate how to uninstall and reinstall them in case of trouble with. + - Let the system install and upgrade the packages. + - This operation might take some minutes depending on how old is the Optical Drive ISO image you use and your Internet connection speed. + - Restart the VM when the installation is completed. <h3><u>Upgrade the Ubuntu distribution</u></h3> ```bash