Skip to content

Conversation

kunisen
Copy link
Contributor

@kunisen kunisen commented Mar 25, 2025

Background

In an internal ticket (stl-1548) and also an internal slack channel, @jeanfabrice, @pebrc and I discussed about support scope of ingress controllers.
We came up with the plan to clarify this in public doc as below:

Docs need updated

Text to add

Note: Support Scope for Ingress Controllers

Ingress is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed via ingresses and we provide example ingress configuration recipes, setting up an Ingress controller requires in-house Kubernetes expertise. If configuring ingress presents challenges, we recommend using a standard Load Balancer (LB) as an alternative solution.

docs-content pages to edit

Sample view

:: Without link

image

:: With link

image

Clicking the link example ingress configuration recipes will redirect page to http://localhost:3000/deploy-manage/deploy/cloud-on-k8s/recipes

@kunisen kunisen added the documentation Improvements or additions to documentation label Mar 25, 2025
@eedugon
Copy link
Contributor

eedugon commented Mar 25, 2025

@kunisen : instead of adding the title in the note, try a plain admonition, and let me know your thoughts:

I'm also rewording a bit the statement, for your consideration too:

:::{admonition} Support scope for Ingress Controllers
Ingress is a standard Kubernetes concept. While ECK-managed workloads can be publicly exposed using ingress resources, and we provide example configurations, setting up an Ingress controller requires in-house Kubernetes expertise. If ingress configuration is challenging or unsupported in your environment, consider using standard LoadBalancer services as a simpler alternative.
:::

Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

I've suggested a small change in the text and a plain admonition with the title instead of a note.

@kunisen
Copy link
Contributor Author

kunisen commented Mar 25, 2025

Thanks @eedugon
It looks perfect to use admonition 🤩
image

@kunisen kunisen self-assigned this Mar 25, 2025
it looks nicer now
Copy link
Contributor

@eedugon eedugon left a comment

Choose a reason for hiding this comment

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

LGTM, thanks a lot!

@kunisen kunisen enabled auto-merge (squash) March 25, 2025 08:58
@kunisen kunisen merged commit 05a6ee3 into main Mar 25, 2025
3 of 4 checks passed
@kunisen kunisen deleted the kunisen-docpr-stl1548 branch March 25, 2025 09:00
kunisen added a commit to elastic/cloud-on-k8s that referenced this pull request Mar 26, 2025
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants