Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add docs to install Nginx Gateway Fabric with N+ #1524

Merged
merged 7 commits into from
Feb 14, 2024

Conversation

salonichf5
Copy link
Contributor

@salonichf5 salonichf5 commented Jan 31, 2024

Proposed changes

  1. The MR contains documentation updates for installing Nginx plus with Nginx gateway fabric using
  • JWT token
  • Setting up Docker registry.
  1. This PR adds additional fields - imagePullSecretName & imagePullSecretsNames in values.yaml to specify secrets associated with the docker registry to pull and push images to.

Information has been updated for installing Nginx Plus with Nginx Gateway Fabric using Helm charts and manifests.

Problem: User should have documentation to install/upgrade Nginx Plus with Nginx Gateway Fabric

Solution: Added documentation specifying multiple ways to install plus with Nginx Gateway Fabric using both helm chart and manifests.

Testing: Lint checks and pipeline builds

Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.

Closes #ISSUE

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works N/A
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@salonichf5 salonichf5 self-assigned this Jan 31, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 31, 2024
@salonichf5 salonichf5 force-pushed the doc/installplus branch 3 times, most recently from 64f32a2 to 9d89f81 Compare February 1, 2024 21:30
@salonichf5 salonichf5 changed the title feat: Add docs to install Nginx Gateway Fabric withg N+ feat: Add docs to install Nginx Gateway Fabric with N+ Feb 1, 2024
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
@sjberman
Copy link
Contributor

sjberman commented Feb 2, 2024

Still a draft, so I'm assuming you're still working on it, but you're missing the actual installation steps. If you look at the example NIC links in the ticket, and scroll down to the installation steps, you'll see there are options for both OSS and Plus. We need a similar structure for all of our installation steps.

@salonichf5 salonichf5 force-pushed the doc/installplus branch 2 times, most recently from a1b8fdb to fd55a6e Compare February 2, 2024 21:06
@sindhushiv
Copy link
Contributor

@sjberman Do we not need approval from the documentation team for it?

@sjberman
Copy link
Contributor

sjberman commented Feb 2, 2024

@sindhushiv yes, and they are tagged as reviewers on the PR. It's still a draft though, so it's not urgent.

Makefile Outdated Show resolved Hide resolved
Makefile Show resolved Hide resolved
@github-actions github-actions bot added the helm-chart Relates to helm chart label Feb 5, 2024
@salonichf5 salonichf5 force-pushed the doc/installplus branch 2 times, most recently from 0724d4c to b6978d8 Compare February 5, 2024 21:13
Makefile Outdated Show resolved Hide resolved
@salonichf5 salonichf5 marked this pull request as ready for review February 5, 2024 21:15
@salonichf5 salonichf5 requested review from a team as code owners February 5, 2024 21:15
Makefile Show resolved Hide resolved
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/helm.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
Makefile Outdated Show resolved Hide resolved
@salonichf5 salonichf5 force-pushed the doc/installplus branch 2 times, most recently from 3e52312 to dd3a922 Compare February 8, 2024 17:06
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.

I'm approving for posterity but have made a humongous amount of edit suggestions.

I can clarify the design changes for each suggestion if desired: I anticipate I will make further changes in the future, but it's beyond the scope of the PR contents.

site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Feb 12, 2024
@salonichf5 salonichf5 closed this Feb 12, 2024
@salonichf5 salonichf5 reopened this Feb 12, 2024
@github-actions github-actions bot removed the dependencies Pull requests that update a dependency file label Feb 12, 2024
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/installing-ngf/manifests.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
site/content/installation/ngf-images/pulling-ngf-image.md Outdated Show resolved Hide resolved
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Feb 14, 2024
@github-actions github-actions bot removed the dependencies Pull requests that update a dependency file label Feb 14, 2024
@salonichf5 salonichf5 merged commit 9ad1bda into nginxinc:main Feb 14, 2024
29 checks passed
@salonichf5 salonichf5 deleted the doc/installplus branch February 14, 2024 02:05
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 helm-chart Relates to helm chart
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

6 participants