stackabletech / stackabletech/documentation
Create ADR for exposing TLS endpoints and required SecretClass/AuthenticationClass via discovery ConfigMaps
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- CSS
- Sterne
- 13
- Forks
- 14
- Ø Merge
- 4 T. 8 Std.
- Gemergte PRs (30 T.)
- 10
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Es werden keine Dateien oder Tests genannt. Beginne damit, die vorhandenen Discovery-ConfigMaps und die drei im Issue aufgeführten ZooKeeper-Felder zu überprüfen, und definiere anschließend die produktunabhängigen Konventionen, die das ADR abdecken muss. Die Aufgabe ist erledigt, wenn ein besprochenes, dokumentiertes ADR in gültigem YAML oder JSON vorliegt, das sichere Endpunkte sowie die erforderlichen Felder von SecretClass oder AuthenticationClass beschreibt.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- kafka
- Bereich
- documentation, security
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 30/100