website icon indicating copy to clipboard operation
website copied to clipboard

[Enhancement] add documentation for new policy types

Open realshuting opened this issue 9 months ago • 4 comments

Description

ValidatingPolicy:

  • [ ] Admission Review process
  • [ ] Context Lookup
    • [ ] API server calls
    • [ ] External data API calls
    • [ ] OCI data lookups
  • [ ] Global Context
  • [ ] Auto-gen Rules
  • [ ] Auto-gen K8s Policies & Bindings
  • [ ] Reports (admission & background scans)
  • [ ] Basic Exceptions
  • [ ] CLI (apply in pipelines)
  • [ ] k8s objects
  • [ ] json payload
  • [ ] Variables
    • [ ] userInfo
    • [ ] Image Utilities (parsing, looping, etc.)

ImageValidatingPolicy:

  • [ ] Admission Review process
  • [ ] Context Lookup
    • [ ] API server calls
    • [ ] External data API calls
    • [ ] OCI data lookups
  • [ ] Global Context
  • [ ] Auto-gen Rules
  • [ ] Auto-gen K8s Policies & Bindings
  • [ ] Reports (admission & background scans)
  • [ ] Basic Exceptions
  • [ ] CLI (apply in pipelines)
  • [ ] k8s objects
  • [ ] json payload
  • [ ] Variables
    • [ ] userInfo
    • [ ] Image Utilities (parsing, looping, etc.)

realshuting avatar Mar 17 '25 13:03 realshuting

Hi @realshuting, I'd like to work on this! Could you share any references, related docs, or links that detail these policy types? Specifically, are there existing examples or specs I should follow? Thanks!

dhimanAbhi avatar Mar 18 '25 08:03 dhimanAbhi

/assign

Mohdcode avatar Mar 18 '25 15:03 Mohdcode

Hi @dhimanAbhi thanks for the interest in contributing!

However, this issue was planned as part of the LFX mentorship so @Mohdcode is going to draft the updates. We can then break this up into smaller tasks and then see how to work in parallel.

JimBugwadia avatar Mar 18 '25 17:03 JimBugwadia

Hi @JimBugwadia ,

Thanks for the update! I understand that this issue is part of the LFX mentorship, and I'll keep an eye on how it's broken down. I'd love to contribute where possible, so please let me know if there are any smaller tasks I can help with.

In the meantime, I'll look into other issues in the repository.

Thanks!

dhimanAbhi avatar Mar 19 '25 04:03 dhimanAbhi