DATAGO-105494: Documetation update for the NodePorts#50
DATAGO-105494: Documetation update for the NodePorts#50LewisKSaint merged 2 commits intodev1.4.0from
Conversation
![gitstream-cm[bot]](https://avatars.githubusercontent.com/in/230441?s=60&v=4){kind=small}
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
Please mark whether you used Copilot to assist coding in this PR
|
docs/EventBrokerOperatorUserGuide.md
Outdated
|
|
||
| **Option 1:** Explicit NodePort Assignment. | ||
|
|
||
| With this option, you explicitly specify which node ports to use for each service port. This gives you full control over port assignments. However, if there are conflicts with existing NodePorts, the deployment will fail. |
There was a problem hiding this comment.
I'd suggest dropping the 'With this option, You...' from the start here:
Explicitly specify which node ports to use for each service port. This gives you full control over port assignments. However, if there are conflicts with existing NodePorts, the deployment will fail.
docs/EventBrokerOperatorUserGuide.md
Outdated
|
|
||
| **Option 2:** Automatic NodePort Assignment. | ||
|
|
||
| With this option, you let Kubernetes automatically assign node ports. This is simpler but gives you less control. It also avoids conflicts with existing NodePorts, as Kubernetes will find available ports for you. |
There was a problem hiding this comment.
Similar to the above, with some additional minor changes:
Let Kubernetes automatically assign node ports. This is simpler, but gives you less control. It also avoids conflicts with existing NodePorts, as Kubernetes finds available ports for you.
docs/EventBrokerOperatorUserGuide.md
Outdated
| To support [Internal load balancers](https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer), a provider-specific service annotation can be added by defining the `spec.service.annotations` parameter. | ||
|
|
||
| The `spec.service.ports` parameter defines the broker ports/services exposed. It specifies the event broker `containerPort` that provides the service and the mapping to the `servicePort` where the service can be accessed when using LoadBalancer or ClusterIP - however there is no control over the port number mapping when using NodePort. By default most broker service ports are exposed, refer to the ["pubsubpluseventbrokers" Custom Resource definition](/config/crd/bases/pubsubplus.solace.com_pubsubpluseventbrokers.yaml). | ||
| The `spec.service.ports` parameter defines the broker ports/services exposed. It specifies the event broker `containerPort` that provides the service and the mapping to the `servicePort` where the service can be accessed when using LoadBalancer or ClusterIP. By default most broker service ports are exposed, refer to the ["pubsubpluseventbrokers" Custom Resource definition](/config/crd/bases/pubsubplus.solace.com_pubsubpluseventbrokers.yaml). |
There was a problem hiding this comment.
One more minor edit (missing comma after 'By default':
The spec.service.ports parameter defines the broker ports/services exposed. It specifies the event broker containerPort that provides the service and the mapping to the servicePort where the service can be accessed when using LoadBalancer or ClusterIP. By default, most broker service ports are exposed, refer to the "pubsubpluseventbrokers" Custom Resource definition.
There was a problem hiding this comment.
✨ PR Review
LGTM
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀
2 participants
JIRA
https://sol-jira.atlassian.net/browse/DATAGO-105494
Description
Documentation updates to show the two main options for configuring the broker for NodePort service type.
Anything for reviewers to be aware of?
N/A
✨ PR Description
Purpose: Update NodePort configuration documentation in the Event Broker Operator User Guide to clarify port assignment options and control.
Main changes:
Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀