Big Bang Quick Start

This is a mirror of a government repo hosted on Repo1 by DoD Platform One. Please direct all code changes, issues and comments to https://repo1.dso.mil/platform-one/quick-start/big-bang

This is a small repo to help quickly test basic concepts of Big Bang on a local development machine.

Prerequisites

What you need:

Docker with the ability to run containers (either sudo or your user in the docker group)
k3d
Terraform
VM or Machine with
- Bare minimum: 6 logical cpu cores and 16GB RAM
- Recommended: 8+ cores and 32GB+ RAM

Nice to haves:

Kubectl - CLI for working with k8s/k3d
K8s Lens - Handy GUI for kubectl

Instructions

# Get your username and password from https://registry1.dso.mil and set them as
# env vars to be used later. The password to use is in your user profile under
# 'CLI secret'. If you don't have an account you can register one on the 
# Platform One login page.
export REGISTRY1_USERNAME="bobbytables"
export REGISTRY1_PASSWORD="yourpasswordhere"

# Create a Terraform .tfvars file that will be gitignored (since it has secrets
# in it)
cat <<EOF >>terraform.tfvars
registry1_username = "${REGISTRY1_USERNAME}"
registry1_password = "${REGISTRY1_PASSWORD}"
EOF

# Linux systems may require this line for EFK to not die. Otherwise you can skip
# to the next command
sudo sysctl -w vm.max_map_count=262144

# Initialize k3d. Your system will be automatically configured to use the right
# KUBECONTEXT.
./init-k3d.sh

# Initialize & apply terraform. This will take several minutes.
# If you want to watch it happen use the next command under 
# "Watch the deployments" in a new terminal or other user interface
terraform init
terraform apply --auto-approve

# Watch the deployments. Wait for everything under STATUS to say "Running" and
# everything under READY to say "True"
watch kubectl get kustomizations,hr,po -A

# Get a list of http endpoints that will resolve to your localhost.
kubectl get virtualservices -A

Services

URL	Username	Password	Notes
alertmanager.bigbang.dev	n/a	n/a	Unauthenticated
grafana.bigbang.dev	`admin`	`prom-operator`
kiali.bigbang.dev	n/a	`kubectl get secret -n kiali -o=json \| jq -r '.items[] \| select(.metadata.annotations."kubernetes.io/service-account.name"=="kiali-service-account") \| .data.token' \| base64 -d; echo`
kibana.bigbang.dev	`elastic`	`kubectl get secret -n logging logging-ek-es-elastic-user -o=jsonpath='{.data.elastic}' \| base64 -d; echo`
prometheus.bigbang.dev	n/a	n/a	Unauthenticated
tracing.bigbang.dev	n/a	n/a	Unauthenticated
twistlock.bigbang.dev	n/a	n/a	Twistlock has you create an admin account the first time you log in

Teardown

# Big bang teardown (optional, takes several minutes & just reverts back to an
# empty cluster)
terraform destroy

# k3d teardown
k3d cluster delete big-bang-quick-start

# Delete Terraform state (if you didn't run `terraform destroy`)
rm terraform.tfstate

Makefile

For your convenience, a Makefile is provided with targets make up and make down

Requirements

Name	Version
terraform	>= 0.13.0

Providers

No providers.

Inputs

Name	Description	Type	Default	Required
registry1_password	Your password on https://registry1.dso.mil. You can find it under 'CLI secret' in your user profile	`string`	n/a	yes
registry1_username	Your username on https://registry1.dso.mil	`string`	n/a	yes

Outputs

Name	Description
external_load_balancer	JSON array with information on all LoadBalancer services in the istio-system namespace. Example output: [ { "name": "public-ingressgateway", "ip": "192.0.2.0", "hostname": "null" }, {...} ]
istio_gw_ip	DEPRECATED - Kept for backwards compatibility reasons, will be removed later. Returns the IP of the first LoadBalancer found in the istio-system namespace

cmays20 / big-bang