diff --git a/platformQuickStarts/AWS/codepipelinebuild/README.md b/platformQuickStarts/AWS/codepipelinebuild/README.md index 93500af62..ea0f937f9 100644 --- a/platformQuickStarts/AWS/codepipelinebuild/README.md +++ b/platformQuickStarts/AWS/codepipelinebuild/README.md @@ -1,4 +1,4 @@ -= Serverless MVN builds Featuring AWS +# Serverless MVN builds Featuring AWS This Quick Start is the foundation where other of the AWS quickstarts begin. This quickstart only BUILDS the `webgoat-server` spring boot jar. If you want to also run it on AWS skip to the other AWS quickstarts @@ -19,7 +19,7 @@ You will also need: -== Create Pre-requisites +## Create Pre-requisites First pick and AWS region and stick with it for ALL the quickstarts. This one was mostly executed on US-east-1/2 but any region with KMS, CodePipeline, and CodeBuild will work. Eu-Central-1, ap-southeast-1 and sa-east-1 have reported success also. @@ -27,7 +27,7 @@ First pick and AWS region and stick with it for ALL the quickstarts. This one wa 1. Create an S3 bucket and call it something meaningfull like `webgoat-stash-username` or something or use an existing bucket you have access to. 2. Create a KMS Key. Make sure you are a key administrator so you can add key users later. -== Deploy IAM role Cloud Formation Stacks +## Deploy IAM role Cloud Formation Stacks In this folder there are two json cloudformation templates: -`01_IAM_codebuild.json` @@ -35,11 +35,11 @@ In this folder there are two json cloudformation templates: You will use the CloudFormation templates to create two roles. One for CodePipeline and the Other for CodeBuild. You will use the name of the bucket you just created as a parameter. -== Update KMS Key +## Update KMS Key Access the KMS key you created earlier...add the two IAM roles you just created and Key Users -== Finally the Pipeline +## Finally the Pipeline You will use the yaml cloudformation template `01_codepiplinebuild.yml` to create the code building pipeline. diff --git a/platformQuickStarts/GCP/GKE-Docker/README.md b/platformQuickStarts/GCP/GKE-Docker/README.md index ad9342593..b871ac4af 100644 --- a/platformQuickStarts/GCP/GKE-Docker/README.md +++ b/platformQuickStarts/GCP/GKE-Docker/README.md @@ -1,4 +1,4 @@ -= GKE - DockerHub +# GKE - DockerHub This Quickstart shows how to create a Kubernettes Cluster using Google Cloud Platform's [GKE](https://cloud.google.com/container-engine/) and WebGoat Docker [Image](https://hub.docker.com/r/webgoat/webgoat-8.0/). @@ -8,7 +8,7 @@ To be Successfull with this Quickstart 2. You know how to `git clone` 3. You have access to the gcloud SDK -== Create Kubernettes Cluster +## Create Kubernettes Cluster Using the cloud console the default settings will suffice. Just provide a cluster name that makes sense to you. Otherwise you can use the [Google Cloud Shell](https://cloud.google.com/shell/docs/) and the followihg command: @@ -22,7 +22,7 @@ gcloud container --project "PROJECTNAME" clusters create "owaspbasiccluster" --z Notice that Google Source is `readonly` and Cloud Platform as `Enabled` -== Set up Kubectl +## Set up Kubectl Using either Google Cloud Shell or other commandline gcloud SDK environment you need to set-up 'kubectl' @@ -33,7 +33,7 @@ Then you just run: `gcloud container clusters get-credentials owaspbasiccluster --zone us-central1-b --project PROJECTNAME` -== Deploy WebGoat Deployment +## Deploy WebGoat Deployment Time to deploy the latest DockerImage for WebGoat @@ -56,7 +56,7 @@ After a few minutes the service endpoint should be ready. You can check the stat In the output you should see a message like "Created Load..." after a "Creating load..." which means that the public facing loadbalancer (even thou there is just one container running!) is ready. -== Test Deployment +## Test Deployment From the previous `describe service` command the `LoadBalancer Ingress:` line should have the external IP. The line below should give the port. diff --git a/platformQuickStarts/GCP/README.md b/platformQuickStarts/GCP/README.md index deeb13f16..4620a90d8 100644 --- a/platformQuickStarts/GCP/README.md +++ b/platformQuickStarts/GCP/README.md @@ -1,4 +1,4 @@ -= WebGoat on GCP! +# WebGoat on GCP! This folder contains sub folders for the various ways you could deploy WebGoat on Google Cloud Platform @@ -8,10 +8,10 @@ It is assumed: 3. You can use a Shell Linux/Mac/Google Cloud Shell -== GKE Docker +## GKE Docker Uses GKE to run the latest DockerHub version of WebGoat8 -== AppEngine +## AppEngine WIP \ No newline at end of file