janus-idp / operator

Deprecated - Operator for Backstage, based on the Operator SDK framework - see https://github.com/redhat-developer/rhdh-operator
https://github.com/redhat-developer/rhdh-operator
Apache License 2.0
15 stars 15 forks source link

[Proposal] More user-friendly Sidecar containers support #276

Closed gazarenkov closed 5 months ago

gazarenkov commented 7 months ago

Simplify supporting adding sidecar containers to Backstage deployment.

Example: adding OAuth2 Proxy for Keyclock support as described in https://janus-idp.io/blog/2023/01/17/enabling-keycloak-authentication-in-backstage .

Context: it is possible to define any deployment configuration redefining deployment.xml in:

Proposals:

There are 2 reasonable way to simplify it, we can consider both (one does not exclude other):

  1. Just to address this problem: add necessary sidecar(s) to default deployment.yaml but consider it disabled by default (operator will exclude all but mandatory backstage and init container runtime) and make an option in CR to enable sidecars, e g: Backstage.spec.enableSidecars=true|[false]
  2. Generic solution, which could address other problems requiring "slight changes" of configuration (like this https://github.com/janus-idp/operator/issues/254 ): supporting patches for default/raw configuration. This way user/admin will be able to add any missing pieces for particular cluster/instance with proposing merging patch. Technical Proposal will come in other issue.
gazarenkov commented 5 months ago

Closing in favour of generic solution https://github.com/janus-idp/operator/issues/352 covering this case