Charm ports are configuration options, but maybe they should not

[DnPlas]

Context

Many CKF charms have the port configuration option, which is problematic because of the following:

1. The configuration option is not consistent, in some it refers to the http_port, in some others it refers to the metrics_port, and the description in the configuration file is not clearly defining this. For example in dex-auth:

  port:
    type: int
    default: 5556
    description: Listening port

2. In many cases, the configuration option won't have any effect on the workload itself, only on certain things the charm could be doing with it, like when the KubernetesServicePatch is used. For example, in dex-auth, if changed, the configuration option will just affect the behaviour of the KubernetesServicePatch, but not the workload service as it is not changing anything in the command of the pebble layer.

In some other cases, like pipelines, the port is hardcoded, making it impossible to change.

3. It may add complexity to the port configuration as there could be many options, for example a HTTP and a HTTP port.

4. The use of this configuration option is inconsistent, some charms will have it while some others won't.

Proposal

To eliminate the option to configure ports in all CKF charms and refactor the charm code to avoid using them, unless there is a compelling reason to keep them.

Related issues:

• kfp-viz has an option to configure the http-port, but it is hard-coded in the source code kfp-operators#507
• port configuration option is not configuring Dex's command dex-auth-operator#210

What needs to get done

1. Remove the port config option from all CKF charms
2. Remove all logic/code that requires self.config['port'] or similar
3. Update tests cases that configured this option
4. Update any documentation that mentioned this configuration option

Definition of Done

The port is not configurable anymore for any of the CKF charms.

[syncronize-issues-to-jira]

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-6079.

This message was autogenerated