generated from nginx/template-repository
-
Notifications
You must be signed in to change notification settings - Fork 101
feat: Clarify NGINX Ingress Controller install & upgrade documentation #816
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
Merged
Merged
Changes from all commits
Commits
Show all changes
53 commits
Select commit
Hold shift + click to select a range
7035076
feat: Clarify NIC install & upgrade steps
ADubhlaoich 2386768
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 1ce25d2
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich cab2b43
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich fcb0ea5
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich cea2a56
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich fe71933
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 5d8a199
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 00b5ba8
feat: Move and rename old upgrade instructions
ADubhlaoich b2b0195
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich b8d700d
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich c7ccbde
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich d011d29
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 7848959
Apply suggestion from @travisamartin
ADubhlaoich 6b14dfc
Apply suggestion from @travisamartin
ADubhlaoich 2f6db7c
Apply suggestion from @travisamartin
ADubhlaoich a87e651
Apply suggestion from @travisamartin
ADubhlaoich 027cacc
Apply suggestion from @travisamartin
ADubhlaoich de6344e
Apply suggestion from @travisamartin
ADubhlaoich c094fc2
Apply suggestion from @travisamartin
ADubhlaoich a5b72f7
Apply suggestion from @travisamartin
ADubhlaoich 3dc1027
Apply suggestion from @travisamartin
ADubhlaoich a0f591b
Apply suggestion from @travisamartin
ADubhlaoich 92759bd
Apply suggestion from @travisamartin
ADubhlaoich 4c72e55
Apply suggestion from @travisamartin
ADubhlaoich c8ba079
Apply suggestion from @travisamartin
ADubhlaoich 40bd224
Apply suggestion from @travisamartin
ADubhlaoich ce3b5db
Apply suggestion from @travisamartin
ADubhlaoich 6cc93b5
Apply suggestion from @travisamartin
ADubhlaoich 7c098ef
Apply suggestion from @travisamartin
ADubhlaoich 26bfffc
feat: Incorporate suggestions, rename image pages
ADubhlaoich a9534e8
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 2b3281a
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich a062bc4
fix: Update tech specs with new links
ADubhlaoich 7063cf5
feat: Rename image docs, update references
ADubhlaoich a039bc8
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich cbbef0e
feat: Update Helm IA for add image to cluster
ADubhlaoich 6c8b30b
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 707df12
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 701b6aa
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 81ff963
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 490def1
feat: Update NIC Docker docs, related files
ADubhlaoich f9cef3f
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich 084fc48
fix: Remove unnecessary linebreak from include
ADubhlaoich f970a40
fix: Further formatting issues
ADubhlaoich ba5baf8
fix: Revert tab formatting to use % instead of <>
ADubhlaoich fabdf2a
feat: Make include text consistent
ADubhlaoich f22d693
fix: Include text consistency
ADubhlaoich bfbabee
fix: Typos in include documentation
ADubhlaoich e630c58
feat: Update product name in Helm page
ADubhlaoich fd81d7d
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich d56a655
Merge branch 'main' into nic/upgrade-instructions
ADubhlaoich e92dc81
feat: Make Helm sources install consistent
ADubhlaoich File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
9 changes: 9 additions & 0 deletions
9
content/includes/licensing-and-reporting/download-certificates-from-myf5.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
files: | ||
- content/includes/use-cases/credential-download-instructions.md | ||
--- | ||
|
||
1. Log in to [MyF5](https://my.f5.com/manage/s/). | ||
1. Go to **My Products & Plans > Subscriptions** to see your active subscriptions. | ||
1. Find your NGINX subscription, and select the **Subscription ID** for details. | ||
1. Download the **SSL Certificate** and **Private Key** files from the subscription page. |
17 changes: 14 additions & 3 deletions
17
content/includes/licensing-and-reporting/download-jwt-from-myf5.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,19 @@ | ||
--- | ||
docs: | ||
files: | ||
- content/includes/nim/docker/docker-registry-login.md | ||
- content/includes/use-cases/credential-download-instructions.md | ||
- content/nap-waf/v5/admin-guide/install.md | ||
- content/nginx/admin-guide/installing-nginx/installing-nginx-plus.md | ||
- content/nginx-one/connect-instances/connect-nginx-plus-container-images-to-nginx-one.md | ||
- content/nim/admin-guide/add-license.md | ||
- content/nim/deploy/docker/deploy-nginx-plus-and-agent-docker.md | ||
- content/nim/disconnected/add-license-disconnected-deployment.md | ||
- content/solutions/about-subscription-licenses.md | ||
- content/solutions/r33-pre-release-guidance-for-automatic-upgrades.md | ||
--- | ||
|
||
1. Log in to [MyF5](https://my.f5.com/manage/s/). | ||
2. Go to **My Products & Plans > Subscriptions** to see your active subscriptions. | ||
3. Find your NGINX products or services subscription, and select the **Subscription ID** for details. | ||
4. Download the **JSON Web Token** from the subscription page. | ||
1. Go to **My Products & Plans > Subscriptions** to see your active subscriptions. | ||
1. Find your NGINX subscription, and select the **Subscription ID** for details. | ||
1. Download the **JSON Web Token** file from the subscription page. |
25 changes: 25 additions & 0 deletions
25
content/includes/use-cases/credential-download-instructions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
files: | ||
- content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md | ||
- content/nic/installation/nic-images/registry-download.md | ||
--- | ||
|
||
In order to obtain a container image, you will need the JSON Web Token file or SSL certificate and private key files provided with your NGINX Plus subscription. | ||
|
||
These files grant access to the package repository from which the script will download the NGINX Plus package: | ||
|
||
{{< tabs name="product_keys" >}} | ||
|
||
{{% tab name="JSON Web Token" %}} | ||
|
||
{{< include "licensing-and-reporting/download-jwt-from-myf5.md" >}} | ||
|
||
{{% /tab %}} | ||
|
||
{{% tab name="SSL" %}} | ||
|
||
{{< include "licensing-and-reporting/download-certificates-from-myf5.md" >}} | ||
|
||
{{% /tab %}} | ||
|
||
{{< /tabs >}} |
49 changes: 49 additions & 0 deletions
49
content/includes/use-cases/docker-registry-instructions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
files: | ||
- content/nginx/admin-guide/installing-nginx/installing-nginx-docker.md | ||
- content/nic/installation/nic-images/registry-download.md | ||
--- | ||
|
||
This step describes how to use Docker to communicate with the F5 Container Registry located at `private-registry.nginx.com`. | ||
|
||
{{< call-out "note" >}} | ||
|
||
The steps provided are for Linux. For Mac or Windows, see the [Docker for Mac](https://docs.docker.com/docker-for-mac/#add-client-certificates) or [Docker for Windows](https://docs.docker.com/docker-for-windows/#how-do-i-add-client-certificates) documentation. | ||
|
||
For more details on Docker Engine security, you can refer to the [Docker Engine Security documentation](https://docs.docker.com/engine/security/). | ||
|
||
{{< /call-out >}} | ||
|
||
{{< tabs name="docker_login" >}} | ||
|
||
{{% tab name="JSON Web Token"%}} | ||
|
||
Open the JSON Web Token file previously downloaded from [MyF5](https://my.f5.com) customer portal (for example, `nginx-repo-12345abc.jwt`) and copy its contents. | ||
|
||
Log in to the Docker registry using the contents of the JSON Web Token file: | ||
|
||
```shell | ||
docker login private-registry.nginx.com --username=<output_of_jwt_token> --password=none | ||
``` | ||
|
||
{{% /tab %}} | ||
|
||
{{% tab name="SSL" %}} | ||
|
||
Create a directory and copy your certificate and key to this directory: | ||
|
||
```shell | ||
mkdir -p /etc/docker/certs.d/private-registry.nginx.com | ||
cp <path-to-your-nginx-repo.crt> /etc/docker/certs.d/private-registry.nginx.com/client.cert | ||
cp <path-to-your-nginx-repo.key> /etc/docker/certs.d/private-registry.nginx.com/client.key | ||
``` | ||
|
||
Log in to the Docker registry: | ||
|
||
```shell | ||
docker login private-registry.nginx.com | ||
``` | ||
|
||
{{% /tab %}} | ||
|
||
{{< /tabs >}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.