Skip to content

Commit 00a6e40

Browse files
authored
Update README.md
1 parent 2097e7f commit 00a6e40

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
# NGINX Automation Deployment Examples
1+
# Deploying NGINX Ingress Controller with NGINX WAFv5 in AWS
2+
============================================================
23

4+
Overview
5+
#########
6+
This demo guide offers a step-by-step walkthrough for configuring the NGINX Ingress Controller with NGINX App Protect v5 on AWS Cloud, using Terraform scripts to automate the deployment. For more information, refer to the devcentral article: <Coming Soon>
7+
8+
**Note:**
39

410
## Getting Started
511

@@ -38,9 +44,9 @@ This workflow requires the following secrets to be configured in your GitHub rep
3844
| `AWS_ACCESS_KEY_ID` | Secret | AWS IAM user access key ID with sufficient permissions | `AKIAXXXXXXXXXXXXXXXX` |
3945
| `AWS_SECRET_ACCESS_KEY` | Secret | Corresponding secret access key for the AWS IAM user | (40-character mixed case string) |
4046
| `AWS_SESSION_TOKEN` | Secret | Session token for temporary AWS credentials (if using MFA) | (Base64-encoded string) |
41-
| `NGINX_JWT` | Secret | JSON Web Token for NGINX license authentication | `eyJhbGciOi...` (JWT format) |
42-
| `NGINX_CRT` | Secret | NGINX Certificate in PKCS#12 format | `api.p12` file contents |
43-
| `NGINX_KEY` | Secret | NGINX Key | YourCertificatePassword123 |
47+
| `NGINX_JWT` | Secret | JSON Web Token for NGINX license authentication | `eyJhbGciOi...` (JWT format) |
48+
| `NGINX_CRT` | Secret | NGINX Certificate in PKCS#12 format | `api.p12` file contents |
49+
| `NGINX_KEY` | Secret | Private key for securing HTTPS and verifying SSL/TLS certificates | YourCertificatePasrivatekey|
4450

4551
### How to Add Secrets
4652

@@ -61,14 +67,14 @@ This workflow requires the following secrets to be configured in your GitHub rep
6167

6268
| Workflow | Branch Name |
6369
| ------------ | ---------------- |
64-
| NGINX-nap/nic| apply-NIC/NAP |
70+
| NGINX V5-NIC/NAP Apply| apply-NIC/NAP |
6571

6672

6773
**DESTROY**
6874

6975
| Workflow | Branch Name |
7076
| ------------ | ----------------- |
71-
| NGINX-nap/nic| destroy-NIC/NAP |
77+
| NGINX V5-NIC/NAP Destroy| destroy-NIC/NAP |
7278

7379

7480

@@ -79,22 +85,16 @@ This workflow requires the following secrets to be configured in your GitHub rep
7985
* azs = ["us-east-1a", "us-east1b"] - Change to Correct Availability Zones based on selected Region
8086
* Also update assets boolean value as per your work-flows
8187

82-
**STEP 3:** In S3 directory, inside the variable.tf file add the following data
83-
variable "tf_state_bucket" {
84-
* type = string
88+
**STEP 3:** In the 'S3 directory', inside the 'variable.tf' file modify the following data
8589
* description = "S3 bucket for Terraform remote state storage"
8690
* default = "your-unique-bucket-name" # Replace with your actual bucket name
87-
}
88-
89-
90-
91-
91+
9292

93-
**STEP 5:** Commit and push your build branch to your forked repo
93+
**STEP 4:** Commit and push your build branch to your forked repo
9494
* Build will run and can be monitored in the GitHub Actions tab and TF Cloud console
9595

9696

97-
**STEP 6:** Once the pipeline is complete, verify that your assets were deployed or destroyed based on your workflow.
97+
**STEP 5:** Once the pipeline is complete, verify that your assets were deployed or destroyed based on your workflow.
9898

9999
**NOTE:** The autocert process takes time. It may be 5 to 10 minutes before Let's Encrypt has provided the cert.
100100

0 commit comments

Comments
 (0)