Skip to content

Conversation

vepatel
Copy link
Contributor

@vepatel vepatel commented Sep 9, 2025

Proposed changes

Checklist

Before sharing this pull request, I completed the following checklist:

Footnotes

  1. Potentially sensitive information includes personally identify information (PII), authentication credentials, and live URLs. Refer to the style guide for guidance about placeholder content.

@vepatel vepatel requested a review from a team as a code owner September 9, 2025 15:55
@github-actions github-actions bot added documentation Improvements or additions to documentation product/nic Issues related to NGINX Ingress Controller labels Sep 9, 2025
@vepatel vepatel changed the title add documentation for statefulset add documentation for NIC statefulset Sep 9, 2025
Copy link
Contributor

@AlexFenlon AlexFenlon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall good but I think files were missed?

content/includes/nic/installation/deploy-controller.md
content/includes/nic/configuration/global-configuration/configmap-resource.md:202

@danielnginx danielnginx requested a review from Copilot September 10, 2025 11:24
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds documentation for NGINX Ingress Controller StatefulSet deployment type to support NIC v3.8.0 which introduces StatefulSet as a new deployment option alongside existing Deployment and DaemonSet types. The changes ensure comprehensive coverage of all three deployment methods in installation guides, configuration references, and troubleshooting documentation.

  • Updates installation documentation to include StatefulSet as a third deployment option
  • Adds StatefulSet-specific configuration parameters in Helm chart documentation
  • Updates troubleshooting and logging guides to reference StatefulSet alongside Deployment/DaemonSet

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
content/nic/tutorials/oidc-custom-configuration.md Updates OIDC tutorial to include StatefulSet in volume mount instructions
content/nic/troubleshooting/troubleshoot-common.md Adds StatefulSet reference to troubleshooting commands
content/nic/overview/product-telemetry.md Updates telemetry description to include StatefulSet replicas
content/nic/logging-and-monitoring/service-insight.md Includes StatefulSet in Service Insight installation options
content/nic/logging-and-monitoring/prometheus.md Updates Prometheus metrics guide to reference StatefulSet
content/nic/installation/integrations/app-protect-waf/installation.md Adds StatefulSet deployment option and volume configuration notes
content/nic/installation/integrations/app-protect-waf-v5/installation.md Includes StatefulSet in WAF v5 installation with volume guidance
content/nic/installation/integrations/app-protect-dos/installation.md Adds StatefulSet option to DoS installation guide
content/nic/installation/installing-nic/installation-with-manifests.md Updates main installation guide to include StatefulSet as third deployment option
content/nic/installation/installing-nic/installation-with-helm.md Adds StatefulSet-specific Helm chart parameters and configuration options
content/nic/configuration/global-configuration/configmap-resource.md Updates ConfigMap documentation to reference StatefulSet in zone-sync
content/includes/nic/installation/manifests/statefulset.md New include file with StatefulSet deployment instructions
content/includes/nic/configuration/security.md Updates security recommendations for StatefulSet volume configuration

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Copy link

Deploy Preview will be available once build job completes!

Name Link
😎 Deploy Preview https://frontdoor-test-docs.nginx.com/previews/docs/1083/

Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM on the basis of Jack's feedback being addressed.

All call-outs should use the new call-out format: there are warnings in the terminal about this when running Hugo locally.

@vepatel vepatel merged commit a80c268 into nic-release-5.2 Sep 10, 2025
7 checks passed
@vepatel vepatel deleted the nic/add-statefulset branch September 10, 2025 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation product/nic Issues related to NGINX Ingress Controller

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants