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

docs: add IngressClassName to ApisixRoute spec #2246

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

kayx23
Copy link
Member

@kayx23 kayx23 commented Jun 17, 2024

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches
  • Documentation
  • Refactor
  • Chore
  • CI/CD or Tests

What this PR does / why we need it:

Closes #2201

Add IngressClassName to ApisixRoute spec.

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@@ -35,6 +35,7 @@ The table below describes each of the attributes in the spec. The fields `apiVer

| Attribute | Type | Description |
|--------------------------------------|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ingressClassName | string | Name of the ingress class. Used to target a specific controller that should implement the resource. |
Copy link
Member Author

Choose a reason for hiding this comment

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

Unsure if v2beta3 API needs this update.

@kayx23 kayx23 requested review from Revolyssup and pottekkat June 17, 2024 02:33
Copy link
Member

@pottekkat pottekkat left a comment

Choose a reason for hiding this comment

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

LGTM.

You don't need to update the v2beta3 doc. In fact, I think we can remove these "beta" API docs entirely, as they are no longer needed.

cc: @Revolyssup

@kayx23
Copy link
Member Author

kayx23 commented Jun 19, 2024

You don't need to update the v2beta3 doc. In fact, I think we can remove these "beta" API docs entirely, as they are no longer needed.

I thought so too seeing some previous discussions but need confirmation.

@kayx23 kayx23 requested a review from pottekkat June 25, 2024 01:51
@pottekkat
Copy link
Member

@kayx23 I checked with @Revolyssup. We can remove these as the v2beta3 APIs are no longer in the CRDs.

@kayx23
Copy link
Member Author

kayx23 commented Jun 25, 2024

I reverted the change for v2beta3 in this PR. Removing docs for v2beta3 will go in a different PR.

Copy link
Member

@pottekkat pottekkat left a comment

Choose a reason for hiding this comment

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

Sounds good. LGTM.

@kayx23 kayx23 requested a review from juzhiyuan July 4, 2024 10:44
@Revolyssup Revolyssup merged commit 7380d9a into apache:master Jul 4, 2024
27 checks passed
@kayx23 kayx23 deleted the docs-apisixroute-ref branch July 4, 2024 17:02
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.

docs: is IngressClassName supported in ApisixRoute custom resource?
3 participants