Skip to content

Conversation

@rmweir
Copy link
Contributor

@rmweir rmweir commented Dec 11, 2025

Content Description

Preview Link

Internal Reference

Part of ENG-10314

@netlify /docs

Note

Adds deprecation notices for ingress-nginx across documentation.

  • Platform install: Added deprecation warnings to NGINX ingress controller sections
  • Platform config: Updated domain configuration with deprecation notice for NGINX
  • Sleep mode: Added deprecation markers to ingress-nginx references
  • Templates: Added deprecation comments to NGINX ingress class examples
  • vCluster config: Marked ingress-nginx addon and examples as deprecated
  • Integrations: Updated cert-manager docs with NGINX deprecation notices

Generated by Claude for 7ed094d

@rmweir rmweir requested a review from a team as a code owner December 11, 2025 23:51
@netlify
Copy link

netlify bot commented Dec 11, 2025

Deploy Preview for vcluster-docs-site ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 7ed094d
🔍 Latest deploy log https://app.netlify.com/projects/vcluster-docs-site/deploys/694526bfca01dc000847fc0c
😎 Deploy Preview https://deploy-preview-1486--vcluster-docs-site.netlify.app/docs
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

@rmweir rmweir force-pushed the deprecate-nginx branch 2 times, most recently from de4cb09 to dd29df9 Compare December 12, 2025 00:04
Copy link
Contributor

@cbron cbron left a comment

Choose a reason for hiding this comment

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

Seems fine to me. @guowenatk can you review ?

@cbron cbron requested a review from guowenatk December 12, 2025 21:09
@rmweir rmweir force-pushed the deprecate-nginx branch 2 times, most recently from 5274a3f to c437b52 Compare December 18, 2025 21:00
@loft-bot
Copy link
Contributor

loft-bot commented Dec 19, 2025

Claude encountered an error —— View job

Command failed: git fetch origin --depth=20 deprecate-nginx

I'll analyze this and get back to you.

@github-actions
Copy link
Contributor

Claude Code review failed to complete. This may be due to API rate limits or network issues. The PR can still be reviewed manually.


<Step>
Install the NGINX `IngressController`.
[Deprecated]: [Deprecated]: [Deprecated]: Install the NGINX `IngressController`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
[Deprecated]: [Deprecated]: [Deprecated]: Install the NGINX `IngressController`.
[Deprecated]: Install the NGINX `IngressController`.

@loft-bot
Copy link
Contributor

loft-bot commented Dec 19, 2025

Claude encountered an error —— View job

Command failed: git fetch origin --depth=20 deprecate-nginx

I'll analyze this and get back to you.

@github-actions
Copy link
Contributor

Claude Code review failed to complete. This may be due to API rate limits or network issues. The PR can still be reviewed manually.

@loft-bot
Copy link
Contributor

loft-bot commented Dec 19, 2025

Claude finished @rmweir's task in 2m 38s —— View job


Review: Deprecate ingress nginx

Summary: This PR adds deprecation notices for ingress-nginx across 21 documentation files. The changes appropriately mark NGINX ingress controller references as deprecated while keeping the documentation functional for users still using it.

Issues Found

I found several issues that need attention:

Typos (4 occurrences)

  • deperecateddeprecated in:
    • platform/administer/clusters/advanced/multi-region-mode.mdx:22
    • platform/administer/monitoring/aggregating-metrics.mdx:220
    • platform/administer/templates/create-templates.mdx:549, 559
    • vcluster/_fragments/integrations/cert-manager.mdx:417

Duplicate text (3 occurrences)

  • [Deprecated]: [Deprecated]: [Deprecated]: in vcluster/_fragments/sleepmode-ingress-example.mdx:30 - appears 3 times
  • Duplicate deprecation comments in YAML:
    • vcluster/configure/vcluster-yaml/experimental/_code/sleepmode-ingress-examples.yaml:56
    • vcluster/_fragments/integrations/cert-manager.mdx:281

Existing review comment from @Piotr1215
The reviewer suggested changing the format at line 30 of vcluster/_fragments/sleepmode-ingress-example.mdx. The current implementation has triple [Deprecated]: which looks like an unintended repetition.

What Looks Good

  • ✅ Deprecation warnings are appropriately placed at section/step level
  • ✅ YAML code examples properly annotated with deprecation comments
  • :::warning Deprecated admonitions used correctly in appropriate files
  • ✅ Validated vCluster YAML configurations are syntactically correct


<Step>
Install the NGINX `IngressController`.
[Deprecated]: [Deprecated]: [Deprecated]: Install the NGINX `IngressController`.
Copy link
Contributor

Choose a reason for hiding this comment

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

The [Deprecated]: prefix appears three times. This looks like an accidental repetition.

Suggested change
[Deprecated]: [Deprecated]: [Deprecated]: Install the NGINX `IngressController`.
[Deprecated]: Install the NGINX `IngressController`.

namespace: bar
spec:
ingressClassName: nginx
ingressClassName: nginx # the ingress-nginx project has been deprecated, we recommend using a different ingress class # the ingress-nginx project has been deprecated, we recommend using a different ingress class
Copy link
Contributor

Choose a reason for hiding this comment

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

The deprecation comment appears twice. Consider using a single comment.

Suggested change
ingressClassName: nginx # the ingress-nginx project has been deprecated, we recommend using a different ingress class # the ingress-nginx project has been deprecated, we recommend using a different ingress class
ingressClassName: nginx # the ingress-nginx project has been deprecated, we recommend using a different ingress class

- http01:
ingress:
ingressClassName: nginx
ingressClassName: nginx # the ingress-nginx project has been deprecated, we recommend using a different ingress class # the ingress-nginx project has been deprecated, we recommend using a different ingress class
Copy link
Contributor

Choose a reason for hiding this comment

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

The deprecation comment appears twice in this line. Consider consolidating.

Suggested change
ingressClassName: nginx # the ingress-nginx project has been deprecated, we recommend using a different ingress class # the ingress-nginx project has been deprecated, we recommend using a different ingress class
ingressClassName: nginx # the ingress-nginx project has been deprecated, we recommend using a different ingress class

name: loft-agent-ingress
annotations:
kubernetes.io/ingress.class: nginx
kubernetes.io/ingress.class: nginx # ingress-nginx has been deperecated
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a typo in "deperecated" - should be "deprecated".

Suggested change
kubernetes.io/ingress.class: nginx # ingress-nginx has been deperecated
kubernetes.io/ingress.class: nginx # ingress-nginx has been deprecated

### Option 2: Ingress

Create an Ingress resource to expose Grafana externally. The following example uses the nginx ingress controller:
Create an Ingress resource to expose Grafana externally. The following example uses the nginx ingress controller (deperecated):
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a typo in "deperecated" - should be "deprecated".

Suggested change
Create an Ingress resource to expose Grafana externally. The following example uses the nginx ingress controller (deperecated):
Create an Ingress resource to expose Grafana externally. The following example uses the nginx ingress controller (deprecated):

nginx.ingress.kubernetes.io/force-ssl-redirect: "true"
nginx.ingress.kubernetes.io/backend-protocol: "HTTP"
ingressClassName: "nginx"
ingressClassName: "nginx" # deperecated
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a typo in "deperecated" - should be "deprecated".

Suggested change
ingressClassName: "nginx" # deperecated
ingressClassName: "nginx" # deprecated

ingress:
enabled: true
ingressClassName: "nginx"
ingressClassName: "nginx" # deperecated
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a typo in "deperecated" - should be "deprecated".

Suggested change
ingressClassName: "nginx" # deperecated
ingressClassName: "nginx" # deprecated

name: secure-app-ingress
annotations:
kubernetes.io/ingress.class: nginx
kubernetes.io/ingress.class: nginx # ingress-nginx has been deperecated
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a typo in "deperecated" - should be "deprecated".

Suggested change
kubernetes.io/ingress.class: nginx # ingress-nginx has been deperecated
kubernetes.io/ingress.class: nginx # ingress-nginx has been deprecated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants