Skip to content

Commit

Permalink
Add section "Webhook" in "Troubleshooting" (#1309)
Browse files Browse the repository at this point in the history
* Add section "Webhook" in "Troubleshooting"

Fixes #1292

* Add backticks to port

* Apply suggestions from code review

Co-authored-by: Pavan Navarathna <pavan@kasten.io>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
  • Loading branch information
3 people committed Mar 24, 2022
1 parent e3e762e commit e49103b
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,4 @@ subcommand
templating
Walkthrough
Workflow
webhook
20 changes: 20 additions & 0 deletions docs/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,23 @@ or file an issue on `GitHub
<https://github.com/kanisterio/kanister/issues>`_. A `mailing list
<https://groups.google.com/forum/#!forum/kanisterio>`_ is also
available if needed.


Validating webhook for Blueprints
=================================
For the validating webhook to work, the Kubernetes API Server needs to
connect to port ``9443`` of the Kanister operator. If your cluster has
a firewall setup, it has to be configured to allow that communication.

GKE
---
If you get an error while applying a blueprint, that the webhook can't be reached,
check if your firewall misses a rule for port ``9443``:

.. code-block:: console
$ kubectl apply -f blueprint.yaml
Error from server (InternalError): error when creating "blueprint.yaml": Internal error occurred: failed calling webhook "blueprints.cr.kanister.io": failed to call webhook: Post "https://kanister-kanister-operator.kanister.svc:443/validate/v1alpha1/blueprint?timeout=5s": context deadline exceeded
See `GKE: Adding firewall rules for specific use cases <https://cloud.google.com/kubernetes-engine/docs/how-to/private-clusters#add_firewall_rules>`_ and `kubernetes/kubernetes: Using non-443 ports for admission webhooks requires firewall rule in GKE <https://github.com/kubernetes/kubernetes/issues/79739>`_ for more details.

0 comments on commit e49103b

Please sign in to comment.