Merge branch 'docs-remote-k3d' into 'master'

Docs remote k3d

See merge request platform-one/big-bang/umbrella!64

docs/developer_setup.md

+## So you want to develop on Big Bang Umbrella?
+
+Included here is a setup that will allow you to checkout and begin development using your workstation and a minimal EC2 instance in AWS.
+
+### Prequisites
+
++ AWS access (with permissions to create an EC2 instance)
++ Flux CLI installed on your local machine
++ Access to the Umbrella Git Repo
++ kubectl installed on local machine
++ yq installed on local machine
+
+### Manual Creation of a Development Environment
+
+This section will cover the creation of an environment manually. This is a good place to start because it creates an understanding of everything that the automated method does for you.
+
+Step 1: Create an Ubuntu 20.04 xlarge EC2 instance with the following attributes:  
+        (see addendum for using Amazon Linux2 - but it really does not matter)
+
++ 50 Gigs of disk space
++ IAM Role: InstanceOpsRole  (this will add support for sops encryption with KMS)
++ A security group that allows all TCP traffic from your IP address.
++ The following in the User Data
+
+```
+MIME-Version: 1.0
+Content-Type: multipart/mixed; boundary="==MYBOUNDARY=="
+
+--==MYBOUNDARY==
+Content-Type: text/x-shellscript; charset="us-ascii"
+
+#!/bin/bash
+sysctl -w vm.max_map_count=262144
+```
+
+** The user data in this case will set the vm.max_map_count to 262144. This is required for Elastic to launch and run correctly without OOM errors.
+
+Step 2: SSH into your new EC2 instance and configure it with the following:
+
++ Install Docker CE
+
+```
+#Remove any old Docker items
+sudo apt remove docker docker-engine docker.io containerd runc
+
+#Install all pre-reqs for Docker
+sudo apt update
+sudo apt install apt-transport-https ca-certificates curl     gnupg-agent software-properties-common
+
+#Add the Docker repository, we are installing from Docker and not the 
+#Ubuntu APT repo.
+curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+
+sudo apt-key fingerprint 0EBFCD88
+
+sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+
+#Install Docker
+sudo apt update
+sudo apt install docker-ce docker-ce-cli containerd.io
+
+#Add your base user to the Docker group so that you do not need sudo
+#to run docker commands
+sudo usermod -aG docker $USER
+
+** It is important at this point that you log out and back in to 
+** have the user group changes take effect.
+```
+
++ Install K3D on the EC2 instance
+
+```
+wget -q -O - https://raw.githubusercontent.com/rancher/k3d/main/install.sh | bash
+
+k3d //to check the install
+```
+
++ We can now spin up our dev cluster on the EC2 instance using K3D
+
+```
+k3d cluster create -s 1 -a 3  --k3s-server-arg "--disable=traefik" --k3s-server-arg "--disable=metrics-server" --k3s-server-arg "--tls-san=<your-public-ec2-ip>"  -p 80:80@loadbalancer -p 443:443@loadbalancer
+```
+
++ Optionally you can set your image pull secret on the cluster so that you don't have to put your credentials in the code or in the command line in later steps
+
+```
+# create the directory for the k3s registry config.  
+mkdir ~/.k3d/
+
+# create the config file. Use your registry1 credentials. Copy your user name and token secret from your Harbor profile.  
+
+cat << EOF > ~/.k3d/p1-registries.yaml
+configs:
+  "registry1.dsop.io":
+    auth:
+      username: "user.name"
+      password: "place_token_secret_here"
+EOF
+
+k3d cluster create --servers 1 --agents 3 -v ~/.k3d/p1-registries.yaml:/etc/rancher/k3s/registries.yaml --k3s-server-arg "--disable=traefik" --k3s-server-arg "--disable=metrics-server" --k3s-server-arg "--tls-san=<your-public-ec2-ip>"  -p 80:80@loadbalancer -p 443:443@loadbalancer
+```
+
+Here is a break down of what we are doing with this command.
+
+(-s 1) Creating 1 master/server
+
+(-a 3) Creating 3 agent nodes
+
+(--k3s-server-arg "--disable=traefik") Disable the default Traefik Ingress
+
+(--k3s-server-arg "--disable=metrics-server") Disable default metrics
+
+(--k3s-server-arg "--tls-san=<your public ec2 ip>") This adds the public IP to the kubeapi certificate so that you can access it remotely.
+
+(-p 80:80@loadbalancer) Exposes the cluster on the host on port 80
+
+(-p 443:443@loadbalancer) Exposes the cluster on the host on port 443
+
+optional:  
+(-v ~/.k3d/p1-registries.yaml:/etc/rancher/k3s/registries.yaml) volume mount image pull secret config for k3d cluster  
+(--api-port 0.0.0.0:38787) Chooses a port for the API server instead of being assigned a random one. You can set this to any port number that you want.
+
++ Once your cluster is up, you can bring over the kubeconfig from the EC2 instance to your workstation.
+
+```
+cat ~/.kube/config
+```
+
++ Move to your workstation and install Big Bang Umbrella on the cluster
+
+```
+# Test to see if you can connect to your cluster
+
+kubectl get nodes
+
+# From the base of the project 
+
+flux install
+
+kubectl create ns bigbang
+
+kubectl apply -f examples/complete/envs/dev/source-secrets.yaml
+
+# Helm install BigBang umbrella
+
+# Method 1 - go for it. (Note: You don't need to set registryCredentials if you configured registry pull secret on the cluster in previous steps)  
+
+yq r examples/complete/envs/dev/patch-bigbang.yaml 'spec.values' | helm upgrade -i bigbang chart -n bigbang --create-namespace --set registryCredentials.username='<your user>' --set registryCredentials.password=<your cli key> -f -
+
+# Method 2 - Modify some values
+
+yq r examples/complete/envs/dev/patch-bigbang.yaml 'spec.values' > my-values.yaml
+
+# Modify my-values.yaml
+# Install using your new values. You could also modify the values in place. (Note: You don't need to set registryCredentials if you configured registry pull secret on the cluster in previous steps)  
+
+helm upgrade -i bigbang chart -n bigbang --create-namespace --set registryCredentials.username='<your user>' --set registryCredentials.password=<your cli key> -f my-values.yaml
+```
+
++ You can now modify your local /etc/hosts files (Or whatever the Windows people call it these days)
+
+```
+160.1.38.137     kibana.bigbang.dev
+160.1.38.137     kiali.bigbang.dev
+160.1.38.137    prometheus.bigbang.dev
+160.1.38.137    graphana.bigbang.dev
+```
+
++ You can watch your install take place with
+
+```
+watch kubectl get po,gitrepository,kustomizations,helmreleases -A
+```
+
+As of this time, Twistlock is the last thing to be installed. Once you see Twistlock sync and everything else is up and healty you are fully installed.
+
+### Addendum for Amazon Linux 2
+Here are the configuration steps if you want to use a Fedora based instance. All other steps are similar to Ubuntu.
+```
+# update system
+sudo yum update -y
+# install and start docker
+sudo yum install docker -y
+sudo usermod -aG docker $USER
+sudo systemctl enable docker.service 
+sudo systemctl start docker.service 
+# fix docker config for ulimit nofile.
+# this is a bug in the AMI that will eventually be fixed
+sudo sed -i 's/^OPTIONS=.*/OPTIONS=\"--default-ulimit nofile=65535:65535\"/' /etc/sysconfig/docker
+sudo systemctl restart docker.service
+# install k3d
+sudo wget -q -O - https://raw.githubusercontent.com/rancher/k3d/main/install.sh | bash
+# exit ssh and then reconnect so you can use docker as non-root
+```