Create ADR for exposing TLS endpoints and required SecretClass/AuthenticationClass via discovery ConfigMaps

Aperta
#251 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
kafka
Ambito
documentation, security

Direzione di ricerca

Non vengono indicati file o test. Inizia esaminando i ConfigMaps di discovery esistenti e i tre campi ZooKeeper elencati nell'issue, quindi definisci le convenzioni indipendenti dal prodotto che l'ADR deve coprire. Il lavoro è completato quando è disponibile un ADR discusso e documentato in YAML o JSON valido che descriva gli endpoint sicuri e i campi obbligatori di SecretClass o AuthenticationClass.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

We enable more and more operators to use TLS for their products. We have dependencies between operators via discovery (e.g. Kafka -> ZooKeeper) where we currently expose a connection string (adapted to the secure port etc.), but we do not expose what secret class or authentication class must be used if authentication is required. After, a quick discussion with Sönke we agreed that we need to expose the secret or authentication class (e.g. the one used for client TLS in ZooKeeper) in the discovery ConfigMap.

For ZooKeeper we currently expose 3 fields:

  • ZOOKEEPER contains the full zookeeper connection string with znode (generally used)
  • ZOOKEEPER_CHROOT contains the znode (i think only for Nifi currently)
  • ZOOKEEPER_HOSTS contains the zookeeper connection string without znode (i think only for Nifi currently)

I think we should (if set) in similar fashion secure fields like:

  • ZOOKEEPER_SECURE
  • ZOOKEEPER_HOSTS_SECURE
  • (ZOOKEEPER_CHROOT_SECURE) would be redundant
  • AUTHENTICATION_CLASS

to be able to connect products to e.g. ZooKeeper.

This should be properly discussed and documented in an new ADR, provided in machine readable format (yaml, json) and valid for different products.

Lingua principale
CSS
Stelle
13
Fork
14
Merge medio
4g 8h
PR unite (30g)
10

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di stackabletech/documentation

Tutte le issue di stackabletech/documentation

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.