If you have access to a cloud provider or if you can sign up for one then its very straightforward to create a Ubuntu Linux virtual machine with a ssh server and public IP.
This VM will cost you ~10-20 cents per hour, although you may be able to get a free VM for a limited time - for example this Google Cloud 3-month $300 free credit or 1 month $100 free credit from Digital Ocean.
We will leave it to you to get a VM in the cloud provider of your choice with these features:
- A VM with at least 2 cores CPU and 4GB of RAM
- Ubuntu Linux 20.04 Focal operating system and a username/SSH private key to log into the VM.
- Openssh server running on the VM
- A public IP with firewall access to port 22 (SSH)
If you prefer running the VM on your own PC, read about the Vagrant option.
- Log into the VM and run these commands (as root):
RELEASENAME="main"
date
echo "Installing $RELEASENAME BitBitBus KAT into VM, install logs available at /var/log/"
echo "Step 1: Microk8s and infrastructure components"
curl -L -s https://raw.githubusercontent.com/BigBitBusInc/kubernetes-automation-toolkit/$RELEASENAME/code/local-kubernetes-cluster-installation/install-microk8s-on-ubuntu.sh | bash | tee /var/log/bigbitbus-microk8s-install.log
echo "Step 2: Application code"
curl -L -s https://raw.githubusercontent.com/BigBitBusInc/kubernetes-automation-toolkit/$RELEASENAME/code/local-kubernetes-cluster-installation/install-application-stack.sh | bash -s $RELEASENAME | tee /var/log/bigbitbus-kat-application-code-install.log
echo "Kubeconfig (don't print/share this in production)"
microk8s config- Logout and SSH port-forward localhost:8080 from your host into the VM's localhost:80.
For example (Mac, Linux)
ssh -i private_key_file theuser@publicip -L 8080:localhost:80 -N
For Windows, see this file on how to setup Putty for port forwarding.
You can now open a web-browser and reach these end-points
- Todo application Vuejs Frontend http://localhost:8080/frontend/ Learn more
- Todo application browsable API http://localhost:8080/djangoapi/apis/v1/ Learn more
- Kubernetes Dashboard http://localhost:8080/dashboard/ Learn more (Access token is printed in the Vagrant output as mentioned above).
- Grafana Monitoring http://localhost:8080/monitoring-grafana/ Learn more (default credentials: admin/prom-operator)
- Get the ssh-configuration snippet for your cloud VM and add it to your
~/.ssh/configfile (learn more about ssh config files here).
Confirm that you can now log into the Vagrant VM by simply typing ssh vmname-in-ssh-config on the commandline.
- Once you are logged into the VM there are many things to do
- Launch k9s from the terminal and surf your Kubernetes cluster and all its objects.
- If you prefer using the official Kubernetes CLI then read the
kubectlcheat-sheet here.
- Head over to our documentation to learn the concepts and start understanding the code behind the components..
The next steps are optional but very useful if you are planning to get productive as a developer
-
We assume you use the Microsoft VS Code Editor in this tutorial, please install the Remote - SSH plugin. This will allow us to browse and control the Vagrant VM via SSH.
-
Open VS Code and configure it to connect remotely to the Vagrant VM. Load up the KAT code in the home directory of the Vagrant user. Tweak it, break it, fix it and choose whether this way of development will work for you!
Please delete the Virtual Machine after you are done to avoid unneccessary charges to your cloud account.