Skip to content

Commit

Permalink
A few fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
aknot242 committed Jan 17, 2023
1 parent 4b98919 commit ba8b4f3
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ contributors.

## Open an issue and pull request for changes

All submissions, including those from project memebers, are required to go through
All submissions, including those from project members, are required to go through
review. We use GitHub Pull Requests for this workflow, which should be linked with
an issue for tracking purposes.
See [GitHub](https://help.github.com/articles/about-pull-requests/) for more details.
See [GitHub](https://help.github.com/articles/about-pull-requests/) for more details.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Example hybrid security deployments utilizing F5 Distributed Cloud WAAP in conju
## Assets

* **xc:** F5 Distributed Cloud WAAP
* **nap:** NGINX Kubernetes Ingress Controller with NGINX App Protect (WAF and API Protection)
* **nap:** NGINX Ingress Controller for Kubernetes with NGINX App Protect (WAF and API Protection)
* **bigip:** F5 BIG-IP (LTM and Advanced WAF)
* **infra:** AWS Infrastructure (VPC, IGW, etc.)
* **eks:** AWS Elastic Kubernetes Service
Expand Down Expand Up @@ -50,7 +50,7 @@ Example hybrid security deployments utilizing F5 Distributed Cloud WAAP in conju
* AWS_ACCESS_KEY_ID: Your AWS Access Key ID - Environment Variable
* AWS_SECRET_ACCESS_KEY: Your AWS Secret Access Key - Environment Variable
* AWS_SESSION_TOKEN: Your AWS Session Token - Environment Variable
* NGINX_JWT: Your NGINX Java Web Token assocaited with your NGINX license. Set this to nignx-repo.jwt - Environment Variable
* NGINX_JWT: Your NGINX Java Web Token associated with your NGINX license. Set this to nginx-repo.jwt - Environment Variable
* VOLT_API_P12_FILE: Your F5XC API certificate. Set this to api.p12 - Environment Variable
* VES_P12_PASSWORD: Set this to the password you supplied when creating your F5 XC API key - Environment Variable
* ssh_key: Your ssh key for access to created BIG-IP and compute assets - Terraform Variable
Expand All @@ -62,7 +62,7 @@ Example hybrid security deployments utilizing F5 Distributed Cloud WAAP in conju
* **Fork and Clone Repo**

* **Actions Secrets:** Create the following GitHub Actions secrets in your forked repo
* NGINX_JWT: The base64 encoded NGINX Java Web Token assocaited with your NGINX license
* NGINX_JWT: The base64 encoded NGINX Java Web Token associated with your NGINX license
* P12: The base64 encoded F5XC API certificate
* TF_API_TOKEN: Your Terraform Cloud API token
* TF_CLOUD_ORGANIZATION: Your Terraform Cloud Organization name
Expand All @@ -88,21 +88,21 @@ Example hybrid security deployments utilizing F5 Distributed Cloud WAAP in conju
| xc-nap | destroy-xc-nap |


**STEP 2:** Rename infra/terraform.tfvars.examples to infra/terraform.tfvars and add the following data:
**STEP 2:** Rename `infra/terraform.tfvars.examples` to `infra/terraform.tfvars` and add the following data:
* project_prefix = "Your project identifier - this will be applied as a prefix to all assets"
* resource_owner = "You"
* aws_region = "AWS Region" ex. us-east-1
* azs = ["us-east-1a", "us-east1b"] - Change to Correct Availability Zones based on Region


**STEP 3:** Rename bigip/terraform.tfvars.examples to bigip/terraform.tfvars and add the following data:
**STEP 3:** Rename `bigip/terraform.tfvars.examples` to `bigip/terraform.tfvars` and add the following data:
* f5_ami_search_name = "F5 BIGIP-16.1.3* PAYG-Adv WAF Plus 25Mbps*" - You must be subscribed to the AMI in the [AWS Marketplace](https://aws.amazon.com/marketplace)
* aws_secretmanager_auth = false
* create_awaf_config = true
* awaf_config_payload = "awaf-config.json"


**Step 3:** Rename xc/terraform.tfvars.examples to xc/terraform.tfvars and add the following data:
**Step 3:** Rename `xc/terraform.tfvars.examples` to `xc/terraform.tfvars` and add the following data:
* api_url = "Your F5XC tenant"
* xc_namespace = "The XC namespace you are deploying to"
* app_domain = "the FQDN of your app (cert will be autogenerated)"
Expand Down

0 comments on commit ba8b4f3

Please sign in to comment.