Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for pre-deploy validation webhooks. #6780

Open
rophy opened this issue Sep 9, 2023 · 2 comments
Open

Support for pre-deploy validation webhooks. #6780

rophy opened this issue Sep 9, 2023 · 2 comments
Labels
kind/proposal An issue that reports a new feature proposal to be discussed stale Automatic label to stale issues due inactivity to be closed if no further action

Comments

@rophy
Copy link
Contributor

rophy commented Sep 9, 2023

Summary

kubeapps should support an optional pre-deploy validation webhook, that DevOps (admin of kubeapps, charts, or kubernetes cluster) can be used to integration various workflows that suits their team. The validation webhook is triggered after user selects chart and provided values, but before actually deploys. The webhook should return with "ok" or "not ok", providing contexts on the reason as necessary, to be displayed on kubeapps UI.

Background and rationale

Some scenarios where this can be useful:

  1. Verifying target namespaces has sufficient resourcequota
  2. Obtaining approvals before actually deploying
  3. Ensuring user has sufficient privilege before actually deploying

Description

  1. A pre-deploy validation webhooks can be provided to kubeapps configurations. If provided...

  2. After user selects a package, before actually deploys, user will need to click a "validate" button, which triggers the pre-deploy webhook.

  3. Relevant information will be passed to the webhook, e.g. user, cluster, namespace, chart, user-provided values

  4. The webhook is expected to return some status such as "ok" or "error", along with additional information in the payload.

  5. The additional information is displayed in the kubeapps UI, so user knows what to do when "not ok"

  6. User can only click "Deploy" after webhook returns "ok"

@rophy rophy added the kind/proposal An issue that reports a new feature proposal to be discussed label Sep 9, 2023
@absoludity
Copy link
Contributor

Thanks @rophy . Yeah, your second case - obtaining approval before actually deploying - has been requested as a specific feature in the past, but it wasn't something we could justify including by default, so I really like the idea of providing a more general validation webhook framework so people can add such behaviour to suit their use-case.

@antgamdia antgamdia added this to the Community requests milestone Jan 8, 2024
Copy link

stale bot commented Mar 17, 2024

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale Automatic label to stale issues due inactivity to be closed if no further action label Mar 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/proposal An issue that reports a new feature proposal to be discussed stale Automatic label to stale issues due inactivity to be closed if no further action
Projects
Status: 🗂 Backlog
Development

No branches or pull requests

3 participants