stackabletech / stackabletech/documentation
Create ADR for exposing TLS endpoints and required SecretClass/AuthenticationClass via discovery ConfigMaps
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- CSS
- Star
- 13
- Fork
- 14
- Merge trung bình
- 4 ngày 8 giờ
- Pull request đã merge (30 ngày)
- 10
Mô tả
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.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Không có tệp hoặc kiểm thử nào được nêu tên. Hãy bắt đầu bằng việc xem xét các ConfigMaps discovery hiện có và ba trường ZooKeeper được liệt kê trong issue, sau đó xác định các quy ước độc lập với sản phẩm mà ADR phải bao quát. Công việc được coi là hoàn tất khi có một ADR đã được thảo luận và ghi chép bằng YAML hoặc JSON hợp lệ, mô tả các endpoint bảo mật và các trường bắt buộc của SecretClass hoặc AuthenticationClass.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- kafka
- Lĩnh vực
- documentation, security
- Loại issue
- Tài liệu
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 30/100