weaveworks/policy-agent

Open-source the policy agent

serboctor opened this issue · 1 comments

We want to open-source the policy agent. This task will scope all the changes that needs to be done and any concerns or side effects of open-sourcing the agent and devise a plan accordingly. We will execute the plan within the same task, or create seperate task if needed.

Action items:

  • Remove the SaaS Sink
  • Remove the agent gateway client
  • Move dependencies from MagalixTechnologies org to the policy-agent repo
  • Update dependencies references in policy agent
  • Update dependencies refrences in iac validator
  • Update documentation to remove any reference to the SaaS sink / client
  • Change docker image repository to be public repository
  • Update repository license
  • Add a development guide to show the user how to run the agent locally against a kind cluster
  • Add a getting started guide to show the user how to install the helm chart on his k8s cluster and configure the agent. (available here)
  • Add a contribution guide to agent and validator
  • Add a code of conduct guide to agent and validator
  • Update the README to reference the new guides
  • Decide on 5 policies to be shipped with the agent and add them to the helm chart
  • Change the name of the IaC validator (weave-policy-validator)
  • Create a community slack channel
  • Add templates for creating bugs and feature requests to agent and validator. Use OSS templates for reference. Document them if needed in the contribution guide.

@MostafaMegahid @ahsayde @waleedhammam updated the action items in the description. Will create a task for the website documentation.