stackabletech / stackabletech/documentation

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

Abierto
#251 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
CSS
Estrellas
13
Forks
14
Merge medio
4 d 8 h
PR fusionados (30 d)
10

Descripción

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.

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

No se nombran archivos ni pruebas. Empieza revisando los ConfigMaps de discovery existentes y los tres campos de ZooKeeper enumerados en el issue; después, define las convenciones independientes del producto que debe cubrir el ADR. La tarea estará terminada cuando exista un ADR discutido y documentado en YAML o JSON válido que describa endpoints seguros y los campos obligatorios de SecretClass o AuthenticationClass.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
kafka
Área
documentation, security
Tipo de issue
Documentación
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
30/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.