You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by gy...@apache.org on 2022/09/19 11:39:05 UTC
[flink-kubernetes-operator] branch main updated: [FLINK-29256] Add docs for k8s operator webhook
This is an automated email from the ASF dual-hosted git repository.
gyfora pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/flink-kubernetes-operator.git
The following commit(s) were added to refs/heads/main by this push:
new 1b2b0f3d [FLINK-29256] Add docs for k8s operator webhook
1b2b0f3d is described below
commit 1b2b0f3d5dd519fd6c9ea191e4b353679bc7312e
Author: Gabor Somogyi <ga...@apple.com>
AuthorDate: Fri Sep 16 16:39:07 2022 +0200
[FLINK-29256] Add docs for k8s operator webhook
---
docs/content/docs/concepts/architecture.md | 15 +++++++++++++++
docs/static/img/concepts/webhook.svg | 21 +++++++++++++++++++++
2 files changed, 36 insertions(+)
diff --git a/docs/content/docs/concepts/architecture.md b/docs/content/docs/concepts/architecture.md
index 962657dc..86fab3ce 100644
--- a/docs/content/docs/concepts/architecture.md
+++ b/docs/content/docs/concepts/architecture.md
@@ -63,3 +63,18 @@ The Operator manages the lifecycle of Flink resources. The following chart illus
- ROLLING_BACK : The resource is being rolled back to the last stable spec
- ROLLED_BACK : The resource is deployed with the last stable spec
- FAILED : The job terminally failed
+
+## Admission Control
+
+In addition to compiled-in admission plugins, a custom admission plugin named Flink Kubernetes Operator Webhook (Webhook)
+can be started as extension and run as webhook.
+
+The Webhook follow the Kubernetes principles, notably the [dynamic admission control](https://kubernetes.io/docs/reference/access-authn-authz/extensible-admission-controllers/).
+
+It's deployed by default when the Operator is installed on a Kubernetes cluster using [Helm](https://helm.sh).
+Please see further details how to deploy the Operator/Webhook [here](https://nightlies.apache.org/flink/flink-kubernetes-operator-docs-main/docs/try-flink-kubernetes-operator/quick-start/#deploying-the-operator).
+
+The Webhook is using TLS protocol for communication by default. It automatically loads/re-loads keytore file when the file
+has changed and provides the following endpoints:
+
+{{< img src="/img/concepts/webhook.svg" alt="Webhook" >}}
diff --git a/docs/static/img/concepts/webhook.svg b/docs/static/img/concepts/webhook.svg
new file mode 100644
index 00000000..19f4fbdd
--- /dev/null
+++ b/docs/static/img/concepts/webhook.svg
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+-->
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="277px" height="189px" viewBox="-0.5 -0.5 277 189" content="<mxfile host="app.diagrams.net" modified="2022-09-16T14:32:31.729Z" agent="5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/105.0.0.0 Safari/537.36" etag="RhBkSYReFqMcM9D-_W7k" version="20.3.1" type="google"><diagram id=&qu [...]
\ No newline at end of file