Custom Ingress Path for Helm Chart

[JordanZimmitti]

Description

Now that Selenium supports custom sub-paths for the UI, in order to take advantage of it in Kubernetes the helm chart needs the ingress path to be overwritable. I added a path key under the ingress section of the values.yaml file and made it backward compatible in the template so if no path key exists then it will use the default "/" path just like before.

Motivation and Context

Deploy selenium with a custom domain sub-path using the helm chart

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• I have read the contributing document.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my changes.
• All new and existing tests passed.

[CLAassistant]

All committers have signed the CLA.

[diemol]

I do not see how the sub path is getting configured in the Grid itself. Am I missing something?

[JordanZimmitti]

@diemol

I do not see how the sub path is getting configured in the Grid itself. Am I missing something?

I was able to configure that part using the existing helm chart already by adding these lines here:

hub:
    extraEnvironmentVariables:
        - name: SE_OPTS
           value: '--sub-path /<custom-sub-path>/'
  

which worked fine, but then could not update the ingress path itself since it was hard coded

[diemol]

@JordanZimmitti would if be better if we add a new environment variable just to set the sub-path? If so, I can have a look at it unless you want to do it.

[JordanZimmitti]

@diemol it did take me a little while to figure out how to set the subpath for the hub so having an env called SUB_PATH or something similar might be easier for people to interpret. I'll take a stab at it I think I might know where that needs to be updated

[JordanZimmitti]

@diemol I updated the selenium hub start script to take a new environment variable called SE_HUB_SUB_PATH which will set the sub-path. Tested this locally with and without using the env variable and it worked as expected. I followed the naming convention that I saw being used in the script, if you would like something different let me know and I'll update it

[diemol]

Looks good, we just need to add it to a couple of places more. I'd be nice if you have time to put a couple of lines describing it on the main README. Thanks!

[JordanZimmitti]

@diemol Thanks for the suggestions! I updated the environment variable name to $SE_SUB_PATH as suggested and added it to the Standalone and Router scripts. I also added some documentation for using the environment variable in the readme.md in a spot that I think makes sense but if you want me to put it somewhere else let me know

[diemol]

Looks great!

Not sure if I am missing something, but shouldn't the SE_SUB_PATH variable be used somewhere in the chart?

[JordanZimmitti]

@diemol

Looks great!

Not sure if I am missing something, but shouldn't the SE_SUB_PATH variable be used somewhere in the chart?

Since the docker file takes SE_SUB_PATH in as an environment variable it would work fine with the helm chart as is like this

hub:
    extraEnvironmentVariables:
        - name: SE_SUB_PATH
           value: "/<custom-sub-path>/"

But I could break it out of extraEnvironmentVariables and make it its own key under the hub section if you want.
If we go down that path then I probably need to make a sub_path key under the router section too since we added it to the start script there as well correct?

[diemol]

@JordanZimmitti sorry for the late reply, we had a long weekend here.

But I could break it out of extraEnvironmentVariables and make it its own key under the hub section if you want.
If we go down that path then I probably need to make a sub_path key under the router section too since we added it to the start script there as well correct?

I think ☝️ is the preferred solution so all places where the env var can be used get the option to be configured. Thanks!

[JordanZimmitti]

@diemol Sounds good ill implement the changes in the next day or so!

[JordanZimmitti]

@diemol
I broke out the environment variable in the helm charts in the needed locations, let me know if you have any other suggestions!

[diemol]

Thank you!

I just noted that the sub-path environment variable is being used in a few places we do not need it.

[JordanZimmitti]

@diemol I removed the sub_path from components that don't need it based on your recommendation!

[diemol]

Thank you, @JordanZimmitti!