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

Add text to make ingress/service creation more understandable to Kubernetes newcomers #5441

Closed
Tracked by #6419 ...
catherineluse opened this issue Mar 19, 2022 · 2 comments

Comments

@catherineluse
Copy link
Contributor

catherineluse commented Mar 19, 2022

I opened this issue to track the low-hanging fruit part of #4518. That issue is about streamlining the ingress and service creation process. This is just about adding more explanatory text and doing better signposting so that a new user can better understand the UI.

Workload Create/Edit Form

In the Ports section,

  • Change "Ports" to "Networking" because that section can create a Service in addition to defining a port.
  • Add a tooltip that says "For help exposing workloads on Kubernetes, see the official Kubernetes documentation on Services. You can also manually create a Service to expose Pods by selecting their labels, and you can use an Ingress to map HTTP routes to Services."
  • Add a description that says "Define a Service to expose the container, or define a non-functional, named port so that humans will know where the app within the container is expected to run." (If a port is defined, it updates the YAML on the workload being created. If one of the Service types is selected, it creates a Service that selects the workload using automatically created labels.)
  • Change button from "Add Port" to "Add Port or Service".
  • If the "Add Port or Service" button is clicked, more explanatory text appears: "If ClusterIP, LoadBalancer or NodePort is selected, a Service is automatically created that will select the Pods in this workload using labels."

Service Create/Edit Form

  • A description says what a Service is. "Services allow you to define a logical set of Pods that can be accessed with single IP address and port."
  • On the Selector tab, explain that "Selector keys and values are intended to match labels and values on existing Pods."
  • Add a tooltip to target port: "The Service will send requests to this port, and the selected Pods are expected to listen on this port."
  • Add a tooltip to listening port: "The Service is exposed on this port."

Ingress Create/Edit Form

  • A description says what an Ingress is. "Ingresses route incoming traffic from the internet to Services within the cluster based on the hostname and path specified in the request. You can expose multiple Services on the same external IP address and port."
  • In the Rules tab, the target service dropdown has a tooltip: "If none of the Services in this dropdown select the Pods that you need to expose, you will need to create a Service that selects those Pods first."

Service Description

When you go to the service list view and click Create, the descriptions should be clearer. It should more clearly indicate that the ExternalName and Headless services are for advanced use cases.

@catherineluse
Copy link
Contributor Author

@nwmac can this be in v2.6.5?

@catherineluse catherineluse added the size/0.5 Size Estimate 0.5 label Jun 7, 2022
@catherineluse catherineluse added kind/design [zube]: Design Backlog research-needed Label for design issue that requires more technical research than what is in the issue description and removed [zube]: To Triage labels Jul 11, 2022
@gaktive gaktive removed the research-needed Label for design issue that requires more technical research than what is in the issue description label Jan 10, 2023
@gaktive gaktive added this to the v2.7.next1 milestone Jan 10, 2023
@zube zube bot removed the [zube]: Working label Jan 22, 2023
@Sahota1225 Sahota1225 added the team/area3 Helm Yes! label Feb 2, 2023
@ronhorton ronhorton removed the team/area3 Helm Yes! label Feb 27, 2023
@Sahota1225 Sahota1225 added the team/area2 Hostbusters label Mar 7, 2023
@slickwarren
Copy link
Contributor

tested on v2.7-head (a49d36c):

  • workflow creation of 'networks' is now more clear -- pass
  • services creation has helpful tooltips and wording is improved -- pass
  • ingress creation now included helpful tooltips -- pass

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

No branches or pull requests

7 participants