Deployment and development guidance

[justaugustus]

The README at this point in time states the following:

Using CLOWarden in your organization

Although has been deployed for use in the CNCF GitHub org, CLOWarden is still in an experimental phase and breaking changes are expected, so we do not recommend its use in other production enviroments yet. Once it stabilizes, we'll publish some additional documentation to make it easier to run your own CLOWarden instance.

I've been watching this project for a bit and casually discussing using it with @caniszczyk, as it has been in use at CNCF for some time now (and I'm maintaining a GItHub Actions-based fork of peribolos, which is not as robust as this solution).

I'd like to request a lightweight production deployment guide and local development instructions (ref: https://github.com/cncf/clowarden/issues/98) so that my team can try CLOwarden out.

Thanks so much!

cc: @tegioz @cynthia-sg @lelia

[caniszczyk]

+1

On Fri, May 10, 2024 at 11:56 AM Stephen Augustus @.***> wrote:

The README at this point in time https://github.com/cncf/clowarden/blob/9c106a762aa7dfad0617c0b5322ffc7a9fa2a788/README.md states the following:

Using CLOWarden in your organization

Although has been deployed for use in the CNCF GitHub org, CLOWarden is still in an experimental phase and breaking changes are expected, so we do not recommend its use in other production enviroments yet. Once it stabilizes, we'll publish some additional documentation to make it easier to run your own CLOWarden instance.

I've been watching this project for a bit and casually discussing using it with @caniszczyk https://github.com/caniszczyk, as it has been in use at CNCF for some time now (and I'm maintaining a GItHub Actions-based fork of peribolos https://github.com/uwu-tools/peribolos, which is not as robust as this solution).

I'd like to request a lightweight production deployment guide and local development instructions (ref: #98 https://github.com/cncf/clowarden/issues/98) so that my team can try CLOwarden out.

Thanks so much!

cc: @tegioz https://github.com/tegioz @cynthia-sg https://github.com/cynthia-sg @lelia https://github.com/lelia

— Reply to this email directly, view it on GitHub https://github.com/cncf/clowarden/issues/194, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAPSIOOD4RTLZZ5MMERFZDZBT32VAVCNFSM6AAAAABHQ6ERMWVHI2DSMVQWIX3LMV43ASLTON2WKOZSGI4TAMBYG42DIMI . You are receiving this because you were mentioned.Message ID: @.***>

-- Cheers,

Chris Aniszczyk https://aniszczyk.org

[justaugustus]

Additionally, given that README notice, it would be helpful to have a "Known Issues" tracking issue or section of the documentation, so implementers know where the sharp edges are.

[tegioz]

Hi @justaugustus 👋

Sure, no problem. We'll take care of it this week 🙂

[justaugustus]

Thanks so much, Sergio!

[tegioz]

Please see https://artifacthub.io/packages/helm/clowarden/clowarden, it should help you get started 🙂

We've also updated the CLOWarden repo README file with some details about the CLI tool, that can be helpful when adding organizations to your deployment.

I'd recommend to also take a look at this section of the README file, as it explains how some details should be handled to avoid some common problems.

If you notice that there's something missing needed to setup your deployment or something doesn't work as expected, please let us know 😇

[tegioz]

Development environment setup document added!

Now we have:

• Some documentation that explains how to run your own CLOWarden instance in production
• A Helm chart published on Artifact to make it easier to manage your deployment
• Some documentation to setup a local development environment
• A new release workflow to publish a new chart version when a version tag is pushed to the repo

That should cover all you needed 😇 Please ping us if you run into any problem!

[justaugustus]

Hey @tegioz, while I won't have bandwidth to test this immediately, I just wanted to comment on how impressive your turnaround time with this documentation was!

Really appreciate the attention to detail here! 🙂