nimbus
nimbus copied to clipboard
[Docs]: Docs for CRs schema and supported intent IDs
trafficstars
Description
This issue aims to document the schemas and supported intent IDs for custom resources (CRs) used to manage security policies in Nimbus.
We need documentation for:
Cluster scoped CRs:
- [ ] SecurityIntent CR schema
- [ ] ClusterSecurityIntentBinding CR schema
- [ ] ClusterNimbusPolicy CR schema
Namespace scoped CRs:
- [ ] SecurityIntentBinding CR schema
- [ ] NimbusPolicy CR schema
Supported Intent IDs:
- [ ] Create a table or list of supported IDs with their descriptions and use cases. Reference: https://github.com/5GSEC/nimbus/blob/main/pkg/adapter/idpool/idpool.go
Nimubs
- [ ] Update Nimbus architecture diagram in the readme file to reflect the current architecture.
- [ ] Add contribution and development guide.