Add karapace_client interface

[zmraul]

Adds Karapace client interface specification.

TODO:

• Update custom role creation

[sinclert-canonical]

👋🏻 Hey! Same as the comment I left in the PR adding the Karapace classes to Data Interfaces v0, as well as its follow-up PR by Marc, these docs lack the addition of the custom role creation / permissions change functionality. Please, take a look at the PR expanding the other Data Platform product interfaces usage and follow the same approach.

[james-garner-canonical]

Hi @zmraul @sinclert-canonical, we're moving towards archiving this repo very soon, however interface specifications live on in the charmlibs repo.

I'm happy to merge this PR and migrate the interface definition to charmlibs. I'm assuming the interface reflects the behaviour of the actual providers and requirers in the wild. However, @sinclert-canonical had a request for documenting custom role creation / permissions change functionality, which would be great to get done first if it's still relevant.

[zmraul]

@james-garner-canonical @sinclert-canonical Updated the schemas with role & permissions changes.

[james-garner-canonical]

Thanks @zmraul, the changes look good to me. @sinclert-canonical?

I also just noticed that there isn't an interface.yaml for this interface. Could you please add one with at least:

name: karapace_client
version: 0
status: <published if charms are already using this, otherwise draft?>
maintainer: <github team name>
providers:  # any current providers, or [] otherwise
    - name: <charm name>
      url: <git repo>
requirers:  # any current requirers, or [] otherwise
    - name: <charm name>
      url: <git repo>

[zmraul]

@james-garner-canonical there is one, see here

[james-garner-canonical]

Happy to merge this with sign off from someone else on the team -- @sinclert-canonical?

PS: Is this now just documenting an interface that is already in use in production?

[sinclert-canonical]

Thanks @zmraul, the changes look good to me. @sinclert-canonical?

Good to me too. Thanks @zmraul!

[zmraul]

PS: Is this now just documenting an interface that is already in use in production?

@james-garner-canonical this interface is in the Karapace charm, but it is not on stable track yet.

[james-garner-canonical]

I've signed the commits for merge.