feat: Set up NGF integration to N1 Console

[mjang]

Extensively revised (14 Aug, midday), after extensive discussions with @bjee19 , @sylwang , and @sjberman

Proposed changes

Set up NGF integration into N1 Console.

• This is similar to https://docs.nginx.com/nginx-one/k8s/add-nic/
  • But since NIC != NGF, I've changed labels / titles as appropriate
  • I've included some of the same steps to set up a data plane key, create a k8s secret, verify a connection, and for troubleshooting (I'm guessing the troubleshooting section, if applicable, will be different)
• Many of the steps are the same with https://docs.nginx.com/nginx-gateway-fabric/install/helm/
  • I've added an include for one process, I've copy/pasted content with an include for a second process
• I've included temporary references <!-- in comments --> to the UI and steps that we're using in that process

The primary build page is here: https://frontdoor-test-docs.nginx.com/previews/docs/902/nginx-one/k8s/add-ngf/

I think there's work to be done w/r/t data plane keys. We have a bunch of different ways to create them

• There's an alert for when a data plane key is within 30 days of expiration
• This may be best as a separate issue

This might close issue 660.
Closes #ISSUE

Checklist

Before merging a pull request, run through this checklist and mark each as complete.

• I have read the contributing guidelines
• I have signed the F5 Contributor License Agreement (CLA)
• I have rebased my branch onto main
• I have ensured my PR is targeting the main branch and pulling from my branch from my own fork
• I have ensured that the commit messages adhere to Conventional Commits
• I have ensured that documentation content adheres to the style guide
• If the change involves potentially sensitive changes¹, I have assessed the possible impact
• If applicable, I have added tests that prove my fix is effective or that my feature works
• I have ensured that existing tests pass after adding my changes
• If applicable, I have updated README.md

Footnotes

1. Potentially sensitive changes include anything involving code, personally identify information (PII), live URLs or significant amounts of new or revised documentation. Please refer to our style guide for guidance about placeholder content. ↩

[github-actions]

✅ Deploy Preview will be available once build job completes!

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

---

[mjang]

cc @sylwang @bjee19

[sylwang]

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design.
https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

[mjang]

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design. https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

Now that I've re-reviewed the Figma, I need to come up with a new file, probably add-ngf-manifests.md

[sjberman]

I think it would also be in our best interest to include a link to this doc from the NGF installation docs for users who start there.

[mjang]

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design. https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

Now that I've re-reviewed the Figma, I need to come up with a new file, probably add-ngf-manifests.md

see https://github.com/nginx/documentation/pull/902/files#diff-0f3a95e47383180f7981bf1dce261d6cf9df28039ae0c964412656d2a493498e

Build: https://frontdoor-test-docs.nginx.com/previews/docs/902/nginx-one/k8s/add-ngf-manifests/

[sjberman]

The includes don't seem to be rendering for the manifests page. Also, deploying with manifests requires the same prereqs as deploying with helm. Create the namespace, download the secret, create the secret. The difference is supplying CLI flag directly in the manifest:

--nginx-one-dataplane-key-secret=<data_plane_key_secret_name>

[mjang]

I think I've found the problem... keeping this convo unresolved until I check the build in the PR.

[mjang]

@sjberman Two answers:

• The build is now rendering for the manifests page. https://frontdoor-test-docs.nginx.com/previews/docs/902/nginx-one/k8s/add-ngf-manifests/#deploy-nginx-gateway-fabric
• The only reference I see to the --nginx-one-dataplane-key-secret" is in https://docs.nginx.com/nginx-gateway-fabric/reference/cli-help/. And that refers to the gateway controller [flags]` command, which we have not referenced in this page
  • I think I need to add two references from this page:
    • https://docs.nginx.com/nginx-gateway-fabric/install/manifests/
    • https://docs.nginx.com/nginx-gateway-fabric/reference/cli-help/
      • Actually -- only if we describe the use of gateway controller [flags] or how the --nginx-one-dataplane-key-secret is used with kubectl
  • In the NGF docs, I see no example where we use --nginx-one-dataplane-key-secret.
    • If we're going to doc the use of the --nginx-one-dataplane-key-secret option, we'll need to describe how to use gateway controller. or if it's useable with a command like kubectl (as referenced from this section), then I need a usable example.

[mjang]

In NIC, the doc provided both the Helm and Manifests options for deploying. We'd want to do the same for NGF, and also include an option to deploy NGF using Manifests, as shown in the Figma design. https://www.figma.com/design/Y0wCtVRjEa08HNfocSDVUb/GA---NGINX-One-SaaS-Console?node-id=8028-37869&t=HQ1wwsiaEMrrHdw9-0

I might have said earlier -- I've now set up separate files for NGF helm and manifests.

• Should I also set up separate files for NIC helm and manifests? (I'm going to think about it a bit)